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;
71 # 1 is mostly method/subroutine entry and options
72 # 2 traces progress of some operations
73 # 3 is even more information including possibly sensitive data
75 $me = '[FS::cust_main]';
78 $ignore_expired_card = 0;
79 $ignore_illegal_zip = 0;
80 $ignore_banned_card = 0;
83 @fuzzyfields = ( 'first', 'last', 'company', 'address1' );
85 @encrypted_fields = ('payinfo', 'paycvv');
86 sub nohistory_fields { ('payinfo', 'paycvv'); }
88 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
90 #ask FS::UID to run this stuff for us later
91 #$FS::UID::callback{'FS::cust_main'} = sub {
92 install_callback FS::UID sub {
94 #yes, need it for stuff below (prolly should be cached)
99 my ( $hashref, $cache ) = @_;
100 if ( exists $hashref->{'pkgnum'} ) {
101 #@{ $self->{'_pkgnum'} } = ();
102 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
103 $self->{'_pkgnum'} = $subcache;
104 #push @{ $self->{'_pkgnum'} },
105 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
111 FS::cust_main - Object methods for cust_main records
117 $record = new FS::cust_main \%hash;
118 $record = new FS::cust_main { 'column' => 'value' };
120 $error = $record->insert;
122 $error = $new_record->replace($old_record);
124 $error = $record->delete;
126 $error = $record->check;
128 @cust_pkg = $record->all_pkgs;
130 @cust_pkg = $record->ncancelled_pkgs;
132 @cust_pkg = $record->suspended_pkgs;
134 $error = $record->bill;
135 $error = $record->bill %options;
136 $error = $record->bill 'time' => $time;
138 $error = $record->collect;
139 $error = $record->collect %options;
140 $error = $record->collect 'invoice_time' => $time,
145 An FS::cust_main object represents a customer. FS::cust_main inherits from
146 FS::Record. The following fields are currently supported:
152 Primary key (assigned automatically for new customers)
156 Agent (see L<FS::agent>)
160 Advertising source (see L<FS::part_referral>)
172 Cocial security number (optional)
188 (optional, see L<FS::cust_main_county>)
192 (see L<FS::cust_main_county>)
198 (see L<FS::cust_main_county>)
234 (optional, see L<FS::cust_main_county>)
238 (see L<FS::cust_main_county>)
244 (see L<FS::cust_main_county>)
260 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
264 Payment Information (See L<FS::payinfo_Mixin> for data format)
268 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
272 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
276 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
280 Start date month (maestro/solo cards only)
284 Start date year (maestro/solo cards only)
288 Issue number (maestro/solo cards only)
292 Name on card or billing name
296 IP address from which payment information was received
300 Tax exempt, empty or `Y'
304 Order taker (see L<FS::access_user>)
310 =item referral_custnum
312 Referring customer number
316 Enable individual CDR spooling, empty or `Y'
320 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
324 Discourage individual CDR printing, empty or `Y'
334 Creates a new customer. To add the customer to the database, see L<"insert">.
336 Note that this stores the hash reference, not a distinct copy of the hash it
337 points to. You can ask the object for a copy with the I<hash> method.
341 sub table { 'cust_main'; }
343 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
345 Adds this customer to the database. If there is an error, returns the error,
346 otherwise returns false.
348 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
349 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
350 are inserted atomicly, or the transaction is rolled back. Passing an empty
351 hash reference is equivalent to not supplying this parameter. There should be
352 a better explanation of this, but until then, here's an example:
355 tie %hash, 'Tie::RefHash'; #this part is important
357 $cust_pkg => [ $svc_acct ],
360 $cust_main->insert( \%hash );
362 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
363 be set as the invoicing list (see L<"invoicing_list">). Errors return as
364 expected and rollback the entire transaction; it is not necessary to call
365 check_invoicing_list first. The invoicing_list is set after the records in the
366 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
367 invoicing_list destination to the newly-created svc_acct. Here's an example:
369 $cust_main->insert( {}, [ $email, 'POST' ] );
371 Currently available options are: I<depend_jobnum>, I<noexport> and I<tax_exemption>.
373 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
374 on the supplied jobnum (they will not run until the specific job completes).
375 This can be used to defer provisioning until some action completes (such
376 as running the customer's credit card successfully).
378 The I<noexport> option is deprecated. If I<noexport> is set true, no
379 provisioning jobs (exports) are scheduled. (You can schedule them later with
380 the B<reexport> method.)
382 The I<tax_exemption> option can be set to an arrayref of tax names.
383 FS::cust_main_exemption records will be created and inserted.
389 my $cust_pkgs = @_ ? shift : {};
390 my $invoicing_list = @_ ? shift : '';
392 warn "$me insert called with options ".
393 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
396 local $SIG{HUP} = 'IGNORE';
397 local $SIG{INT} = 'IGNORE';
398 local $SIG{QUIT} = 'IGNORE';
399 local $SIG{TERM} = 'IGNORE';
400 local $SIG{TSTP} = 'IGNORE';
401 local $SIG{PIPE} = 'IGNORE';
403 my $oldAutoCommit = $FS::UID::AutoCommit;
404 local $FS::UID::AutoCommit = 0;
407 my $prepay_identifier = '';
408 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
410 if ( $self->payby eq 'PREPAY' ) {
412 $self->payby('BILL');
413 $prepay_identifier = $self->payinfo;
416 warn " looking up prepaid card $prepay_identifier\n"
419 my $error = $self->get_prepay( $prepay_identifier,
420 'amount_ref' => \$amount,
421 'seconds_ref' => \$seconds,
422 'upbytes_ref' => \$upbytes,
423 'downbytes_ref' => \$downbytes,
424 'totalbytes_ref' => \$totalbytes,
427 $dbh->rollback if $oldAutoCommit;
428 #return "error applying prepaid card (transaction rolled back): $error";
432 $payby = 'PREP' if $amount;
434 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
437 $self->payby('BILL');
438 $amount = $self->paid;
442 warn " inserting $self\n"
445 $self->signupdate(time) unless $self->signupdate;
447 $self->auto_agent_custid()
448 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
450 my $error = $self->SUPER::insert;
452 $dbh->rollback if $oldAutoCommit;
453 #return "inserting cust_main record (transaction rolled back): $error";
457 warn " setting invoicing list\n"
460 if ( $invoicing_list ) {
461 $error = $self->check_invoicing_list( $invoicing_list );
463 $dbh->rollback if $oldAutoCommit;
464 #return "checking invoicing_list (transaction rolled back): $error";
467 $self->invoicing_list( $invoicing_list );
470 warn " setting customer tags\n"
473 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
474 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
475 'custnum' => $self->custnum };
476 my $error = $cust_tag->insert;
478 $dbh->rollback if $oldAutoCommit;
483 if ( $invoicing_list ) {
484 $error = $self->check_invoicing_list( $invoicing_list );
486 $dbh->rollback if $oldAutoCommit;
487 #return "checking invoicing_list (transaction rolled back): $error";
490 $self->invoicing_list( $invoicing_list );
494 warn " setting cust_main_exemption\n"
497 my $tax_exemption = delete $options{'tax_exemption'};
498 if ( $tax_exemption ) {
499 foreach my $taxname ( @$tax_exemption ) {
500 my $cust_main_exemption = new FS::cust_main_exemption {
501 'custnum' => $self->custnum,
502 'taxname' => $taxname,
504 my $error = $cust_main_exemption->insert;
506 $dbh->rollback if $oldAutoCommit;
507 return "inserting cust_main_exemption (transaction rolled back): $error";
512 if ( $self->can('start_copy_skel') ) {
513 my $error = $self->start_copy_skel;
515 $dbh->rollback if $oldAutoCommit;
520 warn " ordering packages\n"
523 $error = $self->order_pkgs( $cust_pkgs,
525 'seconds_ref' => \$seconds,
526 'upbytes_ref' => \$upbytes,
527 'downbytes_ref' => \$downbytes,
528 'totalbytes_ref' => \$totalbytes,
531 $dbh->rollback if $oldAutoCommit;
536 $dbh->rollback if $oldAutoCommit;
537 return "No svc_acct record to apply pre-paid time";
539 if ( $upbytes || $downbytes || $totalbytes ) {
540 $dbh->rollback if $oldAutoCommit;
541 return "No svc_acct record to apply pre-paid data";
545 warn " inserting initial $payby payment of $amount\n"
547 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
549 $dbh->rollback if $oldAutoCommit;
550 return "inserting payment (transaction rolled back): $error";
554 unless ( $import || $skip_fuzzyfiles ) {
555 warn " queueing fuzzyfiles update\n"
557 $error = $self->queue_fuzzyfiles_update;
559 $dbh->rollback if $oldAutoCommit;
560 return "updating fuzzy search cache: $error";
565 warn " exporting\n" if $DEBUG > 1;
567 my $export_args = $options{'export_args'} || [];
570 map qsearch( 'part_export', {exportnum=>$_} ),
571 $conf->config('cust_main-exports'); #, $agentnum
573 foreach my $part_export ( @part_export ) {
574 my $error = $part_export->export_insert($self, @$export_args);
576 $dbh->rollback if $oldAutoCommit;
577 return "exporting to ". $part_export->exporttype.
578 " (transaction rolled back): $error";
582 #foreach my $depend_jobnum ( @$depend_jobnums ) {
583 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
585 # foreach my $jobnum ( @jobnums ) {
586 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
587 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
589 # my $error = $queue->depend_insert($depend_jobnum);
591 # $dbh->rollback if $oldAutoCommit;
592 # return "error queuing job dependancy: $error";
599 #if ( exists $options{'jobnums'} ) {
600 # push @{ $options{'jobnums'} }, @jobnums;
603 warn " insert complete; committing transaction\n"
606 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
611 use File::CounterFile;
612 sub auto_agent_custid {
615 my $format = $conf->config('cust_main-auto_agent_custid');
617 if ( $format eq '1YMMXXXXXXXX' ) {
619 my $counter = new File::CounterFile 'cust_main.agent_custid';
622 my $ym = 100000000000 + time2str('%y%m00000000', time);
623 if ( $ym > $counter->value ) {
624 $counter->{'value'} = $agent_custid = $ym;
625 $counter->{'updated'} = 1;
627 $agent_custid = $counter->inc;
633 die "Unknown cust_main-auto_agent_custid format: $format";
636 $self->agent_custid($agent_custid);
640 =item PACKAGE METHODS
642 Documentation on customer package methods has been moved to
643 L<FS::cust_main::Packages>.
645 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
647 Recharges this (existing) customer with the specified prepaid card (see
648 L<FS::prepay_credit>), specified either by I<identifier> or as an
649 FS::prepay_credit object. If there is an error, returns the error, otherwise
652 Optionally, five scalar references can be passed as well. They will have their
653 values filled in with the amount, number of seconds, and number of upload,
654 download, and total bytes applied by this prepaid card.
658 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
659 #the only place that uses these args
660 sub recharge_prepay {
661 my( $self, $prepay_credit, $amountref, $secondsref,
662 $upbytesref, $downbytesref, $totalbytesref ) = @_;
664 local $SIG{HUP} = 'IGNORE';
665 local $SIG{INT} = 'IGNORE';
666 local $SIG{QUIT} = 'IGNORE';
667 local $SIG{TERM} = 'IGNORE';
668 local $SIG{TSTP} = 'IGNORE';
669 local $SIG{PIPE} = 'IGNORE';
671 my $oldAutoCommit = $FS::UID::AutoCommit;
672 local $FS::UID::AutoCommit = 0;
675 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
677 my $error = $self->get_prepay( $prepay_credit,
678 'amount_ref' => \$amount,
679 'seconds_ref' => \$seconds,
680 'upbytes_ref' => \$upbytes,
681 'downbytes_ref' => \$downbytes,
682 'totalbytes_ref' => \$totalbytes,
684 || $self->increment_seconds($seconds)
685 || $self->increment_upbytes($upbytes)
686 || $self->increment_downbytes($downbytes)
687 || $self->increment_totalbytes($totalbytes)
688 || $self->insert_cust_pay_prepay( $amount,
690 ? $prepay_credit->identifier
695 $dbh->rollback if $oldAutoCommit;
699 if ( defined($amountref) ) { $$amountref = $amount; }
700 if ( defined($secondsref) ) { $$secondsref = $seconds; }
701 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
702 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
703 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
705 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
710 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
712 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
713 specified either by I<identifier> or as an FS::prepay_credit object.
715 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
716 incremented by the values of the prepaid card.
718 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
719 check or set this customer's I<agentnum>.
721 If there is an error, returns the error, otherwise returns false.
727 my( $self, $prepay_credit, %opt ) = @_;
729 local $SIG{HUP} = 'IGNORE';
730 local $SIG{INT} = 'IGNORE';
731 local $SIG{QUIT} = 'IGNORE';
732 local $SIG{TERM} = 'IGNORE';
733 local $SIG{TSTP} = 'IGNORE';
734 local $SIG{PIPE} = 'IGNORE';
736 my $oldAutoCommit = $FS::UID::AutoCommit;
737 local $FS::UID::AutoCommit = 0;
740 unless ( ref($prepay_credit) ) {
742 my $identifier = $prepay_credit;
744 $prepay_credit = qsearchs(
746 { 'identifier' => $prepay_credit },
751 unless ( $prepay_credit ) {
752 $dbh->rollback if $oldAutoCommit;
753 return "Invalid prepaid card: ". $identifier;
758 if ( $prepay_credit->agentnum ) {
759 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
760 $dbh->rollback if $oldAutoCommit;
761 return "prepaid card not valid for agent ". $self->agentnum;
763 $self->agentnum($prepay_credit->agentnum);
766 my $error = $prepay_credit->delete;
768 $dbh->rollback if $oldAutoCommit;
769 return "removing prepay_credit (transaction rolled back): $error";
772 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
773 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
775 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
780 =item increment_upbytes SECONDS
782 Updates this customer's single or primary account (see L<FS::svc_acct>) by
783 the specified number of upbytes. If there is an error, returns the error,
784 otherwise returns false.
788 sub increment_upbytes {
789 _increment_column( shift, 'upbytes', @_);
792 =item increment_downbytes SECONDS
794 Updates this customer's single or primary account (see L<FS::svc_acct>) by
795 the specified number of downbytes. If there is an error, returns the error,
796 otherwise returns false.
800 sub increment_downbytes {
801 _increment_column( shift, 'downbytes', @_);
804 =item increment_totalbytes SECONDS
806 Updates this customer's single or primary account (see L<FS::svc_acct>) by
807 the specified number of totalbytes. If there is an error, returns the error,
808 otherwise returns false.
812 sub increment_totalbytes {
813 _increment_column( shift, 'totalbytes', @_);
816 =item increment_seconds SECONDS
818 Updates this customer's single or primary account (see L<FS::svc_acct>) by
819 the specified number of seconds. If there is an error, returns the error,
820 otherwise returns false.
824 sub increment_seconds {
825 _increment_column( shift, 'seconds', @_);
828 =item _increment_column AMOUNT
830 Updates this customer's single or primary account (see L<FS::svc_acct>) by
831 the specified number of seconds or bytes. If there is an error, returns
832 the error, otherwise returns false.
836 sub _increment_column {
837 my( $self, $column, $amount ) = @_;
838 warn "$me increment_column called: $column, $amount\n"
841 return '' unless $amount;
843 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
844 $self->ncancelled_pkgs;
847 return 'No packages with primary or single services found'.
848 ' to apply pre-paid time';
849 } elsif ( scalar(@cust_pkg) > 1 ) {
850 #maybe have a way to specify the package/account?
851 return 'Multiple packages found to apply pre-paid time';
854 my $cust_pkg = $cust_pkg[0];
855 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
859 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
862 return 'No account found to apply pre-paid time';
863 } elsif ( scalar(@cust_svc) > 1 ) {
864 return 'Multiple accounts found to apply pre-paid time';
867 my $svc_acct = $cust_svc[0]->svc_x;
868 warn " found service svcnum ". $svc_acct->pkgnum.
869 ' ('. $svc_acct->email. ")\n"
872 $column = "increment_$column";
873 $svc_acct->$column($amount);
877 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
879 Inserts a prepayment in the specified amount for this customer. An optional
880 second argument can specify the prepayment identifier for tracking purposes.
881 If there is an error, returns the error, otherwise returns false.
885 sub insert_cust_pay_prepay {
886 shift->insert_cust_pay('PREP', @_);
889 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
891 Inserts a cash payment in the specified amount for this customer. An optional
892 second argument can specify the payment identifier for tracking purposes.
893 If there is an error, returns the error, otherwise returns false.
897 sub insert_cust_pay_cash {
898 shift->insert_cust_pay('CASH', @_);
901 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
903 Inserts a Western Union payment in the specified amount for this customer. An
904 optional second argument can specify the prepayment identifier for tracking
905 purposes. If there is an error, returns the error, otherwise returns false.
909 sub insert_cust_pay_west {
910 shift->insert_cust_pay('WEST', @_);
913 sub insert_cust_pay {
914 my( $self, $payby, $amount ) = splice(@_, 0, 3);
915 my $payinfo = scalar(@_) ? shift : '';
917 my $cust_pay = new FS::cust_pay {
918 'custnum' => $self->custnum,
919 'paid' => sprintf('%.2f', $amount),
920 #'_date' => #date the prepaid card was purchased???
922 'payinfo' => $payinfo,
930 This method is deprecated. See the I<depend_jobnum> option to the insert and
931 order_pkgs methods for a better way to defer provisioning.
933 Re-schedules all exports by calling the B<reexport> method of all associated
934 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
935 otherwise returns false.
942 carp "WARNING: FS::cust_main::reexport is deprectated; ".
943 "use the depend_jobnum option to insert or order_pkgs to delay export";
945 local $SIG{HUP} = 'IGNORE';
946 local $SIG{INT} = 'IGNORE';
947 local $SIG{QUIT} = 'IGNORE';
948 local $SIG{TERM} = 'IGNORE';
949 local $SIG{TSTP} = 'IGNORE';
950 local $SIG{PIPE} = 'IGNORE';
952 my $oldAutoCommit = $FS::UID::AutoCommit;
953 local $FS::UID::AutoCommit = 0;
956 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
957 my $error = $cust_pkg->reexport;
959 $dbh->rollback if $oldAutoCommit;
964 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
969 =item delete [ OPTION => VALUE ... ]
971 This deletes the customer. If there is an error, returns the error, otherwise
974 This will completely remove all traces of the customer record. This is not
975 what you want when a customer cancels service; for that, cancel all of the
976 customer's packages (see L</cancel>).
978 If the customer has any uncancelled packages, you need to pass a new (valid)
979 customer number for those packages to be transferred to, as the "new_customer"
980 option. Cancelled packages will be deleted. Did I mention that this is NOT
981 what you want when a customer cancels service and that you really should be
982 looking at L<FS::cust_pkg/cancel>?
984 You can't delete a customer with invoices (see L<FS::cust_bill>),
985 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
986 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
987 set the "delete_financials" option to a true value.
992 my( $self, %opt ) = @_;
994 local $SIG{HUP} = 'IGNORE';
995 local $SIG{INT} = 'IGNORE';
996 local $SIG{QUIT} = 'IGNORE';
997 local $SIG{TERM} = 'IGNORE';
998 local $SIG{TSTP} = 'IGNORE';
999 local $SIG{PIPE} = 'IGNORE';
1001 my $oldAutoCommit = $FS::UID::AutoCommit;
1002 local $FS::UID::AutoCommit = 0;
1005 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1006 $dbh->rollback if $oldAutoCommit;
1007 return "Can't delete a master agent customer";
1010 #use FS::access_user
1011 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1012 $dbh->rollback if $oldAutoCommit;
1013 return "Can't delete a master employee customer";
1016 tie my %financial_tables, 'Tie::IxHash',
1017 'cust_bill' => 'invoices',
1018 'cust_statement' => 'statements',
1019 'cust_credit' => 'credits',
1020 'cust_pay' => 'payments',
1021 'cust_refund' => 'refunds',
1024 foreach my $table ( keys %financial_tables ) {
1026 my @records = $self->$table();
1028 if ( @records && ! $opt{'delete_financials'} ) {
1029 $dbh->rollback if $oldAutoCommit;
1030 return "Can't delete a customer with ". $financial_tables{$table};
1033 foreach my $record ( @records ) {
1034 my $error = $record->delete;
1036 $dbh->rollback if $oldAutoCommit;
1037 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1043 my @cust_pkg = $self->ncancelled_pkgs;
1045 my $new_custnum = $opt{'new_custnum'};
1046 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1047 $dbh->rollback if $oldAutoCommit;
1048 return "Invalid new customer number: $new_custnum";
1050 foreach my $cust_pkg ( @cust_pkg ) {
1051 my %hash = $cust_pkg->hash;
1052 $hash{'custnum'} = $new_custnum;
1053 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1054 my $error = $new_cust_pkg->replace($cust_pkg,
1055 options => { $cust_pkg->options },
1058 $dbh->rollback if $oldAutoCommit;
1063 my @cancelled_cust_pkg = $self->all_pkgs;
1064 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1065 my $error = $cust_pkg->delete;
1067 $dbh->rollback if $oldAutoCommit;
1072 #cust_tax_adjustment in financials?
1073 #cust_pay_pending? ouch
1075 foreach my $table (qw(
1076 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1077 cust_location cust_main_note cust_tax_adjustment
1078 cust_pay_void cust_pay_batch queue cust_tax_exempt
1080 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1081 my $error = $record->delete;
1083 $dbh->rollback if $oldAutoCommit;
1089 my $sth = $dbh->prepare(
1090 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1092 my $errstr = $dbh->errstr;
1093 $dbh->rollback if $oldAutoCommit;
1096 $sth->execute($self->custnum) or do {
1097 my $errstr = $sth->errstr;
1098 $dbh->rollback if $oldAutoCommit;
1104 my $ticket_dbh = '';
1105 if ($conf->config('ticket_system') eq 'RT_Internal') {
1107 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1108 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1109 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1110 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1113 if ( $ticket_dbh ) {
1115 my $ticket_sth = $ticket_dbh->prepare(
1116 'DELETE FROM Links WHERE Target = ?'
1118 my $errstr = $ticket_dbh->errstr;
1119 $dbh->rollback if $oldAutoCommit;
1122 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1124 my $errstr = $ticket_sth->errstr;
1125 $dbh->rollback if $oldAutoCommit;
1129 #check and see if the customer is the only link on the ticket, and
1130 #if so, set the ticket to deleted status in RT?
1131 #maybe someday, for now this will at least fix tickets not displaying
1135 #delete the customer record
1137 my $error = $self->SUPER::delete;
1139 $dbh->rollback if $oldAutoCommit;
1143 # cust_main exports!
1145 #my $export_args = $options{'export_args'} || [];
1148 map qsearch( 'part_export', {exportnum=>$_} ),
1149 $conf->config('cust_main-exports'); #, $agentnum
1151 foreach my $part_export ( @part_export ) {
1152 my $error = $part_export->export_delete( $self ); #, @$export_args);
1154 $dbh->rollback if $oldAutoCommit;
1155 return "exporting to ". $part_export->exporttype.
1156 " (transaction rolled back): $error";
1160 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1165 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1167 This merges this customer into the provided new custnum, and then deletes the
1168 customer. If there is an error, returns the error, otherwise returns false.
1170 The source customer's name, company name, phone numbers, agent,
1171 referring customer, customer class, advertising source, order taker, and
1172 billing information (except balance) are discarded.
1174 All packages are moved to the target customer. Packages with package locations
1175 are preserved. Packages without package locations are moved to a new package
1176 location with the source customer's service/shipping address.
1178 All invoices, statements, payments, credits and refunds are moved to the target
1179 customer. The source customer's balance is added to the target customer.
1181 All notes, attachments, tickets and customer tags are moved to the target
1184 Change history is not currently moved.
1189 my( $self, $new_custnum, %opt ) = @_;
1191 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1193 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1194 return "Invalid new customer number: $new_custnum";
1197 local $SIG{HUP} = 'IGNORE';
1198 local $SIG{INT} = 'IGNORE';
1199 local $SIG{QUIT} = 'IGNORE';
1200 local $SIG{TERM} = 'IGNORE';
1201 local $SIG{TSTP} = 'IGNORE';
1202 local $SIG{PIPE} = 'IGNORE';
1204 my $oldAutoCommit = $FS::UID::AutoCommit;
1205 local $FS::UID::AutoCommit = 0;
1208 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1209 $dbh->rollback if $oldAutoCommit;
1210 return "Can't merge a master agent customer";
1213 #use FS::access_user
1214 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1215 $dbh->rollback if $oldAutoCommit;
1216 return "Can't merge a master employee customer";
1219 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1220 'status' => { op=>'!=', value=>'done' },
1224 $dbh->rollback if $oldAutoCommit;
1225 return "Can't merge a customer with pending payments";
1228 tie my %financial_tables, 'Tie::IxHash',
1229 'cust_bill' => 'invoices',
1230 'cust_statement' => 'statements',
1231 'cust_credit' => 'credits',
1232 'cust_pay' => 'payments',
1233 'cust_pay_void' => 'voided payments',
1234 'cust_refund' => 'refunds',
1237 foreach my $table ( keys %financial_tables ) {
1239 my @records = $self->$table();
1241 foreach my $record ( @records ) {
1242 $record->custnum($new_custnum);
1243 my $error = $record->replace;
1245 $dbh->rollback if $oldAutoCommit;
1246 return "Error merging ". $financial_tables{$table}. ": $error\n";
1252 my $name = $self->ship_name;
1254 my $locationnum = '';
1255 foreach my $cust_pkg ( $self->all_pkgs ) {
1256 $cust_pkg->custnum($new_custnum);
1258 unless ( $cust_pkg->locationnum ) {
1259 unless ( $locationnum ) {
1260 my $cust_location = new FS::cust_location {
1261 $self->location_hash,
1262 'custnum' => $new_custnum,
1264 my $error = $cust_location->insert;
1266 $dbh->rollback if $oldAutoCommit;
1269 $locationnum = $cust_location->locationnum;
1271 $cust_pkg->locationnum($locationnum);
1274 my $error = $cust_pkg->replace;
1276 $dbh->rollback if $oldAutoCommit;
1280 # add customer (ship) name to svc_phone.phone_name if blank
1281 my @cust_svc = $cust_pkg->cust_svc;
1282 foreach my $cust_svc (@cust_svc) {
1283 my($label, $value, $svcdb) = $cust_svc->label;
1284 next unless $svcdb eq 'svc_phone';
1285 my $svc_phone = $cust_svc->svc_x;
1286 next if $svc_phone->phone_name;
1287 $svc_phone->phone_name($name);
1288 my $error = $svc_phone->replace;
1290 $dbh->rollback if $oldAutoCommit;
1298 # cust_tax_exempt (texas tax exemptions)
1299 # cust_recon (some sort of not-well understood thing for OnPac)
1301 #these are moved over
1302 foreach my $table (qw(
1303 cust_tag cust_location contact cust_attachment cust_main_note
1304 cust_tax_adjustment cust_pay_batch queue
1306 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1307 $record->custnum($new_custnum);
1308 my $error = $record->replace;
1310 $dbh->rollback if $oldAutoCommit;
1316 #these aren't preserved
1317 foreach my $table (qw(
1318 cust_main_exemption cust_main_invoice
1320 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1321 my $error = $record->delete;
1323 $dbh->rollback if $oldAutoCommit;
1330 my $sth = $dbh->prepare(
1331 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1333 my $errstr = $dbh->errstr;
1334 $dbh->rollback if $oldAutoCommit;
1337 $sth->execute($new_custnum, $self->custnum) or do {
1338 my $errstr = $sth->errstr;
1339 $dbh->rollback if $oldAutoCommit;
1345 my $ticket_dbh = '';
1346 if ($conf->config('ticket_system') eq 'RT_Internal') {
1348 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1349 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1350 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1351 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1354 if ( $ticket_dbh ) {
1356 my $ticket_sth = $ticket_dbh->prepare(
1357 'UPDATE Links SET Target = ? WHERE Target = ?'
1359 my $errstr = $ticket_dbh->errstr;
1360 $dbh->rollback if $oldAutoCommit;
1363 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1364 'freeside://freeside/cust_main/'.$self->custnum)
1366 my $errstr = $ticket_sth->errstr;
1367 $dbh->rollback if $oldAutoCommit;
1373 #delete the customer record
1375 my $error = $self->delete;
1377 $dbh->rollback if $oldAutoCommit;
1381 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1386 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1389 Replaces the OLD_RECORD with this one in the database. If there is an error,
1390 returns the error, otherwise returns false.
1392 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1393 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1394 expected and rollback the entire transaction; it is not necessary to call
1395 check_invoicing_list first. Here's an example:
1397 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1399 Currently available options are: I<tax_exemption>.
1401 The I<tax_exemption> option can be set to an arrayref of tax names.
1402 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1409 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1411 : $self->replace_old;
1415 warn "$me replace called\n"
1418 my $curuser = $FS::CurrentUser::CurrentUser;
1419 if ( $self->payby eq 'COMP'
1420 && $self->payby ne $old->payby
1421 && ! $curuser->access_right('Complimentary customer')
1424 return "You are not permitted to create complimentary accounts.";
1427 if ( $old->get('geocode') && $old->get('geocode') eq $self->get('geocode')
1428 && $conf->exists('enable_taxproducts')
1431 my $pre = ($conf->exists('tax-ship_address') && $self->ship_zip)
1433 $self->set('geocode', '')
1434 if $old->get($pre.'zip') ne $self->get($pre.'zip')
1435 && length($self->get($pre.'zip')) >= 10;
1438 local($ignore_expired_card) = 1
1439 if $old->payby =~ /^(CARD|DCRD)$/
1440 && $self->payby =~ /^(CARD|DCRD)$/
1441 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1443 local $SIG{HUP} = 'IGNORE';
1444 local $SIG{INT} = 'IGNORE';
1445 local $SIG{QUIT} = 'IGNORE';
1446 local $SIG{TERM} = 'IGNORE';
1447 local $SIG{TSTP} = 'IGNORE';
1448 local $SIG{PIPE} = 'IGNORE';
1450 my $oldAutoCommit = $FS::UID::AutoCommit;
1451 local $FS::UID::AutoCommit = 0;
1454 my $error = $self->SUPER::replace($old);
1457 $dbh->rollback if $oldAutoCommit;
1461 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1462 my $invoicing_list = shift @param;
1463 $error = $self->check_invoicing_list( $invoicing_list );
1465 $dbh->rollback if $oldAutoCommit;
1468 $self->invoicing_list( $invoicing_list );
1471 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1473 #this could be more efficient than deleting and re-inserting, if it matters
1474 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1475 my $error = $cust_tag->delete;
1477 $dbh->rollback if $oldAutoCommit;
1481 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1482 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1483 'custnum' => $self->custnum };
1484 my $error = $cust_tag->insert;
1486 $dbh->rollback if $oldAutoCommit;
1493 my %options = @param;
1495 my $tax_exemption = delete $options{'tax_exemption'};
1496 if ( $tax_exemption ) {
1498 my %cust_main_exemption =
1499 map { $_->taxname => $_ }
1500 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1502 foreach my $taxname ( @$tax_exemption ) {
1504 next if delete $cust_main_exemption{$taxname};
1506 my $cust_main_exemption = new FS::cust_main_exemption {
1507 'custnum' => $self->custnum,
1508 'taxname' => $taxname,
1510 my $error = $cust_main_exemption->insert;
1512 $dbh->rollback if $oldAutoCommit;
1513 return "inserting cust_main_exemption (transaction rolled back): $error";
1517 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1518 my $error = $cust_main_exemption->delete;
1520 $dbh->rollback if $oldAutoCommit;
1521 return "deleting cust_main_exemption (transaction rolled back): $error";
1527 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1528 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1529 && $self->get('payinfo') !~ /^99\d{14}$/
1531 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1536 # card/check/lec info has changed, want to retry realtime_ invoice events
1537 my $error = $self->retry_realtime;
1539 $dbh->rollback if $oldAutoCommit;
1544 unless ( $import || $skip_fuzzyfiles ) {
1545 $error = $self->queue_fuzzyfiles_update;
1547 $dbh->rollback if $oldAutoCommit;
1548 return "updating fuzzy search cache: $error";
1552 # cust_main exports!
1554 my $export_args = $options{'export_args'} || [];
1557 map qsearch( 'part_export', {exportnum=>$_} ),
1558 $conf->config('cust_main-exports'); #, $agentnum
1560 foreach my $part_export ( @part_export ) {
1561 my $error = $part_export->export_replace( $self, $old, @$export_args);
1563 $dbh->rollback if $oldAutoCommit;
1564 return "exporting to ". $part_export->exporttype.
1565 " (transaction rolled back): $error";
1569 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1574 =item queue_fuzzyfiles_update
1576 Used by insert & replace to update the fuzzy search cache
1580 sub queue_fuzzyfiles_update {
1583 local $SIG{HUP} = 'IGNORE';
1584 local $SIG{INT} = 'IGNORE';
1585 local $SIG{QUIT} = 'IGNORE';
1586 local $SIG{TERM} = 'IGNORE';
1587 local $SIG{TSTP} = 'IGNORE';
1588 local $SIG{PIPE} = 'IGNORE';
1590 my $oldAutoCommit = $FS::UID::AutoCommit;
1591 local $FS::UID::AutoCommit = 0;
1594 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1595 my $error = $queue->insert( map $self->getfield($_), @fuzzyfields );
1597 $dbh->rollback if $oldAutoCommit;
1598 return "queueing job (transaction rolled back): $error";
1601 if ( $self->ship_last ) {
1602 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1603 $error = $queue->insert( map $self->getfield("ship_$_"), @fuzzyfields );
1605 $dbh->rollback if $oldAutoCommit;
1606 return "queueing job (transaction rolled back): $error";
1610 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1617 Checks all fields to make sure this is a valid customer record. If there is
1618 an error, returns the error, otherwise returns false. Called by the insert
1619 and replace methods.
1626 warn "$me check BEFORE: \n". $self->_dump
1630 $self->ut_numbern('custnum')
1631 || $self->ut_number('agentnum')
1632 || $self->ut_textn('agent_custid')
1633 || $self->ut_number('refnum')
1634 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1635 || $self->ut_textn('custbatch')
1636 || $self->ut_name('last')
1637 || $self->ut_name('first')
1638 || $self->ut_snumbern('birthdate')
1639 || $self->ut_snumbern('signupdate')
1640 || $self->ut_textn('company')
1641 || $self->ut_text('address1')
1642 || $self->ut_textn('address2')
1643 || $self->ut_text('city')
1644 || $self->ut_textn('county')
1645 || $self->ut_textn('state')
1646 || $self->ut_country('country')
1647 || $self->ut_anything('comments')
1648 || $self->ut_numbern('referral_custnum')
1649 || $self->ut_textn('stateid')
1650 || $self->ut_textn('stateid_state')
1651 || $self->ut_textn('invoice_terms')
1652 || $self->ut_alphan('geocode')
1653 || $self->ut_floatn('cdr_termination_percentage')
1654 || $self->ut_floatn('credit_limit')
1655 || $self->ut_numbern('billday')
1658 #barf. need message catalogs. i18n. etc.
1659 $error .= "Please select an advertising source."
1660 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1661 return $error if $error;
1663 return "Unknown agent"
1664 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1666 return "Unknown refnum"
1667 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1669 return "Unknown referring custnum: ". $self->referral_custnum
1670 unless ! $self->referral_custnum
1671 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1673 if ( $self->censustract ne '' ) {
1674 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1675 or return "Illegal census tract: ". $self->censustract;
1677 $self->censustract("$1.$2");
1680 if ( $self->ss eq '' ) {
1685 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1686 or return "Illegal social security number: ". $self->ss;
1687 $self->ss("$1-$2-$3");
1691 # bad idea to disable, causes billing to fail because of no tax rates later
1692 # except we don't fail any more
1693 unless ( $import ) {
1694 unless ( qsearch('cust_main_county', {
1695 'country' => $self->country,
1698 return "Unknown state/county/country: ".
1699 $self->state. "/". $self->county. "/". $self->country
1700 unless qsearch('cust_main_county',{
1701 'state' => $self->state,
1702 'county' => $self->county,
1703 'country' => $self->country,
1709 $self->ut_phonen('daytime', $self->country)
1710 || $self->ut_phonen('night', $self->country)
1711 || $self->ut_phonen('fax', $self->country)
1713 return $error if $error;
1715 unless ( $ignore_illegal_zip ) {
1716 $error = $self->ut_zip('zip', $self->country);
1717 return $error if $error;
1720 if ( $conf->exists('cust_main-require_phone')
1721 && ! length($self->daytime) && ! length($self->night)
1724 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1726 : FS::Msgcat::_gettext('daytime');
1727 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1729 : FS::Msgcat::_gettext('night');
1731 return "$daytime_label or $night_label is required"
1735 if ( $self->has_ship_address
1736 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1737 $self->addr_fields )
1741 $self->ut_name('ship_last')
1742 || $self->ut_name('ship_first')
1743 || $self->ut_textn('ship_company')
1744 || $self->ut_text('ship_address1')
1745 || $self->ut_textn('ship_address2')
1746 || $self->ut_text('ship_city')
1747 || $self->ut_textn('ship_county')
1748 || $self->ut_textn('ship_state')
1749 || $self->ut_country('ship_country')
1751 return $error if $error;
1753 #false laziness with above
1754 unless ( qsearchs('cust_main_county', {
1755 'country' => $self->ship_country,
1758 return "Unknown ship_state/ship_county/ship_country: ".
1759 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1760 unless qsearch('cust_main_county',{
1761 'state' => $self->ship_state,
1762 'county' => $self->ship_county,
1763 'country' => $self->ship_country,
1769 $self->ut_phonen('ship_daytime', $self->ship_country)
1770 || $self->ut_phonen('ship_night', $self->ship_country)
1771 || $self->ut_phonen('ship_fax', $self->ship_country)
1773 return $error if $error;
1775 unless ( $ignore_illegal_zip ) {
1776 $error = $self->ut_zip('ship_zip', $self->ship_country);
1777 return $error if $error;
1779 return "Unit # is required."
1780 if $self->ship_address2 =~ /^\s*$/
1781 && $conf->exists('cust_main-require_address2');
1783 } else { # ship_ info eq billing info, so don't store dup info in database
1785 $self->setfield("ship_$_", '')
1786 foreach $self->addr_fields;
1788 return "Unit # is required."
1789 if $self->address2 =~ /^\s*$/
1790 && $conf->exists('cust_main-require_address2');
1794 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1795 # or return "Illegal payby: ". $self->payby;
1797 FS::payby->can_payby($self->table, $self->payby)
1798 or return "Illegal payby: ". $self->payby;
1800 $error = $self->ut_numbern('paystart_month')
1801 || $self->ut_numbern('paystart_year')
1802 || $self->ut_numbern('payissue')
1803 || $self->ut_textn('paytype')
1805 return $error if $error;
1807 if ( $self->payip eq '' ) {
1810 $error = $self->ut_ip('payip');
1811 return $error if $error;
1814 # If it is encrypted and the private key is not availaible then we can't
1815 # check the credit card.
1816 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1818 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1820 my $payinfo = $self->payinfo;
1821 $payinfo =~ s/\D//g;
1822 $payinfo =~ /^(\d{13,16})$/
1823 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1825 $self->payinfo($payinfo);
1827 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1829 return gettext('unknown_card_type')
1830 if $self->payinfo !~ /^99\d{14}$/ #token
1831 && cardtype($self->payinfo) eq "Unknown";
1833 unless ( $ignore_banned_card ) {
1834 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1836 return 'Banned credit card: banned on '.
1837 time2str('%a %h %o at %r', $ban->_date).
1838 ' by '. $ban->otaker.
1839 ' (ban# '. $ban->bannum. ')';
1843 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1844 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1845 $self->paycvv =~ /^(\d{4})$/
1846 or return "CVV2 (CID) for American Express cards is four digits.";
1849 $self->paycvv =~ /^(\d{3})$/
1850 or return "CVV2 (CVC2/CID) is three digits.";
1857 my $cardtype = cardtype($payinfo);
1858 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1860 return "Start date or issue number is required for $cardtype cards"
1861 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1863 return "Start month must be between 1 and 12"
1864 if $self->paystart_month
1865 and $self->paystart_month < 1 || $self->paystart_month > 12;
1867 return "Start year must be 1990 or later"
1868 if $self->paystart_year
1869 and $self->paystart_year < 1990;
1871 return "Issue number must be beween 1 and 99"
1873 and $self->payissue < 1 || $self->payissue > 99;
1876 $self->paystart_month('');
1877 $self->paystart_year('');
1878 $self->payissue('');
1881 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1883 my $payinfo = $self->payinfo;
1884 $payinfo =~ s/[^\d\@\.]//g;
1885 if ( $conf->exists('cust_main-require-bank-branch') ) {
1886 $payinfo =~ /^(\d+)\@(\d+)\.(\d+)$/ or return 'invalid echeck account@branch.bank';
1887 $payinfo = "$1\@$2.$3";
1889 elsif ( $conf->exists('echeck-nonus') ) {
1890 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1891 $payinfo = "$1\@$2";
1893 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1894 $payinfo = "$1\@$2";
1896 $self->payinfo($payinfo);
1899 unless ( $ignore_banned_card ) {
1900 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1902 return 'Banned ACH account: banned on '.
1903 time2str('%a %h %o at %r', $ban->_date).
1904 ' by '. $ban->otaker.
1905 ' (ban# '. $ban->bannum. ')';
1909 } elsif ( $self->payby eq 'LECB' ) {
1911 my $payinfo = $self->payinfo;
1912 $payinfo =~ s/\D//g;
1913 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1915 $self->payinfo($payinfo);
1918 } elsif ( $self->payby eq 'BILL' ) {
1920 $error = $self->ut_textn('payinfo');
1921 return "Illegal P.O. number: ". $self->payinfo if $error;
1924 } elsif ( $self->payby eq 'COMP' ) {
1926 my $curuser = $FS::CurrentUser::CurrentUser;
1927 if ( ! $self->custnum
1928 && ! $curuser->access_right('Complimentary customer')
1931 return "You are not permitted to create complimentary accounts."
1934 $error = $self->ut_textn('payinfo');
1935 return "Illegal comp account issuer: ". $self->payinfo if $error;
1938 } elsif ( $self->payby eq 'PREPAY' ) {
1940 my $payinfo = $self->payinfo;
1941 $payinfo =~ s/\W//g; #anything else would just confuse things
1942 $self->payinfo($payinfo);
1943 $error = $self->ut_alpha('payinfo');
1944 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1945 return "Unknown prepayment identifier"
1946 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1951 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1952 return "Expiration date required"
1953 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1957 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1958 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1959 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1960 ( $m, $y ) = ( $2, "19$1" );
1961 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1962 ( $m, $y ) = ( $3, "20$2" );
1964 return "Illegal expiration date: ". $self->paydate;
1966 $m = sprintf('%02d',$m);
1967 $self->paydate("$y-$m-01");
1968 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1969 return gettext('expired_card')
1971 && !$ignore_expired_card
1972 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1975 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1976 ( ! $conf->exists('require_cardname')
1977 || $self->payby !~ /^(CARD|DCRD)$/ )
1979 $self->payname( $self->first. " ". $self->getfield('last') );
1981 $self->payname =~ /^([µ_0123456789aAáÁàÀâÂåÅäÄãêæÆbBcCçÇdDðÐeEéÉèÈêÊëËfFgGhHiIíÍìÌîÎïÏjJkKlLmMnNñÑoOóÓòÒôÔöÖõÕøغpPqQrRsSßtTuUúÚùÙûÛüÜvVwWxXyYýÝÿzZþÞ \,\.\-\'\&]+)$/
1982 or return gettext('illegal_name'). " payname: ". $self->payname;
1986 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1987 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1991 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
1993 warn "$me check AFTER: \n". $self->_dump
1996 $self->SUPER::check;
2001 Returns a list of fields which have ship_ duplicates.
2006 qw( last first company
2007 address1 address2 city county state zip country
2012 =item has_ship_address
2014 Returns true if this customer record has a separate shipping address.
2018 sub has_ship_address {
2020 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
2025 Returns a list of key/value pairs, with the following keys: address1, adddress2,
2026 city, county, state, zip, country, and geocode. The shipping address is used if present.
2032 Returns all locations (see L<FS::cust_location>) for this customer.
2038 qsearch('cust_location', { 'custnum' => $self->custnum } );
2043 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2044 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2045 on success or a list of errors.
2051 grep { $_->unsuspend } $self->suspended_pkgs;
2056 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2058 Returns a list: an empty list on success or a list of errors.
2064 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2067 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2069 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2070 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2071 of a list of pkgparts; the hashref has the following keys:
2075 =item pkgparts - listref of pkgparts
2077 =item (other options are passed to the suspend method)
2082 Returns a list: an empty list on success or a list of errors.
2086 sub suspend_if_pkgpart {
2088 my (@pkgparts, %opt);
2089 if (ref($_[0]) eq 'HASH'){
2090 @pkgparts = @{$_[0]{pkgparts}};
2095 grep { $_->suspend(%opt) }
2096 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2097 $self->unsuspended_pkgs;
2100 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2102 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2103 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2104 instead of a list of pkgparts; the hashref has the following keys:
2108 =item pkgparts - listref of pkgparts
2110 =item (other options are passed to the suspend method)
2114 Returns a list: an empty list on success or a list of errors.
2118 sub suspend_unless_pkgpart {
2120 my (@pkgparts, %opt);
2121 if (ref($_[0]) eq 'HASH'){
2122 @pkgparts = @{$_[0]{pkgparts}};
2127 grep { $_->suspend(%opt) }
2128 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2129 $self->unsuspended_pkgs;
2132 =item cancel [ OPTION => VALUE ... ]
2134 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2136 Available options are:
2140 =item quiet - can be set true to supress email cancellation notices.
2142 =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.
2144 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2146 =item nobill - can be set true to skip billing if it might otherwise be done.
2150 Always returns a list: an empty list on success or a list of errors.
2154 # nb that dates are not specified as valid options to this method
2157 my( $self, %opt ) = @_;
2159 warn "$me cancel called on customer ". $self->custnum. " with options ".
2160 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2163 return ( 'access denied' )
2164 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2166 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2168 #should try decryption (we might have the private key)
2169 # and if not maybe queue a job for the server that does?
2170 return ( "Can't (yet) ban encrypted credit cards" )
2171 if $self->is_encrypted($self->payinfo);
2173 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2174 my $error = $ban->insert;
2175 return ( $error ) if $error;
2179 my @pkgs = $self->ncancelled_pkgs;
2181 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2183 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2184 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2188 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2189 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2192 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2195 sub _banned_pay_hashref {
2206 'payby' => $payby2ban{$self->payby},
2207 'payinfo' => md5_base64($self->payinfo),
2208 #don't ever *search* on reason! #'reason' =>
2214 Returns all notes (see L<FS::cust_main_note>) for this customer.
2219 my($self,$orderby_classnum) = (shift,shift);
2220 my $orderby = "_DATE DESC";
2221 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2222 qsearch( 'cust_main_note',
2223 { 'custnum' => $self->custnum },
2225 "ORDER BY $orderby",
2231 Returns the agent (see L<FS::agent>) for this customer.
2237 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2242 Returns the agent name (see L<FS::agent>) for this customer.
2248 $self->agent->agent;
2253 Returns any tags associated with this customer, as FS::cust_tag objects,
2254 or an empty list if there are no tags.
2260 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2265 Returns any tags associated with this customer, as FS::part_tag objects,
2266 or an empty list if there are no tags.
2272 map $_->part_tag, $self->cust_tag;
2278 Returns the customer class, as an FS::cust_class object, or the empty string
2279 if there is no customer class.
2285 if ( $self->classnum ) {
2286 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2294 Returns the customer category name, or the empty string if there is no customer
2301 my $cust_class = $self->cust_class;
2303 ? $cust_class->categoryname
2309 Returns the customer class name, or the empty string if there is no customer
2316 my $cust_class = $self->cust_class;
2318 ? $cust_class->classname
2322 =item BILLING METHODS
2324 Documentation on billing methods has been moved to
2325 L<FS::cust_main::Billing>.
2327 =item REALTIME BILLING METHODS
2329 Documentation on realtime billing methods has been moved to
2330 L<FS::cust_main::Billing_Realtime>.
2334 Removes the I<paycvv> field from the database directly.
2336 If there is an error, returns the error, otherwise returns false.
2342 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2343 or return dbh->errstr;
2344 $sth->execute($self->custnum)
2345 or return $sth->errstr;
2350 =item batch_card OPTION => VALUE...
2352 Adds a payment for this invoice to the pending credit card batch (see
2353 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2354 runs the payment using a realtime gateway.
2359 my ($self, %options) = @_;
2362 if (exists($options{amount})) {
2363 $amount = $options{amount};
2365 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2367 return '' unless $amount > 0;
2369 my $invnum = delete $options{invnum};
2370 my $payby = $options{payby} || $self->payby; #still dubious
2372 if ($options{'realtime'}) {
2373 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2379 my $oldAutoCommit = $FS::UID::AutoCommit;
2380 local $FS::UID::AutoCommit = 0;
2383 #this needs to handle mysql as well as Pg, like svc_acct.pm
2384 #(make it into a common function if folks need to do batching with mysql)
2385 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2386 or return "Cannot lock pay_batch: " . $dbh->errstr;
2390 'payby' => FS::payby->payby2payment($payby),
2393 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2395 unless ( $pay_batch ) {
2396 $pay_batch = new FS::pay_batch \%pay_batch;
2397 my $error = $pay_batch->insert;
2399 $dbh->rollback if $oldAutoCommit;
2400 die "error creating new batch: $error\n";
2404 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2405 'batchnum' => $pay_batch->batchnum,
2406 'custnum' => $self->custnum,
2409 foreach (qw( address1 address2 city state zip country payby payinfo paydate
2411 $options{$_} = '' unless exists($options{$_});
2414 my $cust_pay_batch = new FS::cust_pay_batch ( {
2415 'batchnum' => $pay_batch->batchnum,
2416 'invnum' => $invnum || 0, # is there a better value?
2417 # this field should be
2419 # cust_bill_pay_batch now
2420 'custnum' => $self->custnum,
2421 'last' => $self->getfield('last'),
2422 'first' => $self->getfield('first'),
2423 'address1' => $options{address1} || $self->address1,
2424 'address2' => $options{address2} || $self->address2,
2425 'city' => $options{city} || $self->city,
2426 'state' => $options{state} || $self->state,
2427 'zip' => $options{zip} || $self->zip,
2428 'country' => $options{country} || $self->country,
2429 'payby' => $options{payby} || $self->payby,
2430 'payinfo' => $options{payinfo} || $self->payinfo,
2431 'exp' => $options{paydate} || $self->paydate,
2432 'payname' => $options{payname} || $self->payname,
2433 'amount' => $amount, # consolidating
2436 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2437 if $old_cust_pay_batch;
2440 if ($old_cust_pay_batch) {
2441 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2443 $error = $cust_pay_batch->insert;
2447 $dbh->rollback if $oldAutoCommit;
2451 my $unapplied = $self->total_unapplied_credits
2452 + $self->total_unapplied_payments
2453 + $self->in_transit_payments;
2454 foreach my $cust_bill ($self->open_cust_bill) {
2455 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2456 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2457 'invnum' => $cust_bill->invnum,
2458 'paybatchnum' => $cust_pay_batch->paybatchnum,
2459 'amount' => $cust_bill->owed,
2462 if ($unapplied >= $cust_bill_pay_batch->amount){
2463 $unapplied -= $cust_bill_pay_batch->amount;
2466 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2467 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2469 $error = $cust_bill_pay_batch->insert;
2471 $dbh->rollback if $oldAutoCommit;
2476 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2482 Returns the total owed for this customer on all invoices
2483 (see L<FS::cust_bill/owed>).
2489 $self->total_owed_date(2145859200); #12/31/2037
2492 =item total_owed_date TIME
2494 Returns the total owed for this customer on all invoices with date earlier than
2495 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2496 see L<Time::Local> and L<Date::Parse> for conversion functions.
2500 sub total_owed_date {
2504 my $custnum = $self->custnum;
2506 my $owed_sql = FS::cust_bill->owed_sql;
2509 SELECT SUM($owed_sql) FROM cust_bill
2510 WHERE custnum = $custnum
2514 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2518 =item total_owed_pkgnum PKGNUM
2520 Returns the total owed on all invoices for this customer's specific package
2521 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2525 sub total_owed_pkgnum {
2526 my( $self, $pkgnum ) = @_;
2527 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2530 =item total_owed_date_pkgnum TIME PKGNUM
2532 Returns the total owed for this customer's specific package when using
2533 experimental package balances on all invoices with date earlier than
2534 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2535 see L<Time::Local> and L<Date::Parse> for conversion functions.
2539 sub total_owed_date_pkgnum {
2540 my( $self, $time, $pkgnum ) = @_;
2543 foreach my $cust_bill (
2544 grep { $_->_date <= $time }
2545 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2547 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2549 sprintf( "%.2f", $total_bill );
2555 Returns the total amount of all payments.
2562 $total += $_->paid foreach $self->cust_pay;
2563 sprintf( "%.2f", $total );
2566 =item total_unapplied_credits
2568 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2569 customer. See L<FS::cust_credit/credited>.
2571 =item total_credited
2573 Old name for total_unapplied_credits. Don't use.
2577 sub total_credited {
2578 #carp "total_credited deprecated, use total_unapplied_credits";
2579 shift->total_unapplied_credits(@_);
2582 sub total_unapplied_credits {
2585 my $custnum = $self->custnum;
2587 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2590 SELECT SUM($unapplied_sql) FROM cust_credit
2591 WHERE custnum = $custnum
2594 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2598 =item total_unapplied_credits_pkgnum PKGNUM
2600 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2601 customer. See L<FS::cust_credit/credited>.
2605 sub total_unapplied_credits_pkgnum {
2606 my( $self, $pkgnum ) = @_;
2607 my $total_credit = 0;
2608 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2609 sprintf( "%.2f", $total_credit );
2613 =item total_unapplied_payments
2615 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2616 See L<FS::cust_pay/unapplied>.
2620 sub total_unapplied_payments {
2623 my $custnum = $self->custnum;
2625 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2628 SELECT SUM($unapplied_sql) FROM cust_pay
2629 WHERE custnum = $custnum
2632 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2636 =item total_unapplied_payments_pkgnum PKGNUM
2638 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2639 specific package when using experimental package balances. See
2640 L<FS::cust_pay/unapplied>.
2644 sub total_unapplied_payments_pkgnum {
2645 my( $self, $pkgnum ) = @_;
2646 my $total_unapplied = 0;
2647 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2648 sprintf( "%.2f", $total_unapplied );
2652 =item total_unapplied_refunds
2654 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2655 customer. See L<FS::cust_refund/unapplied>.
2659 sub total_unapplied_refunds {
2661 my $custnum = $self->custnum;
2663 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2666 SELECT SUM($unapplied_sql) FROM cust_refund
2667 WHERE custnum = $custnum
2670 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2676 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2677 total_unapplied_credits minus total_unapplied_payments).
2683 $self->balance_date_range;
2686 =item balance_date TIME
2688 Returns the balance for this customer, only considering invoices with date
2689 earlier than TIME (total_owed_date minus total_credited minus
2690 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2691 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2698 $self->balance_date_range(shift);
2701 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2703 Returns the balance for this customer, optionally considering invoices with
2704 date earlier than START_TIME, and not later than END_TIME
2705 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2707 Times are specified as SQL fragments or numeric
2708 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2709 L<Date::Parse> for conversion functions. The empty string can be passed
2710 to disable that time constraint completely.
2712 Available options are:
2716 =item unapplied_date
2718 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)
2724 sub balance_date_range {
2726 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2727 ') FROM cust_main WHERE custnum='. $self->custnum;
2728 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2731 =item balance_pkgnum PKGNUM
2733 Returns the balance for this customer's specific package when using
2734 experimental package balances (total_owed plus total_unrefunded, minus
2735 total_unapplied_credits minus total_unapplied_payments)
2739 sub balance_pkgnum {
2740 my( $self, $pkgnum ) = @_;
2743 $self->total_owed_pkgnum($pkgnum)
2744 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2745 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2746 - $self->total_unapplied_credits_pkgnum($pkgnum)
2747 - $self->total_unapplied_payments_pkgnum($pkgnum)
2751 =item in_transit_payments
2753 Returns the total of requests for payments for this customer pending in
2754 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2758 sub in_transit_payments {
2760 my $in_transit_payments = 0;
2761 foreach my $pay_batch ( qsearch('pay_batch', {
2764 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2765 'batchnum' => $pay_batch->batchnum,
2766 'custnum' => $self->custnum,
2768 $in_transit_payments += $cust_pay_batch->amount;
2771 sprintf( "%.2f", $in_transit_payments );
2776 Returns a hash of useful information for making a payment.
2786 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2787 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2788 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2792 For credit card transactions:
2804 For electronic check transactions:
2819 $return{balance} = $self->balance;
2821 $return{payname} = $self->payname
2822 || ( $self->first. ' '. $self->get('last') );
2824 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
2826 $return{payby} = $self->payby;
2827 $return{stateid_state} = $self->stateid_state;
2829 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2830 $return{card_type} = cardtype($self->payinfo);
2831 $return{payinfo} = $self->paymask;
2833 @return{'month', 'year'} = $self->paydate_monthyear;
2837 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2838 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2839 $return{payinfo1} = $payinfo1;
2840 $return{payinfo2} = $payinfo2;
2841 $return{paytype} = $self->paytype;
2842 $return{paystate} = $self->paystate;
2846 #doubleclick protection
2848 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2854 =item paydate_monthyear
2856 Returns a two-element list consisting of the month and year of this customer's
2857 paydate (credit card expiration date for CARD customers)
2861 sub paydate_monthyear {
2863 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2865 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2872 =item tax_exemption TAXNAME
2877 my( $self, $taxname ) = @_;
2879 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2880 'taxname' => $taxname,
2885 =item cust_main_exemption
2889 sub cust_main_exemption {
2891 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
2894 =item invoicing_list [ ARRAYREF ]
2896 If an arguement is given, sets these email addresses as invoice recipients
2897 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
2898 (except as warnings), so use check_invoicing_list first.
2900 Returns a list of email addresses (with svcnum entries expanded).
2902 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
2903 check it without disturbing anything by passing nothing.
2905 This interface may change in the future.
2909 sub invoicing_list {
2910 my( $self, $arrayref ) = @_;
2913 my @cust_main_invoice;
2914 if ( $self->custnum ) {
2915 @cust_main_invoice =
2916 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
2918 @cust_main_invoice = ();
2920 foreach my $cust_main_invoice ( @cust_main_invoice ) {
2921 #warn $cust_main_invoice->destnum;
2922 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
2923 #warn $cust_main_invoice->destnum;
2924 my $error = $cust_main_invoice->delete;
2925 warn $error if $error;
2928 if ( $self->custnum ) {
2929 @cust_main_invoice =
2930 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
2932 @cust_main_invoice = ();
2934 my %seen = map { $_->address => 1 } @cust_main_invoice;
2935 foreach my $address ( @{$arrayref} ) {
2936 next if exists $seen{$address} && $seen{$address};
2937 $seen{$address} = 1;
2938 my $cust_main_invoice = new FS::cust_main_invoice ( {
2939 'custnum' => $self->custnum,
2942 my $error = $cust_main_invoice->insert;
2943 warn $error if $error;
2947 if ( $self->custnum ) {
2949 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
2956 =item check_invoicing_list ARRAYREF
2958 Checks these arguements as valid input for the invoicing_list method. If there
2959 is an error, returns the error, otherwise returns false.
2963 sub check_invoicing_list {
2964 my( $self, $arrayref ) = @_;
2966 foreach my $address ( @$arrayref ) {
2968 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
2969 return 'Can\'t add FAX invoice destination with a blank FAX number.';
2972 my $cust_main_invoice = new FS::cust_main_invoice ( {
2973 'custnum' => $self->custnum,
2976 my $error = $self->custnum
2977 ? $cust_main_invoice->check
2978 : $cust_main_invoice->checkdest
2980 return $error if $error;
2984 return "Email address required"
2985 if $conf->exists('cust_main-require_invoicing_list_email')
2986 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
2991 =item set_default_invoicing_list
2993 Sets the invoicing list to all accounts associated with this customer,
2994 overwriting any previous invoicing list.
2998 sub set_default_invoicing_list {
3000 $self->invoicing_list($self->all_emails);
3005 Returns the email addresses of all accounts provisioned for this customer.
3012 foreach my $cust_pkg ( $self->all_pkgs ) {
3013 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3015 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3016 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3018 $list{$_}=1 foreach map { $_->email } @svc_acct;
3023 =item invoicing_list_addpost
3025 Adds postal invoicing to this customer. If this customer is already configured
3026 to receive postal invoices, does nothing.
3030 sub invoicing_list_addpost {
3032 return if grep { $_ eq 'POST' } $self->invoicing_list;
3033 my @invoicing_list = $self->invoicing_list;
3034 push @invoicing_list, 'POST';
3035 $self->invoicing_list(\@invoicing_list);
3038 =item invoicing_list_emailonly
3040 Returns the list of email invoice recipients (invoicing_list without non-email
3041 destinations such as POST and FAX).
3045 sub invoicing_list_emailonly {
3047 warn "$me invoicing_list_emailonly called"
3049 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3052 =item invoicing_list_emailonly_scalar
3054 Returns the list of email invoice recipients (invoicing_list without non-email
3055 destinations such as POST and FAX) as a comma-separated scalar.
3059 sub invoicing_list_emailonly_scalar {
3061 warn "$me invoicing_list_emailonly_scalar called"
3063 join(', ', $self->invoicing_list_emailonly);
3066 =item referral_custnum_cust_main
3068 Returns the customer who referred this customer (or the empty string, if
3069 this customer was not referred).
3071 Note the difference with referral_cust_main method: This method,
3072 referral_custnum_cust_main returns the single customer (if any) who referred
3073 this customer, while referral_cust_main returns an array of customers referred
3078 sub referral_custnum_cust_main {
3080 return '' unless $self->referral_custnum;
3081 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3084 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3086 Returns an array of customers referred by this customer (referral_custnum set
3087 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3088 customers referred by customers referred by this customer and so on, inclusive.
3089 The default behavior is DEPTH 1 (no recursion).
3091 Note the difference with referral_custnum_cust_main method: This method,
3092 referral_cust_main, returns an array of customers referred BY this customer,
3093 while referral_custnum_cust_main returns the single customer (if any) who
3094 referred this customer.
3098 sub referral_cust_main {
3100 my $depth = @_ ? shift : 1;
3101 my $exclude = @_ ? shift : {};
3104 map { $exclude->{$_->custnum}++; $_; }
3105 grep { ! $exclude->{ $_->custnum } }
3106 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3110 map { $_->referral_cust_main($depth-1, $exclude) }
3117 =item referral_cust_main_ncancelled
3119 Same as referral_cust_main, except only returns customers with uncancelled
3124 sub referral_cust_main_ncancelled {
3126 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3129 =item referral_cust_pkg [ DEPTH ]
3131 Like referral_cust_main, except returns a flat list of all unsuspended (and
3132 uncancelled) packages for each customer. The number of items in this list may
3133 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3137 sub referral_cust_pkg {
3139 my $depth = @_ ? shift : 1;
3141 map { $_->unsuspended_pkgs }
3142 grep { $_->unsuspended_pkgs }
3143 $self->referral_cust_main($depth);
3146 =item referring_cust_main
3148 Returns the single cust_main record for the customer who referred this customer
3149 (referral_custnum), or false.
3153 sub referring_cust_main {
3155 return '' unless $self->referral_custnum;
3156 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3159 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3161 Applies a credit to this customer. If there is an error, returns the error,
3162 otherwise returns false.
3164 REASON can be a text string, an FS::reason object, or a scalar reference to
3165 a reasonnum. If a text string, it will be automatically inserted as a new
3166 reason, and a 'reason_type' option must be passed to indicate the
3167 FS::reason_type for the new reason.
3169 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3171 Any other options are passed to FS::cust_credit::insert.
3176 my( $self, $amount, $reason, %options ) = @_;
3178 my $cust_credit = new FS::cust_credit {
3179 'custnum' => $self->custnum,
3180 'amount' => $amount,
3183 if ( ref($reason) ) {
3185 if ( ref($reason) eq 'SCALAR' ) {
3186 $cust_credit->reasonnum( $$reason );
3188 $cust_credit->reasonnum( $reason->reasonnum );
3192 $cust_credit->set('reason', $reason)
3195 for (qw( addlinfo eventnum )) {
3196 $cust_credit->$_( delete $options{$_} )
3197 if exists($options{$_});
3200 $cust_credit->insert(%options);
3204 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3206 Creates a one-time charge for this customer. If there is an error, returns
3207 the error, otherwise returns false.
3209 New-style, with a hashref of options:
3211 my $error = $cust_main->charge(
3215 'start_date' => str2time('7/4/2009'),
3216 'pkg' => 'Description',
3217 'comment' => 'Comment',
3218 'additional' => [], #extra invoice detail
3219 'classnum' => 1, #pkg_class
3221 'setuptax' => '', # or 'Y' for tax exempt
3224 'taxclass' => 'Tax class',
3227 'taxproduct' => 2, #part_pkg_taxproduct
3228 'override' => {}, #XXX describe
3230 #will be filled in with the new object
3231 'cust_pkg_ref' => \$cust_pkg,
3233 #generate an invoice immediately
3235 'invoice_terms' => '', #with these terms
3241 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3247 my ( $amount, $quantity, $start_date, $classnum );
3248 my ( $pkg, $comment, $additional );
3249 my ( $setuptax, $taxclass ); #internal taxes
3250 my ( $taxproduct, $override ); #vendor (CCH) taxes
3252 my $cust_pkg_ref = '';
3253 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3254 if ( ref( $_[0] ) ) {
3255 $amount = $_[0]->{amount};
3256 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3257 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3258 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3259 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3260 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3261 : '$'. sprintf("%.2f",$amount);
3262 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3263 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3264 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3265 $additional = $_[0]->{additional} || [];
3266 $taxproduct = $_[0]->{taxproductnum};
3267 $override = { '' => $_[0]->{tax_override} };
3268 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3269 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3270 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3275 $pkg = @_ ? shift : 'One-time charge';
3276 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3278 $taxclass = @_ ? shift : '';
3282 local $SIG{HUP} = 'IGNORE';
3283 local $SIG{INT} = 'IGNORE';
3284 local $SIG{QUIT} = 'IGNORE';
3285 local $SIG{TERM} = 'IGNORE';
3286 local $SIG{TSTP} = 'IGNORE';
3287 local $SIG{PIPE} = 'IGNORE';
3289 my $oldAutoCommit = $FS::UID::AutoCommit;
3290 local $FS::UID::AutoCommit = 0;
3293 my $part_pkg = new FS::part_pkg ( {
3295 'comment' => $comment,
3299 'classnum' => ( $classnum ? $classnum : '' ),
3300 'setuptax' => $setuptax,
3301 'taxclass' => $taxclass,
3302 'taxproductnum' => $taxproduct,
3305 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3306 ( 0 .. @$additional - 1 )
3308 'additional_count' => scalar(@$additional),
3309 'setup_fee' => $amount,
3312 my $error = $part_pkg->insert( options => \%options,
3313 tax_overrides => $override,
3316 $dbh->rollback if $oldAutoCommit;
3320 my $pkgpart = $part_pkg->pkgpart;
3321 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3322 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3323 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3324 $error = $type_pkgs->insert;
3326 $dbh->rollback if $oldAutoCommit;
3331 my $cust_pkg = new FS::cust_pkg ( {
3332 'custnum' => $self->custnum,
3333 'pkgpart' => $pkgpart,
3334 'quantity' => $quantity,
3335 'start_date' => $start_date,
3336 'no_auto' => $no_auto,
3339 $error = $cust_pkg->insert;
3341 $dbh->rollback if $oldAutoCommit;
3343 } elsif ( $cust_pkg_ref ) {
3344 ${$cust_pkg_ref} = $cust_pkg;
3348 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3349 'pkg_list' => [ $cust_pkg ],
3352 $dbh->rollback if $oldAutoCommit;
3357 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3362 #=item charge_postal_fee
3364 #Applies a one time charge this customer. If there is an error,
3365 #returns the error, returns the cust_pkg charge object or false
3366 #if there was no charge.
3370 # This should be a customer event. For that to work requires that bill
3371 # also be a customer event.
3373 sub charge_postal_fee {
3376 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3377 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3379 my $cust_pkg = new FS::cust_pkg ( {
3380 'custnum' => $self->custnum,
3381 'pkgpart' => $pkgpart,
3385 my $error = $cust_pkg->insert;
3386 $error ? $error : $cust_pkg;
3389 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3391 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3393 Optionally, a list or hashref of additional arguments to the qsearch call can
3400 my $opt = ref($_[0]) ? shift : { @_ };
3402 #return $self->num_cust_bill unless wantarray || keys %$opt;
3404 $opt->{'table'} = 'cust_bill';
3405 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3406 $opt->{'hashref'}{'custnum'} = $self->custnum;
3407 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3409 map { $_ } #behavior of sort undefined in scalar context
3410 sort { $a->_date <=> $b->_date }
3414 =item open_cust_bill
3416 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3421 sub open_cust_bill {
3425 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3431 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3433 Returns all the statements (see L<FS::cust_statement>) for this customer.
3435 Optionally, a list or hashref of additional arguments to the qsearch call can
3440 sub cust_statement {
3442 my $opt = ref($_[0]) ? shift : { @_ };
3444 #return $self->num_cust_statement unless wantarray || keys %$opt;
3446 $opt->{'table'} = 'cust_statement';
3447 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3448 $opt->{'hashref'}{'custnum'} = $self->custnum;
3449 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3451 map { $_ } #behavior of sort undefined in scalar context
3452 sort { $a->_date <=> $b->_date }
3458 Returns all the credits (see L<FS::cust_credit>) for this customer.
3464 map { $_ } #return $self->num_cust_credit unless wantarray;
3465 sort { $a->_date <=> $b->_date }
3466 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3469 =item cust_credit_pkgnum
3471 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3472 package when using experimental package balances.
3476 sub cust_credit_pkgnum {
3477 my( $self, $pkgnum ) = @_;
3478 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3479 sort { $a->_date <=> $b->_date }
3480 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3481 'pkgnum' => $pkgnum,
3488 Returns all the payments (see L<FS::cust_pay>) for this customer.
3494 return $self->num_cust_pay unless wantarray;
3495 sort { $a->_date <=> $b->_date }
3496 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3501 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3502 called automatically when the cust_pay method is used in a scalar context.
3508 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3509 my $sth = dbh->prepare($sql) or die dbh->errstr;
3510 $sth->execute($self->custnum) or die $sth->errstr;
3511 $sth->fetchrow_arrayref->[0];
3514 =item cust_pay_pkgnum
3516 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3517 package when using experimental package balances.
3521 sub cust_pay_pkgnum {
3522 my( $self, $pkgnum ) = @_;
3523 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3524 sort { $a->_date <=> $b->_date }
3525 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3526 'pkgnum' => $pkgnum,
3533 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3539 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3540 sort { $a->_date <=> $b->_date }
3541 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3544 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3546 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
3548 Optionally, a list or hashref of additional arguments to the qsearch call can
3553 sub cust_pay_batch {
3555 my $opt = ref($_[0]) ? shift : { @_ };
3557 #return $self->num_cust_statement unless wantarray || keys %$opt;
3559 $opt->{'table'} = 'cust_pay_batch';
3560 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3561 $opt->{'hashref'}{'custnum'} = $self->custnum;
3562 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3564 map { $_ } #behavior of sort undefined in scalar context
3565 sort { $a->paybatchnum <=> $b->paybatchnum }
3569 =item cust_pay_pending
3571 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3572 (without status "done").
3576 sub cust_pay_pending {
3578 return $self->num_cust_pay_pending unless wantarray;
3579 sort { $a->_date <=> $b->_date }
3580 qsearch( 'cust_pay_pending', {
3581 'custnum' => $self->custnum,
3582 'status' => { op=>'!=', value=>'done' },
3587 =item cust_pay_pending_attempt
3589 Returns all payment attempts / declined payments for this customer, as pending
3590 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3591 a corresponding payment (see L<FS::cust_pay>).
3595 sub cust_pay_pending_attempt {
3597 return $self->num_cust_pay_pending_attempt unless wantarray;
3598 sort { $a->_date <=> $b->_date }
3599 qsearch( 'cust_pay_pending', {
3600 'custnum' => $self->custnum,
3607 =item num_cust_pay_pending
3609 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3610 customer (without status "done"). Also called automatically when the
3611 cust_pay_pending method is used in a scalar context.
3615 sub num_cust_pay_pending {
3618 " SELECT COUNT(*) FROM cust_pay_pending ".
3619 " WHERE custnum = ? AND status != 'done' ",
3624 =item num_cust_pay_pending_attempt
3626 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3627 customer, with status "done" but without a corresp. Also called automatically when the
3628 cust_pay_pending method is used in a scalar context.
3632 sub num_cust_pay_pending_attempt {
3635 " SELECT COUNT(*) FROM cust_pay_pending ".
3636 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3643 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3649 map { $_ } #return $self->num_cust_refund unless wantarray;
3650 sort { $a->_date <=> $b->_date }
3651 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3654 =item display_custnum
3656 Returns the displayed customer number for this customer: agent_custid if
3657 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3661 sub display_custnum {
3663 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3664 return $self->agent_custid;
3666 return $self->custnum;
3672 Returns a name string for this customer, either "Company (Last, First)" or
3679 my $name = $self->contact;
3680 $name = $self->company. " ($name)" if $self->company;
3686 Returns a name string for this (service/shipping) contact, either
3687 "Company (Last, First)" or "Last, First".
3693 if ( $self->get('ship_last') ) {
3694 my $name = $self->ship_contact;
3695 $name = $self->ship_company. " ($name)" if $self->ship_company;
3704 Returns a name string for this customer, either "Company" or "First Last".
3710 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3713 =item ship_name_short
3715 Returns a name string for this (service/shipping) contact, either "Company"
3720 sub ship_name_short {
3722 if ( $self->get('ship_last') ) {
3723 $self->ship_company !~ /^\s*$/
3724 ? $self->ship_company
3725 : $self->ship_contact_firstlast;
3727 $self->name_company_or_firstlast;
3733 Returns this customer's full (billing) contact name only, "Last, First"
3739 $self->get('last'). ', '. $self->first;
3744 Returns this customer's full (shipping) contact name only, "Last, First"
3750 $self->get('ship_last')
3751 ? $self->get('ship_last'). ', '. $self->ship_first
3755 =item contact_firstlast
3757 Returns this customers full (billing) contact name only, "First Last".
3761 sub contact_firstlast {
3763 $self->first. ' '. $self->get('last');
3766 =item ship_contact_firstlast
3768 Returns this customer's full (shipping) contact name only, "First Last".
3772 sub ship_contact_firstlast {
3774 $self->get('ship_last')
3775 ? $self->first. ' '. $self->get('ship_last')
3776 : $self->contact_firstlast;
3781 Returns this customer's full country name
3787 code2country($self->country);
3790 =item geocode DATA_VENDOR
3792 Returns a value for the customer location as encoded by DATA_VENDOR.
3793 Currently this only makes sense for "CCH" as DATA_VENDOR.
3801 Returns a status string for this customer, currently:
3805 =item prospect - No packages have ever been ordered
3807 =item ordered - Recurring packages all are new (not yet billed).
3809 =item active - One or more recurring packages is active
3811 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
3813 =item suspended - All non-cancelled recurring packages are suspended
3815 =item cancelled - All recurring packages are cancelled
3819 Behavior of inactive vs. cancelled edge cases can be adjusted with the
3820 cust_main-status_module configuration option.
3824 sub status { shift->cust_status(@_); }
3828 for my $status ( FS::cust_main->statuses() ) {
3829 my $method = $status.'_sql';
3830 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3831 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3832 $sth->execute( ($self->custnum) x $numnum )
3833 or die "Error executing 'SELECT $sql': ". $sth->errstr;
3834 return $status if $sth->fetchrow_arrayref->[0];
3838 =item ucfirst_cust_status
3840 =item ucfirst_status
3842 Returns the status with the first character capitalized.
3846 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
3848 sub ucfirst_cust_status {
3850 ucfirst($self->cust_status);
3855 Returns a hex triplet color string for this customer's status.
3859 sub statuscolor { shift->cust_statuscolor(@_); }
3861 sub cust_statuscolor {
3863 __PACKAGE__->statuscolors->{$self->cust_status};
3868 Returns an array of hashes representing the customer's RT tickets.
3875 my $num = $conf->config('cust_main-max_tickets') || 10;
3878 if ( $conf->config('ticket_system') ) {
3879 unless ( $conf->config('ticket_system-custom_priority_field') ) {
3881 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
3885 foreach my $priority (
3886 $conf->config('ticket_system-custom_priority_field-values'), ''
3888 last if scalar(@tickets) >= $num;
3890 @{ FS::TicketSystem->customer_tickets( $self->custnum,
3891 $num - scalar(@tickets),
3901 # Return services representing svc_accts in customer support packages
3902 sub support_services {
3904 my %packages = map { $_ => 1 } $conf->config('support_packages');
3906 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
3907 grep { $_->part_svc->svcdb eq 'svc_acct' }
3908 map { $_->cust_svc }
3909 grep { exists $packages{ $_->pkgpart } }
3910 $self->ncancelled_pkgs;
3914 # Return a list of latitude/longitude for one of the services (if any)
3915 sub service_coordinates {
3919 grep { $_->latitude && $_->longitude }
3921 map { $_->cust_svc }
3922 $self->ncancelled_pkgs;
3924 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
3929 Returns a masked version of the named field
3934 my ($self,$field) = @_;
3938 'x'x(length($self->getfield($field))-4).
3939 substr($self->getfield($field), (length($self->getfield($field))-4));
3945 =head1 CLASS METHODS
3951 Class method that returns the list of possible status strings for customers
3952 (see L<the status method|/status>). For example:
3954 @statuses = FS::cust_main->statuses();
3960 keys %{ $self->statuscolors };
3963 =item cust_status_sql
3965 Returns an SQL fragment to determine the status of a cust_main record, as a
3970 sub cust_status_sql {
3972 for my $status ( FS::cust_main->statuses() ) {
3973 my $method = $status.'_sql';
3974 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
3983 Returns an SQL expression identifying prospective cust_main records (customers
3984 with no packages ever ordered)
3988 use vars qw($select_count_pkgs);
3989 $select_count_pkgs =
3990 "SELECT COUNT(*) FROM cust_pkg
3991 WHERE cust_pkg.custnum = cust_main.custnum";
3993 sub select_count_pkgs_sql {
3998 " 0 = ( $select_count_pkgs ) ";
4003 Returns an SQL expression identifying ordered cust_main records (customers with
4004 no active packages, but recurring packages not yet setup or one time charges
4010 FS::cust_main->none_active_sql.
4011 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4016 Returns an SQL expression identifying active cust_main records (customers with
4017 active recurring packages).
4022 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4025 =item none_active_sql
4027 Returns an SQL expression identifying cust_main records with no active
4028 recurring packages. This includes customers of status prospect, ordered,
4029 inactive, and suspended.
4033 sub none_active_sql {
4034 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4039 Returns an SQL expression identifying inactive cust_main records (customers with
4040 no active recurring packages, but otherwise unsuspended/uncancelled).
4045 FS::cust_main->none_active_sql.
4046 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4052 Returns an SQL expression identifying suspended cust_main records.
4057 sub suspended_sql { susp_sql(@_); }
4059 FS::cust_main->none_active_sql.
4060 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4066 Returns an SQL expression identifying cancelled cust_main records.
4070 sub cancel_sql { shift->cancelled_sql(@_); }
4073 =item uncancelled_sql
4075 Returns an SQL expression identifying un-cancelled cust_main records.
4079 sub uncancelled_sql { uncancel_sql(@_); }
4080 sub uncancel_sql { "
4081 ( 0 < ( $select_count_pkgs
4082 AND ( cust_pkg.cancel IS NULL
4083 OR cust_pkg.cancel = 0
4086 OR 0 = ( $select_count_pkgs )
4092 Returns an SQL fragment to retreive the balance.
4097 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4098 WHERE cust_bill.custnum = cust_main.custnum )
4099 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4100 WHERE cust_pay.custnum = cust_main.custnum )
4101 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4102 WHERE cust_credit.custnum = cust_main.custnum )
4103 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4104 WHERE cust_refund.custnum = cust_main.custnum )
4107 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4109 Returns an SQL fragment to retreive the balance for this customer, optionally
4110 considering invoices with date earlier than START_TIME, and not
4111 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4112 total_unapplied_payments).
4114 Times are specified as SQL fragments or numeric
4115 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4116 L<Date::Parse> for conversion functions. The empty string can be passed
4117 to disable that time constraint completely.
4119 Available options are:
4123 =item unapplied_date
4125 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)
4130 set to true to remove all customer comparison clauses, for totals
4135 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4140 JOIN clause (typically used with the total option)
4144 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4145 time will be ignored. Note that START_TIME and END_TIME only limit the date
4146 range for invoices and I<unapplied> payments, credits, and refunds.
4152 sub balance_date_sql {
4153 my( $class, $start, $end, %opt ) = @_;
4155 my $cutoff = $opt{'cutoff'};
4157 my $owed = FS::cust_bill->owed_sql($cutoff);
4158 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4159 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4160 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4162 my $j = $opt{'join'} || '';
4164 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4165 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4166 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4167 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4169 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4170 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4171 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4172 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4177 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4179 Returns an SQL fragment to retreive the total unapplied payments for this
4180 customer, only considering invoices with date earlier than START_TIME, and
4181 optionally not later than END_TIME.
4183 Times are specified as SQL fragments or numeric
4184 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4185 L<Date::Parse> for conversion functions. The empty string can be passed
4186 to disable that time constraint completely.
4188 Available options are:
4192 sub unapplied_payments_date_sql {
4193 my( $class, $start, $end, %opt ) = @_;
4195 my $cutoff = $opt{'cutoff'};
4197 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4199 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4200 'unapplied_date'=>1 );
4202 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4205 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4207 Helper method for balance_date_sql; name (and usage) subject to change
4208 (suggestions welcome).
4210 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4211 cust_refund, cust_credit or cust_pay).
4213 If TABLE is "cust_bill" or the unapplied_date option is true, only
4214 considers records with date earlier than START_TIME, and optionally not
4215 later than END_TIME .
4219 sub _money_table_where {
4220 my( $class, $table, $start, $end, %opt ) = @_;
4223 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4224 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4225 push @where, "$table._date <= $start" if defined($start) && length($start);
4226 push @where, "$table._date > $end" if defined($end) && length($end);
4228 push @where, @{$opt{'where'}} if $opt{'where'};
4229 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4235 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4236 use FS::cust_main::Search;
4239 FS::cust_main::Search->search(@_);
4248 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
4252 use FS::cust_main::Search;
4253 sub append_fuzzyfiles {
4254 #my( $first, $last, $company ) = @_;
4256 FS::cust_main::Search::check_and_rebuild_fuzzyfiles();
4258 use Fcntl qw(:flock);
4260 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
4262 foreach my $field (@fuzzyfields) {
4267 open(CACHE,">>$dir/cust_main.$field")
4268 or die "can't open $dir/cust_main.$field: $!";
4269 flock(CACHE,LOCK_EX)
4270 or die "can't lock $dir/cust_main.$field: $!";
4272 print CACHE "$value\n";
4274 flock(CACHE,LOCK_UN)
4275 or die "can't unlock $dir/cust_main.$field: $!";
4290 #warn join('-',keys %$param);
4291 my $fh = $param->{filehandle};
4292 my $agentnum = $param->{agentnum};
4293 my $format = $param->{format};
4295 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4298 if ( $format eq 'simple' ) {
4299 @fields = qw( custnum agent_custid amount pkg );
4301 die "unknown format $format";
4304 eval "use Text::CSV_XS;";
4307 my $csv = new Text::CSV_XS;
4314 local $SIG{HUP} = 'IGNORE';
4315 local $SIG{INT} = 'IGNORE';
4316 local $SIG{QUIT} = 'IGNORE';
4317 local $SIG{TERM} = 'IGNORE';
4318 local $SIG{TSTP} = 'IGNORE';
4319 local $SIG{PIPE} = 'IGNORE';
4321 my $oldAutoCommit = $FS::UID::AutoCommit;
4322 local $FS::UID::AutoCommit = 0;
4325 #while ( $columns = $csv->getline($fh) ) {
4327 while ( defined($line=<$fh>) ) {
4329 $csv->parse($line) or do {
4330 $dbh->rollback if $oldAutoCommit;
4331 return "can't parse: ". $csv->error_input();
4334 my @columns = $csv->fields();
4335 #warn join('-',@columns);
4338 foreach my $field ( @fields ) {
4339 $row{$field} = shift @columns;
4342 if ( $row{custnum} && $row{agent_custid} ) {
4343 dbh->rollback if $oldAutoCommit;
4344 return "can't specify custnum with agent_custid $row{agent_custid}";
4348 if ( $row{agent_custid} && $agentnum ) {
4349 %hash = ( 'agent_custid' => $row{agent_custid},
4350 'agentnum' => $agentnum,
4354 if ( $row{custnum} ) {
4355 %hash = ( 'custnum' => $row{custnum} );
4358 unless ( scalar(keys %hash) ) {
4359 $dbh->rollback if $oldAutoCommit;
4360 return "can't find customer without custnum or agent_custid and agentnum";
4363 my $cust_main = qsearchs('cust_main', { %hash } );
4364 unless ( $cust_main ) {
4365 $dbh->rollback if $oldAutoCommit;
4366 my $custnum = $row{custnum} || $row{agent_custid};
4367 return "unknown custnum $custnum";
4370 if ( $row{'amount'} > 0 ) {
4371 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4373 $dbh->rollback if $oldAutoCommit;
4377 } elsif ( $row{'amount'} < 0 ) {
4378 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4381 $dbh->rollback if $oldAutoCommit;
4391 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4393 return "Empty file!" unless $imported;
4399 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4401 Deprecated. Use event notification and message templates
4402 (L<FS::msg_template>) instead.
4404 Sends a templated email notification to the customer (see L<Text::Template>).
4406 OPTIONS is a hash and may include
4408 I<from> - the email sender (default is invoice_from)
4410 I<to> - comma-separated scalar or arrayref of recipients
4411 (default is invoicing_list)
4413 I<subject> - The subject line of the sent email notification
4414 (default is "Notice from company_name")
4416 I<extra_fields> - a hashref of name/value pairs which will be substituted
4419 The following variables are vavailable in the template.
4421 I<$first> - the customer first name
4422 I<$last> - the customer last name
4423 I<$company> - the customer company
4424 I<$payby> - a description of the method of payment for the customer
4425 # would be nice to use FS::payby::shortname
4426 I<$payinfo> - the account information used to collect for this customer
4427 I<$expdate> - the expiration of the customer payment in seconds from epoch
4432 my ($self, $template, %options) = @_;
4434 return unless $conf->exists($template);
4436 my $from = $conf->config('invoice_from', $self->agentnum)
4437 if $conf->exists('invoice_from', $self->agentnum);
4438 $from = $options{from} if exists($options{from});
4440 my $to = join(',', $self->invoicing_list_emailonly);
4441 $to = $options{to} if exists($options{to});
4443 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4444 if $conf->exists('company_name', $self->agentnum);
4445 $subject = $options{subject} if exists($options{subject});
4447 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4448 SOURCE => [ map "$_\n",
4449 $conf->config($template)]
4451 or die "can't create new Text::Template object: Text::Template::ERROR";
4452 $notify_template->compile()
4453 or die "can't compile template: Text::Template::ERROR";
4455 $FS::notify_template::_template::company_name =
4456 $conf->config('company_name', $self->agentnum);
4457 $FS::notify_template::_template::company_address =
4458 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4460 my $paydate = $self->paydate || '2037-12-31';
4461 $FS::notify_template::_template::first = $self->first;
4462 $FS::notify_template::_template::last = $self->last;
4463 $FS::notify_template::_template::company = $self->company;
4464 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4465 my $payby = $self->payby;
4466 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4467 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4469 #credit cards expire at the end of the month/year of their exp date
4470 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4471 $FS::notify_template::_template::payby = 'credit card';
4472 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4473 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4475 }elsif ($payby eq 'COMP') {
4476 $FS::notify_template::_template::payby = 'complimentary account';
4478 $FS::notify_template::_template::payby = 'current method';
4480 $FS::notify_template::_template::expdate = $expire_time;
4482 for (keys %{$options{extra_fields}}){
4484 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4487 send_email(from => $from,
4489 subject => $subject,
4490 body => $notify_template->fill_in( PACKAGE =>
4491 'FS::notify_template::_template' ),
4496 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4498 Generates a templated notification to the customer (see L<Text::Template>).
4500 OPTIONS is a hash and may include
4502 I<extra_fields> - a hashref of name/value pairs which will be substituted
4503 into the template. These values may override values mentioned below
4504 and those from the customer record.
4506 The following variables are available in the template instead of or in addition
4507 to the fields of the customer record.
4509 I<$payby> - a description of the method of payment for the customer
4510 # would be nice to use FS::payby::shortname
4511 I<$payinfo> - the masked account information used to collect for this customer
4512 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4513 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4517 # a lot like cust_bill::print_latex
4518 sub generate_letter {
4519 my ($self, $template, %options) = @_;
4521 return unless $conf->exists($template);
4523 my $letter_template = new Text::Template
4525 SOURCE => [ map "$_\n", $conf->config($template)],
4526 DELIMITERS => [ '[@--', '--@]' ],
4528 or die "can't create new Text::Template object: Text::Template::ERROR";
4530 $letter_template->compile()
4531 or die "can't compile template: Text::Template::ERROR";
4533 my %letter_data = map { $_ => $self->$_ } $self->fields;
4534 $letter_data{payinfo} = $self->mask_payinfo;
4536 #my $paydate = $self->paydate || '2037-12-31';
4537 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4539 my $payby = $self->payby;
4540 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4541 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4543 #credit cards expire at the end of the month/year of their exp date
4544 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4545 $letter_data{payby} = 'credit card';
4546 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4547 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4549 }elsif ($payby eq 'COMP') {
4550 $letter_data{payby} = 'complimentary account';
4552 $letter_data{payby} = 'current method';
4554 $letter_data{expdate} = $expire_time;
4556 for (keys %{$options{extra_fields}}){
4557 $letter_data{$_} = $options{extra_fields}->{$_};
4560 unless(exists($letter_data{returnaddress})){
4561 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4562 $self->agent_template)
4564 if ( length($retadd) ) {
4565 $letter_data{returnaddress} = $retadd;
4566 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4567 $letter_data{returnaddress} =
4568 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4572 ( $conf->config('company_name', $self->agentnum),
4573 $conf->config('company_address', $self->agentnum),
4577 $letter_data{returnaddress} = '~';
4581 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4583 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4585 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4587 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4591 ) or die "can't open temp file: $!\n";
4592 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4593 or die "can't write temp file: $!\n";
4595 $letter_data{'logo_file'} = $lh->filename;
4597 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4601 ) or die "can't open temp file: $!\n";
4603 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4605 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4606 return ($1, $letter_data{'logo_file'});
4610 =item print_ps TEMPLATE
4612 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4618 my($file, $lfile) = $self->generate_letter(@_);
4619 my $ps = FS::Misc::generate_ps($file);
4620 unlink($file.'.tex');
4626 =item print TEMPLATE
4628 Prints the filled in template.
4630 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4634 sub queueable_print {
4637 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4638 or die "invalid customer number: " . $opt{custvnum};
4640 my $error = $self->print( $opt{template} );
4641 die $error if $error;
4645 my ($self, $template) = (shift, shift);
4646 do_print [ $self->print_ps($template) ];
4649 #these three subs should just go away once agent stuff is all config overrides
4651 sub agent_template {
4653 $self->_agent_plandata('agent_templatename');
4656 sub agent_invoice_from {
4658 $self->_agent_plandata('agent_invoice_from');
4661 sub _agent_plandata {
4662 my( $self, $option ) = @_;
4664 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4665 #agent-specific Conf
4667 use FS::part_event::Condition;
4669 my $agentnum = $self->agentnum;
4671 my $regexp = regexp_sql();
4673 my $part_event_option =
4675 'select' => 'part_event_option.*',
4676 'table' => 'part_event_option',
4678 LEFT JOIN part_event USING ( eventpart )
4679 LEFT JOIN part_event_option AS peo_agentnum
4680 ON ( part_event.eventpart = peo_agentnum.eventpart
4681 AND peo_agentnum.optionname = 'agentnum'
4682 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4684 LEFT JOIN part_event_condition
4685 ON ( part_event.eventpart = part_event_condition.eventpart
4686 AND part_event_condition.conditionname = 'cust_bill_age'
4688 LEFT JOIN part_event_condition_option
4689 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4690 AND part_event_condition_option.optionname = 'age'
4693 #'hashref' => { 'optionname' => $option },
4694 #'hashref' => { 'part_event_option.optionname' => $option },
4696 " WHERE part_event_option.optionname = ". dbh->quote($option).
4697 " AND action = 'cust_bill_send_agent' ".
4698 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4699 " AND peo_agentnum.optionname = 'agentnum' ".
4700 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4702 CASE WHEN part_event_condition_option.optionname IS NULL
4704 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4706 , part_event.weight".
4710 unless ( $part_event_option ) {
4711 return $self->agent->invoice_template || ''
4712 if $option eq 'agent_templatename';
4716 $part_event_option->optionvalue;
4720 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4722 Subroutine (not a method), designed to be called from the queue.
4724 Takes a list of options and values.
4726 Pulls up the customer record via the custnum option and calls bill_and_collect.
4731 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4733 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4734 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4736 $cust_main->bill_and_collect( %args );
4739 sub process_bill_and_collect {
4741 my $param = thaw(decode_base64(shift));
4742 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4743 or die "custnum '$param->{custnum}' not found!\n";
4744 $param->{'job'} = $job;
4745 $param->{'fatal'} = 1; # runs from job queue, will be caught
4746 $param->{'retry'} = 1;
4748 $cust_main->bill_and_collect( %$param );
4751 sub _upgrade_data { #class method
4752 my ($class, %opts) = @_;
4755 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
4756 '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',
4758 # fix yyyy-m-dd formatted paydates
4759 if ( driver_name =~ /^mysql$/i ) {
4761 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4763 else { # the SQL standard
4765 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4768 foreach my $sql ( @statements ) {
4769 my $sth = dbh->prepare($sql) or die dbh->errstr;
4770 $sth->execute or die $sth->errstr;
4773 local($ignore_expired_card) = 1;
4774 local($ignore_illegal_zip) = 1;
4775 local($ignore_banned_card) = 1;
4776 local($skip_fuzzyfiles) = 1;
4777 $class->_upgrade_otaker(%opts);
4787 The delete method should possibly take an FS::cust_main object reference
4788 instead of a scalar customer number.
4790 Bill and collect options should probably be passed as references instead of a
4793 There should probably be a configuration file with a list of allowed credit
4796 No multiple currency support (probably a larger project than just this module).
4798 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
4800 Birthdates rely on negative epoch values.
4802 The payby for card/check batches is broken. With mixed batching, bad
4805 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
4809 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
4810 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
4811 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.