5 use base qw( FS::cust_main::Packages FS::cust_main::Status
6 FS::cust_main::NationalID
7 FS::cust_main::Billing FS::cust_main::Billing_Realtime
8 FS::cust_main::Billing_Discount
9 FS::cust_main::Billing_ThirdParty
10 FS::cust_main::Location
11 FS::cust_main::Credit_Limit
12 FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
13 FS::geocode_Mixin FS::Quotable_Mixin FS::Sales_Mixin
17 use vars qw( $DEBUG $me $conf $default_agent_custid $custnum_display_length
20 $ignore_expired_card $ignore_banned_card $ignore_illegal_zip
25 use Scalar::Util qw( blessed );
26 use Time::Local qw(timelocal);
27 use Storable qw(thaw);
31 use Digest::MD5 qw(md5_base64);
34 use File::Temp; #qw( tempfile );
36 use Business::CreditCard 0.28;
37 use FS::UID qw( getotaker dbh driver_name );
38 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
39 use FS::Misc qw( generate_email send_email generate_ps do_print money_pretty card_types );
40 use FS::Msgcat qw(gettext);
47 use FS::cust_bill_void;
48 use FS::legacy_cust_bill;
50 use FS::cust_pay_pending;
51 use FS::cust_pay_void;
52 use FS::cust_pay_batch;
55 use FS::part_referral;
56 use FS::cust_main_county;
57 use FS::cust_location;
59 use FS::cust_main_exemption;
60 use FS::cust_tax_adjustment;
61 use FS::cust_tax_location;
63 use FS::cust_main_invoice;
65 use FS::prepay_credit;
71 use FS::payment_gateway;
72 use FS::agent_payment_gateway;
74 use FS::cust_main_note;
75 use FS::cust_attachment;
78 use FS::upgrade_journal;
81 # 1 is mostly method/subroutine entry and options
82 # 2 traces progress of some operations
83 # 3 is even more information including possibly sensitive data
85 $me = '[FS::cust_main]';
88 $ignore_expired_card = 0;
89 $ignore_banned_card = 0;
93 @encrypted_fields = ('payinfo', 'paycvv');
94 sub nohistory_fields { ('payinfo', 'paycvv'); }
96 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
98 #ask FS::UID to run this stuff for us later
99 #$FS::UID::callback{'FS::cust_main'} = sub {
100 install_callback FS::UID sub {
101 $conf = new FS::Conf;
102 $default_agent_custid = $conf->exists('cust_main-default_agent_custid');
103 $custnum_display_length = $conf->config('cust_main-custnum-display_length');
108 my ( $hashref, $cache ) = @_;
109 if ( exists $hashref->{'pkgnum'} ) {
110 #@{ $self->{'_pkgnum'} } = ();
111 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
112 $self->{'_pkgnum'} = $subcache;
113 #push @{ $self->{'_pkgnum'} },
114 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
120 FS::cust_main - Object methods for cust_main records
126 $record = new FS::cust_main \%hash;
127 $record = new FS::cust_main { 'column' => 'value' };
129 $error = $record->insert;
131 $error = $new_record->replace($old_record);
133 $error = $record->delete;
135 $error = $record->check;
137 @cust_pkg = $record->all_pkgs;
139 @cust_pkg = $record->ncancelled_pkgs;
141 @cust_pkg = $record->suspended_pkgs;
143 $error = $record->bill;
144 $error = $record->bill %options;
145 $error = $record->bill 'time' => $time;
147 $error = $record->collect;
148 $error = $record->collect %options;
149 $error = $record->collect 'invoice_time' => $time,
154 An FS::cust_main object represents a customer. FS::cust_main inherits from
155 FS::Record. The following fields are currently supported:
161 Primary key (assigned automatically for new customers)
165 Agent (see L<FS::agent>)
169 Advertising source (see L<FS::part_referral>)
181 Cocial security number (optional)
205 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
209 Payment Information (See L<FS::payinfo_Mixin> for data format)
213 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
217 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
221 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
225 Start date month (maestro/solo cards only)
229 Start date year (maestro/solo cards only)
233 Issue number (maestro/solo cards only)
237 Name on card or billing name
241 IP address from which payment information was received
245 The credit card type (deduced from the card number).
249 Tax exempt, empty or `Y'
253 Order taker (see L<FS::access_user>)
259 =item referral_custnum
261 Referring customer number
265 Enable individual CDR spooling, empty or `Y'
269 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
273 Discourage individual CDR printing, empty or `Y'
277 Allow self-service editing of ticket subjects, empty or 'Y'
279 =item calling_list_exempt
281 Do not call, empty or 'Y'
283 =item invoice_ship_address
285 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
295 Creates a new customer. To add the customer to the database, see L<"insert">.
297 Note that this stores the hash reference, not a distinct copy of the hash it
298 points to. You can ask the object for a copy with the I<hash> method.
302 sub table { 'cust_main'; }
304 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
306 Adds this customer to the database. If there is an error, returns the error,
307 otherwise returns false.
309 Usually the customer's location will not yet exist in the database, and
310 the C<bill_location> and C<ship_location> pseudo-fields must be set to
311 uninserted L<FS::cust_location> objects. These will be inserted and linked
312 (in both directions) to the new customer record. If they're references
313 to the same object, they will become the same location.
315 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
316 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
317 are inserted atomicly, or the transaction is rolled back. Passing an empty
318 hash reference is equivalent to not supplying this parameter. There should be
319 a better explanation of this, but until then, here's an example:
322 tie %hash, 'Tie::RefHash'; #this part is important
324 $cust_pkg => [ $svc_acct ],
327 $cust_main->insert( \%hash );
329 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
330 be set as the invoicing list (see L<"invoicing_list">). Errors return as
331 expected and rollback the entire transaction; it is not necessary to call
332 check_invoicing_list first. The invoicing_list is set after the records in the
333 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
334 invoicing_list destination to the newly-created svc_acct. Here's an example:
336 $cust_main->insert( {}, [ $email, 'POST' ] );
338 Currently available options are: I<depend_jobnum>, I<noexport>,
339 I<tax_exemption> and I<prospectnum>.
341 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
342 on the supplied jobnum (they will not run until the specific job completes).
343 This can be used to defer provisioning until some action completes (such
344 as running the customer's credit card successfully).
346 The I<noexport> option is deprecated. If I<noexport> is set true, no
347 provisioning jobs (exports) are scheduled. (You can schedule them later with
348 the B<reexport> method.)
350 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
351 of tax names and exemption numbers. FS::cust_main_exemption records will be
352 created and inserted.
354 If I<prospectnum> is set, moves contacts and locations from that prospect.
360 my $cust_pkgs = @_ ? shift : {};
361 my $invoicing_list = @_ ? shift : '';
363 warn "$me insert called with options ".
364 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
367 local $SIG{HUP} = 'IGNORE';
368 local $SIG{INT} = 'IGNORE';
369 local $SIG{QUIT} = 'IGNORE';
370 local $SIG{TERM} = 'IGNORE';
371 local $SIG{TSTP} = 'IGNORE';
372 local $SIG{PIPE} = 'IGNORE';
374 my $oldAutoCommit = $FS::UID::AutoCommit;
375 local $FS::UID::AutoCommit = 0;
378 my $prepay_identifier = '';
379 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
381 if ( $self->payby eq 'PREPAY' ) {
383 $self->payby('BILL');
384 $prepay_identifier = $self->payinfo;
387 warn " looking up prepaid card $prepay_identifier\n"
390 my $error = $self->get_prepay( $prepay_identifier,
391 'amount_ref' => \$amount,
392 'seconds_ref' => \$seconds,
393 'upbytes_ref' => \$upbytes,
394 'downbytes_ref' => \$downbytes,
395 'totalbytes_ref' => \$totalbytes,
398 $dbh->rollback if $oldAutoCommit;
399 #return "error applying prepaid card (transaction rolled back): $error";
403 $payby = 'PREP' if $amount;
405 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
408 $self->payby('BILL');
409 $amount = $self->paid;
414 foreach my $l (qw(bill_location ship_location)) {
416 my $loc = delete $self->hashref->{$l} or return "$l not set";
418 if ( !$loc->locationnum ) {
419 # warn the location that we're going to insert it with no custnum
420 $loc->set(custnum_pending => 1);
421 warn " inserting $l\n"
423 my $error = $loc->insert;
425 $dbh->rollback if $oldAutoCommit;
426 my $label = $l eq 'ship_location' ? 'service' : 'billing';
427 return "$error (in $label location)";
430 } elsif ( $loc->prospectnum ) {
432 $loc->prospectnum('');
433 $loc->set(custnum_pending => 1);
434 my $error = $loc->replace;
436 $dbh->rollback if $oldAutoCommit;
437 my $label = $l eq 'ship_location' ? 'service' : 'billing';
438 return "$error (moving $label location)";
441 } elsif ( ($loc->custnum || 0) > 0 ) {
442 # then it somehow belongs to another customer--shouldn't happen
443 $dbh->rollback if $oldAutoCommit;
444 return "$l belongs to customer ".$loc->custnum;
446 # else it already belongs to this customer
447 # (happens when ship_location is identical to bill_location)
449 $self->set($l.'num', $loc->locationnum);
451 if ( $self->get($l.'num') eq '' ) {
452 $dbh->rollback if $oldAutoCommit;
457 warn " inserting $self\n"
460 $self->signupdate(time) unless $self->signupdate;
462 $self->auto_agent_custid()
463 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
465 my $error = $self->check_payinfo_cardtype
466 || $self->SUPER::insert;
468 $dbh->rollback if $oldAutoCommit;
469 #return "inserting cust_main record (transaction rolled back): $error";
473 # now set cust_location.custnum
474 foreach my $l (qw(bill_location ship_location)) {
475 warn " setting $l.custnum\n"
478 unless ( $loc->custnum ) {
479 $loc->set(custnum => $self->custnum);
480 $error ||= $loc->replace;
484 $dbh->rollback if $oldAutoCommit;
485 return "error setting $l custnum: $error";
489 warn " setting invoicing list\n"
492 if ( $invoicing_list ) {
493 $error = $self->check_invoicing_list( $invoicing_list );
495 $dbh->rollback if $oldAutoCommit;
496 #return "checking invoicing_list (transaction rolled back): $error";
499 $self->invoicing_list( $invoicing_list );
502 warn " setting customer tags\n"
505 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
506 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
507 'custnum' => $self->custnum };
508 my $error = $cust_tag->insert;
510 $dbh->rollback if $oldAutoCommit;
515 my $prospectnum = delete $options{'prospectnum'};
516 if ( $prospectnum ) {
518 warn " moving contacts and locations from prospect $prospectnum\n"
522 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
523 unless ( $prospect_main ) {
524 $dbh->rollback if $oldAutoCommit;
525 return "Unknown prospectnum $prospectnum";
527 $prospect_main->custnum($self->custnum);
528 $prospect_main->disabled('Y');
529 my $error = $prospect_main->replace;
531 $dbh->rollback if $oldAutoCommit;
535 my @contact = $prospect_main->contact;
536 my @cust_location = $prospect_main->cust_location;
537 my @qual = $prospect_main->qual;
539 foreach my $r ( @contact, @cust_location, @qual ) {
541 $r->custnum($self->custnum);
542 my $error = $r->replace;
544 $dbh->rollback if $oldAutoCommit;
551 # validate card (needs custnum already set)
552 if ( $self->payby =~ /^(CARD|DCRD)$/
553 && $conf->exists('business-onlinepayment-verification') ) {
554 $error = $self->realtime_verify_bop({ 'method'=>'CC' });
556 $dbh->rollback if $oldAutoCommit;
561 warn " setting contacts\n"
564 if ( my $contact = delete $options{'contact'} ) {
566 foreach my $c ( @$contact ) {
567 $c->custnum($self->custnum);
568 my $error = $c->insert;
570 $dbh->rollback if $oldAutoCommit;
576 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
578 my $error = $self->process_o2m( 'table' => 'contact',
579 'fields' => FS::contact->cgi_contact_fields,
580 'params' => $contact_params,
583 $dbh->rollback if $oldAutoCommit;
588 warn " setting cust_main_exemption\n"
591 my $tax_exemption = delete $options{'tax_exemption'};
592 if ( $tax_exemption ) {
594 $tax_exemption = { map { $_ => '' } @$tax_exemption }
595 if ref($tax_exemption) eq 'ARRAY';
597 foreach my $taxname ( keys %$tax_exemption ) {
598 my $cust_main_exemption = new FS::cust_main_exemption {
599 'custnum' => $self->custnum,
600 'taxname' => $taxname,
601 'exempt_number' => $tax_exemption->{$taxname},
603 my $error = $cust_main_exemption->insert;
605 $dbh->rollback if $oldAutoCommit;
606 return "inserting cust_main_exemption (transaction rolled back): $error";
611 warn " ordering packages\n"
614 $error = $self->order_pkgs( $cust_pkgs,
616 'seconds_ref' => \$seconds,
617 'upbytes_ref' => \$upbytes,
618 'downbytes_ref' => \$downbytes,
619 'totalbytes_ref' => \$totalbytes,
622 $dbh->rollback if $oldAutoCommit;
627 $dbh->rollback if $oldAutoCommit;
628 return "No svc_acct record to apply pre-paid time";
630 if ( $upbytes || $downbytes || $totalbytes ) {
631 $dbh->rollback if $oldAutoCommit;
632 return "No svc_acct record to apply pre-paid data";
636 warn " inserting initial $payby payment of $amount\n"
638 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
640 $dbh->rollback if $oldAutoCommit;
641 return "inserting payment (transaction rolled back): $error";
645 unless ( $import || $skip_fuzzyfiles ) {
646 warn " queueing fuzzyfiles update\n"
648 $error = $self->queue_fuzzyfiles_update;
650 $dbh->rollback if $oldAutoCommit;
651 return "updating fuzzy search cache: $error";
655 # FS::geocode_Mixin::after_insert or something?
656 if ( $conf->config('tax_district_method') and !$import ) {
657 # if anything non-empty, try to look it up
658 my $queue = new FS::queue {
659 'job' => 'FS::geocode_Mixin::process_district_update',
660 'custnum' => $self->custnum,
662 my $error = $queue->insert( ref($self), $self->custnum );
664 $dbh->rollback if $oldAutoCommit;
665 return "queueing tax district update: $error";
670 warn " exporting\n" if $DEBUG > 1;
672 my $export_args = $options{'export_args'} || [];
675 map qsearch( 'part_export', {exportnum=>$_} ),
676 $conf->config('cust_main-exports'); #, $agentnum
678 foreach my $part_export ( @part_export ) {
679 my $error = $part_export->export_insert($self, @$export_args);
681 $dbh->rollback if $oldAutoCommit;
682 return "exporting to ". $part_export->exporttype.
683 " (transaction rolled back): $error";
687 #foreach my $depend_jobnum ( @$depend_jobnums ) {
688 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
690 # foreach my $jobnum ( @jobnums ) {
691 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
692 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
694 # my $error = $queue->depend_insert($depend_jobnum);
696 # $dbh->rollback if $oldAutoCommit;
697 # return "error queuing job dependancy: $error";
704 #if ( exists $options{'jobnums'} ) {
705 # push @{ $options{'jobnums'} }, @jobnums;
708 warn " insert complete; committing transaction\n"
711 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
716 use File::CounterFile;
717 sub auto_agent_custid {
720 my $format = $conf->config('cust_main-auto_agent_custid');
722 if ( $format eq '1YMMXXXXXXXX' ) {
724 my $counter = new File::CounterFile 'cust_main.agent_custid';
727 my $ym = 100000000000 + time2str('%y%m00000000', time);
728 if ( $ym > $counter->value ) {
729 $counter->{'value'} = $agent_custid = $ym;
730 $counter->{'updated'} = 1;
732 $agent_custid = $counter->inc;
738 die "Unknown cust_main-auto_agent_custid format: $format";
741 $self->agent_custid($agent_custid);
745 =item PACKAGE METHODS
747 Documentation on customer package methods has been moved to
748 L<FS::cust_main::Packages>.
750 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
752 Recharges this (existing) customer with the specified prepaid card (see
753 L<FS::prepay_credit>), specified either by I<identifier> or as an
754 FS::prepay_credit object. If there is an error, returns the error, otherwise
757 Optionally, five scalar references can be passed as well. They will have their
758 values filled in with the amount, number of seconds, and number of upload,
759 download, and total bytes applied by this prepaid card.
763 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
764 #the only place that uses these args
765 sub recharge_prepay {
766 my( $self, $prepay_credit, $amountref, $secondsref,
767 $upbytesref, $downbytesref, $totalbytesref ) = @_;
769 local $SIG{HUP} = 'IGNORE';
770 local $SIG{INT} = 'IGNORE';
771 local $SIG{QUIT} = 'IGNORE';
772 local $SIG{TERM} = 'IGNORE';
773 local $SIG{TSTP} = 'IGNORE';
774 local $SIG{PIPE} = 'IGNORE';
776 my $oldAutoCommit = $FS::UID::AutoCommit;
777 local $FS::UID::AutoCommit = 0;
780 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
782 my $error = $self->get_prepay( $prepay_credit,
783 'amount_ref' => \$amount,
784 'seconds_ref' => \$seconds,
785 'upbytes_ref' => \$upbytes,
786 'downbytes_ref' => \$downbytes,
787 'totalbytes_ref' => \$totalbytes,
789 || $self->increment_seconds($seconds)
790 || $self->increment_upbytes($upbytes)
791 || $self->increment_downbytes($downbytes)
792 || $self->increment_totalbytes($totalbytes)
793 || $self->insert_cust_pay_prepay( $amount,
795 ? $prepay_credit->identifier
800 $dbh->rollback if $oldAutoCommit;
804 if ( defined($amountref) ) { $$amountref = $amount; }
805 if ( defined($secondsref) ) { $$secondsref = $seconds; }
806 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
807 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
808 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
810 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
815 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
817 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
818 specified either by I<identifier> or as an FS::prepay_credit object.
820 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
821 incremented by the values of the prepaid card.
823 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
824 check or set this customer's I<agentnum>.
826 If there is an error, returns the error, otherwise returns false.
832 my( $self, $prepay_credit, %opt ) = @_;
834 local $SIG{HUP} = 'IGNORE';
835 local $SIG{INT} = 'IGNORE';
836 local $SIG{QUIT} = 'IGNORE';
837 local $SIG{TERM} = 'IGNORE';
838 local $SIG{TSTP} = 'IGNORE';
839 local $SIG{PIPE} = 'IGNORE';
841 my $oldAutoCommit = $FS::UID::AutoCommit;
842 local $FS::UID::AutoCommit = 0;
845 unless ( ref($prepay_credit) ) {
847 my $identifier = $prepay_credit;
849 $prepay_credit = qsearchs(
851 { 'identifier' => $identifier },
856 unless ( $prepay_credit ) {
857 $dbh->rollback if $oldAutoCommit;
858 return "Invalid prepaid card: ". $identifier;
863 if ( $prepay_credit->agentnum ) {
864 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
865 $dbh->rollback if $oldAutoCommit;
866 return "prepaid card not valid for agent ". $self->agentnum;
868 $self->agentnum($prepay_credit->agentnum);
871 my $error = $prepay_credit->delete;
873 $dbh->rollback if $oldAutoCommit;
874 return "removing prepay_credit (transaction rolled back): $error";
877 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
878 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
880 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
885 =item increment_upbytes SECONDS
887 Updates this customer's single or primary account (see L<FS::svc_acct>) by
888 the specified number of upbytes. If there is an error, returns the error,
889 otherwise returns false.
893 sub increment_upbytes {
894 _increment_column( shift, 'upbytes', @_);
897 =item increment_downbytes SECONDS
899 Updates this customer's single or primary account (see L<FS::svc_acct>) by
900 the specified number of downbytes. If there is an error, returns the error,
901 otherwise returns false.
905 sub increment_downbytes {
906 _increment_column( shift, 'downbytes', @_);
909 =item increment_totalbytes SECONDS
911 Updates this customer's single or primary account (see L<FS::svc_acct>) by
912 the specified number of totalbytes. If there is an error, returns the error,
913 otherwise returns false.
917 sub increment_totalbytes {
918 _increment_column( shift, 'totalbytes', @_);
921 =item increment_seconds SECONDS
923 Updates this customer's single or primary account (see L<FS::svc_acct>) by
924 the specified number of seconds. If there is an error, returns the error,
925 otherwise returns false.
929 sub increment_seconds {
930 _increment_column( shift, 'seconds', @_);
933 =item _increment_column AMOUNT
935 Updates this customer's single or primary account (see L<FS::svc_acct>) by
936 the specified number of seconds or bytes. If there is an error, returns
937 the error, otherwise returns false.
941 sub _increment_column {
942 my( $self, $column, $amount ) = @_;
943 warn "$me increment_column called: $column, $amount\n"
946 return '' unless $amount;
948 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
949 $self->ncancelled_pkgs;
952 return 'No packages with primary or single services found'.
953 ' to apply pre-paid time';
954 } elsif ( scalar(@cust_pkg) > 1 ) {
955 #maybe have a way to specify the package/account?
956 return 'Multiple packages found to apply pre-paid time';
959 my $cust_pkg = $cust_pkg[0];
960 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
964 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
967 return 'No account found to apply pre-paid time';
968 } elsif ( scalar(@cust_svc) > 1 ) {
969 return 'Multiple accounts found to apply pre-paid time';
972 my $svc_acct = $cust_svc[0]->svc_x;
973 warn " found service svcnum ". $svc_acct->pkgnum.
974 ' ('. $svc_acct->email. ")\n"
977 $column = "increment_$column";
978 $svc_acct->$column($amount);
982 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
984 Inserts a prepayment in the specified amount for this customer. An optional
985 second argument can specify the prepayment identifier for tracking purposes.
986 If there is an error, returns the error, otherwise returns false.
990 sub insert_cust_pay_prepay {
991 shift->insert_cust_pay('PREP', @_);
994 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
996 Inserts a cash payment in the specified amount for this customer. An optional
997 second argument can specify the payment identifier for tracking purposes.
998 If there is an error, returns the error, otherwise returns false.
1002 sub insert_cust_pay_cash {
1003 shift->insert_cust_pay('CASH', @_);
1006 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1008 Inserts a Western Union payment in the specified amount for this customer. An
1009 optional second argument can specify the prepayment identifier for tracking
1010 purposes. If there is an error, returns the error, otherwise returns false.
1014 sub insert_cust_pay_west {
1015 shift->insert_cust_pay('WEST', @_);
1018 sub insert_cust_pay {
1019 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1020 my $payinfo = scalar(@_) ? shift : '';
1022 my $cust_pay = new FS::cust_pay {
1023 'custnum' => $self->custnum,
1024 'paid' => sprintf('%.2f', $amount),
1025 #'_date' => #date the prepaid card was purchased???
1027 'payinfo' => $payinfo,
1035 This method is deprecated. See the I<depend_jobnum> option to the insert and
1036 order_pkgs methods for a better way to defer provisioning.
1038 Re-schedules all exports by calling the B<reexport> method of all associated
1039 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
1040 otherwise returns false.
1047 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1048 "use the depend_jobnum option to insert or order_pkgs to delay export";
1050 local $SIG{HUP} = 'IGNORE';
1051 local $SIG{INT} = 'IGNORE';
1052 local $SIG{QUIT} = 'IGNORE';
1053 local $SIG{TERM} = 'IGNORE';
1054 local $SIG{TSTP} = 'IGNORE';
1055 local $SIG{PIPE} = 'IGNORE';
1057 my $oldAutoCommit = $FS::UID::AutoCommit;
1058 local $FS::UID::AutoCommit = 0;
1061 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1062 my $error = $cust_pkg->reexport;
1064 $dbh->rollback if $oldAutoCommit;
1069 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1074 =item delete [ OPTION => VALUE ... ]
1076 This deletes the customer. If there is an error, returns the error, otherwise
1079 This will completely remove all traces of the customer record. This is not
1080 what you want when a customer cancels service; for that, cancel all of the
1081 customer's packages (see L</cancel>).
1083 If the customer has any uncancelled packages, you need to pass a new (valid)
1084 customer number for those packages to be transferred to, as the "new_customer"
1085 option. Cancelled packages will be deleted. Did I mention that this is NOT
1086 what you want when a customer cancels service and that you really should be
1087 looking at L<FS::cust_pkg/cancel>?
1089 You can't delete a customer with invoices (see L<FS::cust_bill>),
1090 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1091 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1092 set the "delete_financials" option to a true value.
1097 my( $self, %opt ) = @_;
1099 local $SIG{HUP} = 'IGNORE';
1100 local $SIG{INT} = 'IGNORE';
1101 local $SIG{QUIT} = 'IGNORE';
1102 local $SIG{TERM} = 'IGNORE';
1103 local $SIG{TSTP} = 'IGNORE';
1104 local $SIG{PIPE} = 'IGNORE';
1106 my $oldAutoCommit = $FS::UID::AutoCommit;
1107 local $FS::UID::AutoCommit = 0;
1110 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1111 $dbh->rollback if $oldAutoCommit;
1112 return "Can't delete a master agent customer";
1115 #use FS::access_user
1116 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1117 $dbh->rollback if $oldAutoCommit;
1118 return "Can't delete a master employee customer";
1121 tie my %financial_tables, 'Tie::IxHash',
1122 'cust_bill' => 'invoices',
1123 'cust_statement' => 'statements',
1124 'cust_credit' => 'credits',
1125 'cust_pay' => 'payments',
1126 'cust_refund' => 'refunds',
1129 foreach my $table ( keys %financial_tables ) {
1131 my @records = $self->$table();
1133 if ( @records && ! $opt{'delete_financials'} ) {
1134 $dbh->rollback if $oldAutoCommit;
1135 return "Can't delete a customer with ". $financial_tables{$table};
1138 foreach my $record ( @records ) {
1139 my $error = $record->delete;
1141 $dbh->rollback if $oldAutoCommit;
1142 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1148 my @cust_pkg = $self->ncancelled_pkgs;
1150 my $new_custnum = $opt{'new_custnum'};
1151 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1152 $dbh->rollback if $oldAutoCommit;
1153 return "Invalid new customer number: $new_custnum";
1155 foreach my $cust_pkg ( @cust_pkg ) {
1156 my %hash = $cust_pkg->hash;
1157 $hash{'custnum'} = $new_custnum;
1158 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1159 my $error = $new_cust_pkg->replace($cust_pkg,
1160 options => { $cust_pkg->options },
1163 $dbh->rollback if $oldAutoCommit;
1168 my @cancelled_cust_pkg = $self->all_pkgs;
1169 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1170 my $error = $cust_pkg->delete;
1172 $dbh->rollback if $oldAutoCommit;
1177 #cust_tax_adjustment in financials?
1178 #cust_pay_pending? ouch
1180 foreach my $table (qw(
1181 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1182 cust_location cust_main_note cust_tax_adjustment
1183 cust_pay_void cust_pay_batch queue cust_tax_exempt
1185 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1186 my $error = $record->delete;
1188 $dbh->rollback if $oldAutoCommit;
1194 my $sth = $dbh->prepare(
1195 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1197 my $errstr = $dbh->errstr;
1198 $dbh->rollback if $oldAutoCommit;
1201 $sth->execute($self->custnum) or do {
1202 my $errstr = $sth->errstr;
1203 $dbh->rollback if $oldAutoCommit;
1209 my $ticket_dbh = '';
1210 if ($conf->config('ticket_system') eq 'RT_Internal') {
1212 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1213 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1214 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1215 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1218 if ( $ticket_dbh ) {
1220 my $ticket_sth = $ticket_dbh->prepare(
1221 'DELETE FROM Links WHERE Target = ?'
1223 my $errstr = $ticket_dbh->errstr;
1224 $dbh->rollback if $oldAutoCommit;
1227 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1229 my $errstr = $ticket_sth->errstr;
1230 $dbh->rollback if $oldAutoCommit;
1234 #check and see if the customer is the only link on the ticket, and
1235 #if so, set the ticket to deleted status in RT?
1236 #maybe someday, for now this will at least fix tickets not displaying
1240 #delete the customer record
1242 my $error = $self->SUPER::delete;
1244 $dbh->rollback if $oldAutoCommit;
1248 # cust_main exports!
1250 #my $export_args = $options{'export_args'} || [];
1253 map qsearch( 'part_export', {exportnum=>$_} ),
1254 $conf->config('cust_main-exports'); #, $agentnum
1256 foreach my $part_export ( @part_export ) {
1257 my $error = $part_export->export_delete( $self ); #, @$export_args);
1259 $dbh->rollback if $oldAutoCommit;
1260 return "exporting to ". $part_export->exporttype.
1261 " (transaction rolled back): $error";
1265 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1270 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1272 This merges this customer into the provided new custnum, and then deletes the
1273 customer. If there is an error, returns the error, otherwise returns false.
1275 The source customer's name, company name, phone numbers, agent,
1276 referring customer, customer class, advertising source, order taker, and
1277 billing information (except balance) are discarded.
1279 All packages are moved to the target customer. Packages with package locations
1280 are preserved. Packages without package locations are moved to a new package
1281 location with the source customer's service/shipping address.
1283 All invoices, statements, payments, credits and refunds are moved to the target
1284 customer. The source customer's balance is added to the target customer.
1286 All notes, attachments, tickets and customer tags are moved to the target
1289 Change history is not currently moved.
1294 my( $self, $new_custnum, %opt ) = @_;
1296 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1298 my $new_cust_main = qsearchs( 'cust_main', { 'custnum' => $new_custnum } )
1299 or return "Invalid new customer number: $new_custnum";
1301 return 'Access denied: "Merge customer across agents" access right required to merge into a customer of a different agent'
1302 if $self->agentnum != $new_cust_main->agentnum
1303 && ! $FS::CurrentUser::CurrentUser->access_right('Merge customer across agents');
1305 local $SIG{HUP} = 'IGNORE';
1306 local $SIG{INT} = 'IGNORE';
1307 local $SIG{QUIT} = 'IGNORE';
1308 local $SIG{TERM} = 'IGNORE';
1309 local $SIG{TSTP} = 'IGNORE';
1310 local $SIG{PIPE} = 'IGNORE';
1312 my $oldAutoCommit = $FS::UID::AutoCommit;
1313 local $FS::UID::AutoCommit = 0;
1316 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1317 $dbh->rollback if $oldAutoCommit;
1318 return "Can't merge a master agent customer";
1321 #use FS::access_user
1322 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1323 $dbh->rollback if $oldAutoCommit;
1324 return "Can't merge a master employee customer";
1327 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1328 'status' => { op=>'!=', value=>'done' },
1332 $dbh->rollback if $oldAutoCommit;
1333 return "Can't merge a customer with pending payments";
1336 tie my %financial_tables, 'Tie::IxHash',
1337 'cust_bill' => 'invoices',
1338 'cust_bill_void' => 'voided invoices',
1339 'cust_statement' => 'statements',
1340 'cust_credit' => 'credits',
1341 'cust_credit_void' => 'voided credits',
1342 'cust_pay' => 'payments',
1343 'cust_pay_void' => 'voided payments',
1344 'cust_refund' => 'refunds',
1347 foreach my $table ( keys %financial_tables ) {
1349 my @records = $self->$table();
1351 foreach my $record ( @records ) {
1352 $record->custnum($new_custnum);
1353 my $error = $record->replace;
1355 $dbh->rollback if $oldAutoCommit;
1356 return "Error merging ". $financial_tables{$table}. ": $error\n";
1362 my $name = $self->ship_name; #?
1364 my $locationnum = '';
1365 foreach my $cust_pkg ( $self->all_pkgs ) {
1366 $cust_pkg->custnum($new_custnum);
1368 unless ( $cust_pkg->locationnum ) {
1369 unless ( $locationnum ) {
1370 my $cust_location = new FS::cust_location {
1371 $self->location_hash,
1372 'custnum' => $new_custnum,
1374 my $error = $cust_location->insert;
1376 $dbh->rollback if $oldAutoCommit;
1379 $locationnum = $cust_location->locationnum;
1381 $cust_pkg->locationnum($locationnum);
1384 my $error = $cust_pkg->replace;
1386 $dbh->rollback if $oldAutoCommit;
1390 # add customer (ship) name to svc_phone.phone_name if blank
1391 my @cust_svc = $cust_pkg->cust_svc;
1392 foreach my $cust_svc (@cust_svc) {
1393 my($label, $value, $svcdb) = $cust_svc->label;
1394 next unless $svcdb eq 'svc_phone';
1395 my $svc_phone = $cust_svc->svc_x;
1396 next if $svc_phone->phone_name;
1397 $svc_phone->phone_name($name);
1398 my $error = $svc_phone->replace;
1400 $dbh->rollback if $oldAutoCommit;
1408 # cust_tax_exempt (texas tax exemptions)
1409 # cust_recon (some sort of not-well understood thing for OnPac)
1411 #these are moved over
1412 foreach my $table (qw(
1413 cust_tag cust_location contact cust_attachment cust_main_note
1414 cust_tax_adjustment cust_pay_batch queue
1416 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1417 $record->custnum($new_custnum);
1418 my $error = $record->replace;
1420 $dbh->rollback if $oldAutoCommit;
1426 #these aren't preserved
1427 foreach my $table (qw(
1428 cust_main_exemption cust_main_invoice
1430 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1431 my $error = $record->delete;
1433 $dbh->rollback if $oldAutoCommit;
1440 my $sth = $dbh->prepare(
1441 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1443 my $errstr = $dbh->errstr;
1444 $dbh->rollback if $oldAutoCommit;
1447 $sth->execute($new_custnum, $self->custnum) or do {
1448 my $errstr = $sth->errstr;
1449 $dbh->rollback if $oldAutoCommit;
1455 my $ticket_dbh = '';
1456 if ($conf->config('ticket_system') eq 'RT_Internal') {
1458 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1459 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1460 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1461 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1464 if ( $ticket_dbh ) {
1466 my $ticket_sth = $ticket_dbh->prepare(
1467 'UPDATE Links SET Target = ? WHERE Target = ?'
1469 my $errstr = $ticket_dbh->errstr;
1470 $dbh->rollback if $oldAutoCommit;
1473 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1474 'freeside://freeside/cust_main/'.$self->custnum)
1476 my $errstr = $ticket_sth->errstr;
1477 $dbh->rollback if $oldAutoCommit;
1483 #delete the customer record
1485 my $error = $self->delete;
1487 $dbh->rollback if $oldAutoCommit;
1491 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1496 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1498 Replaces the OLD_RECORD with this one in the database. If there is an error,
1499 returns the error, otherwise returns false.
1501 To change the customer's address, set the pseudo-fields C<bill_location> and
1502 C<ship_location>. The address will still only change if at least one of the
1503 address fields differs from the existing values.
1505 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1506 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1507 expected and rollback the entire transaction; it is not necessary to call
1508 check_invoicing_list first. Here's an example:
1510 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1512 Currently available options are: I<tax_exemption>.
1514 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1515 of tax names and exemption numbers. FS::cust_main_exemption records will be
1516 deleted and inserted as appropriate.
1523 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1525 : $self->replace_old;
1529 warn "$me replace called\n"
1532 my $curuser = $FS::CurrentUser::CurrentUser;
1533 if ( $self->payby eq 'COMP'
1534 && $self->payby ne $old->payby
1535 && ! $curuser->access_right('Complimentary customer')
1538 return "You are not permitted to create complimentary accounts.";
1541 local($ignore_expired_card) = 1
1542 if $old->payby =~ /^(CARD|DCRD)$/
1543 && $self->payby =~ /^(CARD|DCRD)$/
1544 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1546 local($ignore_banned_card) = 1
1547 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1548 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1549 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1551 if ( $self->payby =~ /^(CARD|DCRD)$/
1552 && $old->payinfo ne $self->payinfo
1553 && $old->paymask ne $self->paymask )
1555 my $error = $self->check_payinfo_cardtype;
1556 return $error if $error;
1558 if ( $conf->exists('business-onlinepayment-verification') ) {
1559 #need to standardize paydate for this, false laziness with check
1561 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1562 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1563 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1564 ( $m, $y ) = ( $2, "19$1" );
1565 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1566 ( $m, $y ) = ( $3, "20$2" );
1568 return "Illegal expiration date: ". $self->paydate;
1570 $m = sprintf('%02d',$m);
1571 $self->paydate("$y-$m-01");
1573 $error = $self->realtime_verify_bop({ 'method'=>'CC' });
1574 return $error if $error;
1578 return "Invoicing locale is required"
1581 && $conf->exists('cust_main-require_locale');
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 for my $l (qw(bill_location ship_location)) {
1595 my $old_loc = $old->$l;
1596 my $new_loc = $self->$l;
1598 # find the existing location if there is one
1599 $new_loc->set('custnum' => $self->custnum);
1600 my $error = $new_loc->find_or_insert;
1602 $dbh->rollback if $oldAutoCommit;
1605 $self->set($l.'num', $new_loc->locationnum);
1608 # replace the customer record
1609 my $error = $self->SUPER::replace($old);
1612 $dbh->rollback if $oldAutoCommit;
1616 # now move packages to the new service location
1617 $self->set('ship_location', ''); #flush cache
1618 if ( $old->ship_locationnum and # should only be null during upgrade...
1619 $old->ship_locationnum != $self->ship_locationnum ) {
1620 $error = $old->ship_location->move_to($self->ship_location);
1622 $dbh->rollback if $oldAutoCommit;
1626 # don't move packages based on the billing location, but
1627 # disable it if it's no longer in use
1628 if ( $old->bill_locationnum and
1629 $old->bill_locationnum != $self->bill_locationnum ) {
1630 $error = $old->bill_location->disable_if_unused;
1632 $dbh->rollback if $oldAutoCommit;
1637 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1638 my $invoicing_list = shift @param;
1639 $error = $self->check_invoicing_list( $invoicing_list );
1641 $dbh->rollback if $oldAutoCommit;
1644 $self->invoicing_list( $invoicing_list );
1647 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1649 #this could be more efficient than deleting and re-inserting, if it matters
1650 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1651 my $error = $cust_tag->delete;
1653 $dbh->rollback if $oldAutoCommit;
1657 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1658 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1659 'custnum' => $self->custnum };
1660 my $error = $cust_tag->insert;
1662 $dbh->rollback if $oldAutoCommit;
1669 my %options = @param;
1671 my $tax_exemption = delete $options{'tax_exemption'};
1672 if ( $tax_exemption ) {
1674 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1675 if ref($tax_exemption) eq 'ARRAY';
1677 my %cust_main_exemption =
1678 map { $_->taxname => $_ }
1679 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1681 foreach my $taxname ( keys %$tax_exemption ) {
1683 if ( $cust_main_exemption{$taxname} &&
1684 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1687 delete $cust_main_exemption{$taxname};
1691 my $cust_main_exemption = new FS::cust_main_exemption {
1692 'custnum' => $self->custnum,
1693 'taxname' => $taxname,
1694 'exempt_number' => $tax_exemption->{$taxname},
1696 my $error = $cust_main_exemption->insert;
1698 $dbh->rollback if $oldAutoCommit;
1699 return "inserting cust_main_exemption (transaction rolled back): $error";
1703 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1704 my $error = $cust_main_exemption->delete;
1706 $dbh->rollback if $oldAutoCommit;
1707 return "deleting cust_main_exemption (transaction rolled back): $error";
1713 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1714 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1715 && $self->get('payinfo') !~ /^99\d{14}$/
1717 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1722 # card/check/lec info has changed, want to retry realtime_ invoice events
1723 my $error = $self->retry_realtime;
1725 $dbh->rollback if $oldAutoCommit;
1730 unless ( $import || $skip_fuzzyfiles ) {
1731 $error = $self->queue_fuzzyfiles_update;
1733 $dbh->rollback if $oldAutoCommit;
1734 return "updating fuzzy search cache: $error";
1738 # tax district update in cust_location
1740 # cust_main exports!
1742 my $export_args = $options{'export_args'} || [];
1745 map qsearch( 'part_export', {exportnum=>$_} ),
1746 $conf->config('cust_main-exports'); #, $agentnum
1748 foreach my $part_export ( @part_export ) {
1749 my $error = $part_export->export_replace( $self, $old, @$export_args);
1751 $dbh->rollback if $oldAutoCommit;
1752 return "exporting to ". $part_export->exporttype.
1753 " (transaction rolled back): $error";
1757 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1762 =item queue_fuzzyfiles_update
1764 Used by insert & replace to update the fuzzy search cache
1768 use FS::cust_main::Search;
1769 sub queue_fuzzyfiles_update {
1772 local $SIG{HUP} = 'IGNORE';
1773 local $SIG{INT} = 'IGNORE';
1774 local $SIG{QUIT} = 'IGNORE';
1775 local $SIG{TERM} = 'IGNORE';
1776 local $SIG{TSTP} = 'IGNORE';
1777 local $SIG{PIPE} = 'IGNORE';
1779 my $oldAutoCommit = $FS::UID::AutoCommit;
1780 local $FS::UID::AutoCommit = 0;
1783 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1784 my $queue = new FS::queue {
1785 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1787 my @args = "cust_main.$field", $self->get($field);
1788 my $error = $queue->insert( @args );
1790 $dbh->rollback if $oldAutoCommit;
1791 return "queueing job (transaction rolled back): $error";
1795 my @locations = $self->bill_location;
1796 push @locations, $self->ship_location if $self->has_ship_address;
1797 foreach my $location (@locations) {
1798 my $queue = new FS::queue {
1799 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1801 my @args = 'cust_location.address1', $location->address1;
1802 my $error = $queue->insert( @args );
1804 $dbh->rollback if $oldAutoCommit;
1805 return "queueing job (transaction rolled back): $error";
1809 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1816 Checks all fields to make sure this is a valid customer record. If there is
1817 an error, returns the error, otherwise returns false. Called by the insert
1818 and replace methods.
1825 warn "$me check BEFORE: \n". $self->_dump
1829 $self->ut_numbern('custnum')
1830 || $self->ut_number('agentnum')
1831 || $self->ut_textn('agent_custid')
1832 || $self->ut_number('refnum')
1833 || $self->ut_foreign_key('bill_locationnum', 'cust_location','locationnum')
1834 || $self->ut_foreign_key('ship_locationnum', 'cust_location','locationnum')
1835 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1836 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1837 || $self->ut_textn('custbatch')
1838 || $self->ut_name('last')
1839 || $self->ut_name('first')
1840 || $self->ut_snumbern('signupdate')
1841 || $self->ut_snumbern('birthdate')
1842 || $self->ut_namen('spouse_last')
1843 || $self->ut_namen('spouse_first')
1844 || $self->ut_snumbern('spouse_birthdate')
1845 || $self->ut_snumbern('anniversary_date')
1846 || $self->ut_textn('company')
1847 || $self->ut_textn('ship_company')
1848 || $self->ut_anything('comments')
1849 || $self->ut_numbern('referral_custnum')
1850 || $self->ut_textn('stateid')
1851 || $self->ut_textn('stateid_state')
1852 || $self->ut_textn('invoice_terms')
1853 || $self->ut_floatn('cdr_termination_percentage')
1854 || $self->ut_floatn('credit_limit')
1855 || $self->ut_numbern('billday')
1856 || $self->ut_numbern('prorate_day')
1857 || $self->ut_flag('force_prorate_day')
1858 || $self->ut_flag('edit_subject')
1859 || $self->ut_flag('calling_list_exempt')
1860 || $self->ut_flag('invoice_noemail')
1861 || $self->ut_flag('message_noemail')
1862 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1863 || $self->ut_flag('invoice_ship_address')
1866 foreach (qw(company ship_company)) {
1867 my $company = $self->get($_);
1868 $company =~ s/^\s+//;
1869 $company =~ s/\s+$//;
1870 $company =~ s/\s+/ /g;
1871 $self->set($_, $company);
1874 #barf. need message catalogs. i18n. etc.
1875 $error .= "Please select an advertising source."
1876 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1877 return $error if $error;
1879 return "Unknown agent"
1880 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1882 return "Unknown refnum"
1883 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1885 return "Unknown referring custnum: ". $self->referral_custnum
1886 unless ! $self->referral_custnum
1887 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1889 if ( $self->ss eq '' ) {
1894 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1895 or return "Illegal social security number: ". $self->ss;
1896 $self->ss("$1-$2-$3");
1899 #turn off invoice_ship_address if ship & bill are the same
1900 if ($self->bill_locationnum eq $self->ship_locationnum) {
1901 $self->invoice_ship_address('');
1904 # cust_main_county verification now handled by cust_location check
1907 $self->ut_phonen('daytime', $self->country)
1908 || $self->ut_phonen('night', $self->country)
1909 || $self->ut_phonen('fax', $self->country)
1910 || $self->ut_phonen('mobile', $self->country)
1912 return $error if $error;
1914 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1916 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1919 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1921 : FS::Msgcat::_gettext('daytime');
1922 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1924 : FS::Msgcat::_gettext('night');
1926 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1928 : FS::Msgcat::_gettext('mobile');
1930 return "$daytime_label, $night_label or $mobile_label is required"
1934 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1935 # or return "Illegal payby: ". $self->payby;
1937 FS::payby->can_payby($self->table, $self->payby)
1938 or return "Illegal payby: ". $self->payby;
1940 $error = $self->ut_numbern('paystart_month')
1941 || $self->ut_numbern('paystart_year')
1942 || $self->ut_numbern('payissue')
1943 || $self->ut_textn('paytype')
1945 return $error if $error;
1947 if ( $self->payip eq '' ) {
1950 $error = $self->ut_ip('payip');
1951 return $error if $error;
1954 # If it is encrypted and the private key is not availaible then we can't
1955 # check the credit card.
1956 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1958 # Need some kind of global flag to accept invalid cards, for testing
1960 if ( !$import && $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1962 my $payinfo = $self->payinfo;
1963 $payinfo =~ s/\D//g;
1964 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1965 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1967 $self->payinfo($payinfo);
1969 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1971 my $cardtype = cardtype($payinfo);
1972 $cardtype = 'Tokenized' if $self->payinfo =~ /^99\d{14}$/; # token
1974 return gettext('unknown_card_type') if $cardtype eq 'Unknown';
1976 $self->set('paycardtype', $cardtype);
1978 unless ( $ignore_banned_card ) {
1979 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1981 if ( $ban->bantype eq 'warn' ) {
1982 #or others depending on value of $ban->reason ?
1983 return '_duplicate_card'.
1984 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1985 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1986 ' (ban# '. $ban->bannum. ')'
1987 unless $self->override_ban_warn;
1989 return 'Banned credit card: banned on '.
1990 time2str('%a %h %o at %r', $ban->_date).
1991 ' by '. $ban->otaker.
1992 ' (ban# '. $ban->bannum. ')';
1997 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1998 if ( $cardtype eq 'American Express card' ) {
1999 $self->paycvv =~ /^(\d{4})$/
2000 or return "CVV2 (CID) for American Express cards is four digits.";
2003 $self->paycvv =~ /^(\d{3})$/
2004 or return "CVV2 (CVC2/CID) is three digits.";
2011 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
2013 return "Start date or issue number is required for $cardtype cards"
2014 unless $self->paystart_month && $self->paystart_year or $self->payissue;
2016 return "Start month must be between 1 and 12"
2017 if $self->paystart_month
2018 and $self->paystart_month < 1 || $self->paystart_month > 12;
2020 return "Start year must be 1990 or later"
2021 if $self->paystart_year
2022 and $self->paystart_year < 1990;
2024 return "Issue number must be beween 1 and 99"
2026 and $self->payissue < 1 || $self->payissue > 99;
2029 $self->paystart_month('');
2030 $self->paystart_year('');
2031 $self->payissue('');
2034 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
2036 my $payinfo = $self->payinfo;
2037 $payinfo =~ s/[^\d\@\.]//g;
2038 if ( $conf->config('echeck-country') eq 'CA' ) {
2039 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
2040 or return 'invalid echeck account@branch.bank';
2041 $payinfo = "$1\@$2.$3";
2042 } elsif ( $conf->config('echeck-country') eq 'US' ) {
2043 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
2044 $payinfo = "$1\@$2";
2046 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
2047 $payinfo = "$1\@$2";
2049 $self->payinfo($payinfo);
2052 unless ( $ignore_banned_card ) {
2053 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
2055 if ( $ban->bantype eq 'warn' ) {
2056 #or others depending on value of $ban->reason ?
2057 return '_duplicate_ach' unless $self->override_ban_warn;
2059 return 'Banned ACH account: banned on '.
2060 time2str('%a %h %o at %r', $ban->_date).
2061 ' by '. $ban->otaker.
2062 ' (ban# '. $ban->bannum. ')';
2067 } elsif ( $self->payby eq 'LECB' ) {
2069 my $payinfo = $self->payinfo;
2070 $payinfo =~ s/\D//g;
2071 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2073 $self->payinfo($payinfo);
2076 } elsif ( $self->payby eq 'BILL' ) {
2078 $error = $self->ut_textn('payinfo');
2079 return "Illegal P.O. number: ". $self->payinfo if $error;
2082 } elsif ( $self->payby eq 'COMP' ) {
2084 my $curuser = $FS::CurrentUser::CurrentUser;
2085 if ( ! $self->custnum
2086 && ! $curuser->access_right('Complimentary customer')
2089 return "You are not permitted to create complimentary accounts."
2092 $error = $self->ut_textn('payinfo');
2093 return "Illegal comp account issuer: ". $self->payinfo if $error;
2096 } elsif ( $self->payby eq 'PREPAY' ) {
2098 my $payinfo = $self->payinfo;
2099 $payinfo =~ s/\W//g; #anything else would just confuse things
2100 $self->payinfo($payinfo);
2101 $error = $self->ut_alpha('payinfo');
2102 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2103 return "Unknown prepayment identifier"
2104 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2107 } elsif ( $self->payby =~ /^CARD|DCRD$/ and $self->paymask ) {
2108 # either ignoring invalid cards, or we can't decrypt the payinfo, but
2109 # try to detect the card type anyway. this never returns failure, so
2110 # the contract of $ignore_invalid_cards is maintained.
2111 $self->set('paycardtype', cardtype($self->paymask));
2114 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2115 return "Expiration date required"
2116 # shouldn't payinfo_check do this?
2117 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2121 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2122 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2123 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2124 ( $m, $y ) = ( $2, "19$1" );
2125 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2126 ( $m, $y ) = ( $3, "20$2" );
2128 return "Illegal expiration date: ". $self->paydate;
2130 $m = sprintf('%02d',$m);
2131 $self->paydate("$y-$m-01");
2132 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2133 return gettext('expired_card')
2135 && !$ignore_expired_card
2136 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2139 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2140 ( ! $conf->exists('require_cardname')
2141 || $self->payby !~ /^(CARD|DCRD)$/ )
2143 $self->payname( $self->first. " ". $self->getfield('last') );
2146 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2147 $self->payname =~ /^([\w \,\.\-\']*)$/
2148 or return gettext('illegal_name'). " payname: ". $self->payname;
2151 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2152 or return gettext('illegal_name'). " payname: ". $self->payname;
2158 return "Please select an invoicing locale"
2161 && $conf->exists('cust_main-require_locale');
2163 return "Please select a customer class"
2164 if ! $self->classnum
2165 && $conf->exists('cust_main-require_classnum');
2167 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2168 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2172 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2174 warn "$me check AFTER: \n". $self->_dump
2177 $self->SUPER::check;
2180 sub check_payinfo_cardtype {
2183 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
2185 my $payinfo = $self->payinfo;
2186 $payinfo =~ s/\D//g;
2188 if ( $payinfo =~ /^99\d{14}$/ ) {
2189 $self->set('paycardtype', 'Tokenized');
2193 my %bop_card_types = map { $_=>1 } values %{ card_types() };
2194 my $cardtype = cardtype($payinfo);
2195 $self->set('paycardtype', $cardtype);
2197 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
2205 Additional checks for replace only.
2210 my ($new,$old) = @_;
2211 #preserve old value if global config is set
2212 if ($old && $conf->exists('invoice-ship_address')) {
2213 $new->invoice_ship_address($old->invoice_ship_address);
2220 Returns a list of fields which have ship_ duplicates.
2225 qw( last first company
2227 address1 address2 city county state zip country
2229 daytime night fax mobile
2233 =item has_ship_address
2235 Returns true if this customer record has a separate shipping address.
2239 sub has_ship_address {
2241 $self->bill_locationnum != $self->ship_locationnum;
2246 Returns a list of key/value pairs, with the following keys: address1,
2247 adddress2, city, county, state, zip, country, district, and geocode. The
2248 shipping address is used if present.
2254 $self->ship_location->location_hash;
2259 Returns all locations (see L<FS::cust_location>) for this customer.
2265 qsearch('cust_location', { 'custnum' => $self->custnum,
2266 'prospectnum' => '' } );
2271 Returns all contacts (see L<FS::contact>) for this customer.
2275 #already used :/ sub contact {
2278 qsearch('contact', { 'custnum' => $self->custnum } );
2283 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2284 and L<FS::cust_pkg>) for this customer, except those on hold.
2286 Returns a list: an empty list on success or a list of errors.
2292 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2297 Unsuspends all suspended packages in the on-hold state (those without setup
2298 dates) for this customer.
2304 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2309 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2311 Returns a list: an empty list on success or a list of errors.
2317 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2320 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2322 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2323 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2324 of a list of pkgparts; the hashref has the following keys:
2328 =item pkgparts - listref of pkgparts
2330 =item (other options are passed to the suspend method)
2335 Returns a list: an empty list on success or a list of errors.
2339 sub suspend_if_pkgpart {
2341 my (@pkgparts, %opt);
2342 if (ref($_[0]) eq 'HASH'){
2343 @pkgparts = @{$_[0]{pkgparts}};
2348 grep { $_->suspend(%opt) }
2349 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2350 $self->unsuspended_pkgs;
2353 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2355 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2356 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2357 instead of a list of pkgparts; the hashref has the following keys:
2361 =item pkgparts - listref of pkgparts
2363 =item (other options are passed to the suspend method)
2367 Returns a list: an empty list on success or a list of errors.
2371 sub suspend_unless_pkgpart {
2373 my (@pkgparts, %opt);
2374 if (ref($_[0]) eq 'HASH'){
2375 @pkgparts = @{$_[0]{pkgparts}};
2380 grep { $_->suspend(%opt) }
2381 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2382 $self->unsuspended_pkgs;
2385 =item cancel [ OPTION => VALUE ... ]
2387 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2388 The cancellation time will be now.
2392 Always returns a list: an empty list on success or a list of errors.
2399 warn "$me cancel called on customer ". $self->custnum. " with options ".
2400 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2402 my @pkgs = $self->ncancelled_pkgs;
2404 $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2407 =item cancel_pkgs OPTIONS
2409 Cancels a specified list of packages. OPTIONS can include:
2413 =item cust_pkg - an arrayref of the packages. Required.
2415 =item time - the cancellation time, used to calculate final bills and
2416 unused-time credits if any. Will be passed through to the bill() and
2417 FS::cust_pkg::cancel() methods.
2419 =item quiet - can be set true to supress email cancellation notices.
2421 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a
2422 reasonnum of an existing reason, or passing a hashref will create a new reason.
2423 The hashref should have the following keys:
2424 typenum - Reason type (see L<FS::reason_type>)
2425 reason - Text of the new reason.
2427 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2428 for the individual packages, parallel to the C<cust_pkg> argument. The
2429 reason and reason_otaker arguments will be taken from those objects.
2431 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2433 =item nobill - can be set true to skip billing if it might otherwise be done.
2438 my( $self, %opt ) = @_;
2440 # we're going to cancel services, which is not reversible
2441 # but on 3.x, don't strictly enforce this
2442 warn "cancel_pkgs should not be run inside a transaction"
2443 if $FS::UID::AutoCommit == 0;
2445 local $FS::UID::AutoCommit = 0;
2447 return ( 'access denied' )
2448 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2450 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2452 #should try decryption (we might have the private key)
2453 # and if not maybe queue a job for the server that does?
2454 return ( "Can't (yet) ban encrypted credit cards" )
2455 if $self->is_encrypted($self->payinfo);
2457 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2458 my $error = $ban->insert;
2466 my @pkgs = @{ delete $opt{'cust_pkg'} };
2467 my $cancel_time = $opt{'time'} || time;
2469 # bill all packages first, so we don't lose usage, service counts for
2470 # bulk billing, etc.
2471 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2473 my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2475 'time' => $cancel_time );
2477 warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2479 return ( "Error billing during cancellation: $error" );
2484 $FS::UID::AutoCommit = 1;
2486 # now cancel all services, the same way we would for individual packages.
2487 # if any of them fail, cancel the rest anyway.
2488 my @cust_svc = map { $_->cust_svc } @pkgs;
2489 my @sorted_cust_svc =
2491 sort { $a->[1] <=> $b->[1] }
2492 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2494 warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2497 foreach my $cust_svc (@sorted_cust_svc) {
2498 my $part_svc = $cust_svc->part_svc;
2499 next if ( defined($part_svc) and $part_svc->preserve );
2500 my $error = $cust_svc->cancel; # immediate cancel, no date option
2501 push @errors, $error if $error;
2507 warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2508 $self->custnum. "\n"
2512 if ($opt{'cust_pkg_reason'}) {
2513 @cprs = @{ delete $opt{'cust_pkg_reason'} };
2519 my $cpr = shift @cprs;
2521 $lopt{'reason'} = $cpr->reasonnum;
2522 $lopt{'reason_otaker'} = $cpr->otaker;
2524 warn "no reason found when canceling package ".$_->pkgnum."\n";
2525 $lopt{'reason'} = '';
2528 my $error = $_->cancel(%lopt);
2529 push @errors, 'pkgnum '.$_->pkgnum.': '.$error if $error;
2535 sub _banned_pay_hashref {
2546 'payby' => $payby2ban{$self->payby},
2547 'payinfo' => $self->payinfo,
2548 #don't ever *search* on reason! #'reason' =>
2552 sub _new_banned_pay_hashref {
2554 my $hr = $self->_banned_pay_hashref;
2555 $hr->{payinfo} = md5_base64($hr->{payinfo});
2561 Returns all notes (see L<FS::cust_main_note>) for this customer.
2566 my($self,$orderby_classnum) = (shift,shift);
2567 my $orderby = "sticky DESC, _date DESC";
2568 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2569 qsearch( 'cust_main_note',
2570 { 'custnum' => $self->custnum },
2572 "ORDER BY $orderby",
2578 Returns the agent (see L<FS::agent>) for this customer.
2584 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2589 Returns the agent name (see L<FS::agent>) for this customer.
2595 $self->agent->agent;
2600 Returns any tags associated with this customer, as FS::cust_tag objects,
2601 or an empty list if there are no tags.
2607 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2612 Returns any tags associated with this customer, as FS::part_tag objects,
2613 or an empty list if there are no tags.
2619 map $_->part_tag, $self->cust_tag;
2625 Returns the customer class, as an FS::cust_class object, or the empty string
2626 if there is no customer class.
2632 if ( $self->classnum ) {
2633 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2641 Returns the customer category name, or the empty string if there is no customer
2648 my $cust_class = $self->cust_class;
2650 ? $cust_class->categoryname
2656 Returns the customer class name, or the empty string if there is no customer
2663 my $cust_class = $self->cust_class;
2665 ? $cust_class->classname
2669 =item BILLING METHODS
2671 Documentation on billing methods has been moved to
2672 L<FS::cust_main::Billing>.
2674 =item REALTIME BILLING METHODS
2676 Documentation on realtime billing methods has been moved to
2677 L<FS::cust_main::Billing_Realtime>.
2681 Removes the I<paycvv> field from the database directly.
2683 If there is an error, returns the error, otherwise returns false.
2689 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2690 or return dbh->errstr;
2691 $sth->execute($self->custnum)
2692 or return $sth->errstr;
2697 =item batch_card OPTION => VALUE...
2699 Adds a payment for this invoice to the pending credit card batch (see
2700 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2701 runs the payment using a realtime gateway.
2703 Options may include:
2705 B<amount>: the amount to be paid; defaults to the customer's balance minus
2706 any payments in transit.
2708 B<payby>: the payment method; defaults to cust_main.payby
2710 B<realtime>: runs this as a realtime payment instead of adding it to a
2713 B<invnum>: sets cust_pay_batch.invnum.
2715 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2716 the billing address for the payment; defaults to the customer's billing
2719 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2720 date, and name; defaults to those fields in cust_main.
2725 my ($self, %options) = @_;
2728 if (exists($options{amount})) {
2729 $amount = $options{amount};
2731 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2734 warn(sprintf("Customer balance %.2f - in transit amount %.2f is <= 0.\n",
2736 $self->in_transit_payments
2741 my $invnum = delete $options{invnum};
2742 my $payby = $options{payby} || $self->payby; #still dubious
2744 if ($options{'realtime'}) {
2745 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2751 my $oldAutoCommit = $FS::UID::AutoCommit;
2752 local $FS::UID::AutoCommit = 0;
2755 #this needs to handle mysql as well as Pg, like svc_acct.pm
2756 #(make it into a common function if folks need to do batching with mysql)
2757 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2758 or return "Cannot lock pay_batch: " . $dbh->errstr;
2762 'payby' => FS::payby->payby2payment($payby),
2764 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2766 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2768 unless ( $pay_batch ) {
2769 $pay_batch = new FS::pay_batch \%pay_batch;
2770 my $error = $pay_batch->insert;
2772 $dbh->rollback if $oldAutoCommit;
2773 die "error creating new batch: $error\n";
2777 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2778 'batchnum' => $pay_batch->batchnum,
2779 'custnum' => $self->custnum,
2782 foreach (qw( address1 address2 city state zip country latitude longitude
2783 payby payinfo paydate payname ))
2785 $options{$_} = '' unless exists($options{$_});
2788 my $loc = $self->bill_location;
2790 my $cust_pay_batch = new FS::cust_pay_batch ( {
2791 'batchnum' => $pay_batch->batchnum,
2792 'invnum' => $invnum || 0, # is there a better value?
2793 # this field should be
2795 # cust_bill_pay_batch now
2796 'custnum' => $self->custnum,
2797 'last' => $self->getfield('last'),
2798 'first' => $self->getfield('first'),
2799 'address1' => $options{address1} || $loc->address1,
2800 'address2' => $options{address2} || $loc->address2,
2801 'city' => $options{city} || $loc->city,
2802 'state' => $options{state} || $loc->state,
2803 'zip' => $options{zip} || $loc->zip,
2804 'country' => $options{country} || $loc->country,
2805 'payby' => $options{payby} || $self->payby,
2806 'payinfo' => $options{payinfo} || $self->payinfo,
2807 'exp' => $options{paydate} || $self->paydate,
2808 'payname' => $options{payname} || $self->payname,
2809 'amount' => $amount, # consolidating
2812 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2813 if $old_cust_pay_batch;
2816 if ($old_cust_pay_batch) {
2817 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2819 $error = $cust_pay_batch->insert;
2823 $dbh->rollback if $oldAutoCommit;
2827 my $unapplied = $self->total_unapplied_credits
2828 + $self->total_unapplied_payments
2829 + $self->in_transit_payments;
2830 foreach my $cust_bill ($self->open_cust_bill) {
2831 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2832 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2833 'invnum' => $cust_bill->invnum,
2834 'paybatchnum' => $cust_pay_batch->paybatchnum,
2835 'amount' => $cust_bill->owed,
2838 if ($unapplied >= $cust_bill_pay_batch->amount){
2839 $unapplied -= $cust_bill_pay_batch->amount;
2842 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2843 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2845 $error = $cust_bill_pay_batch->insert;
2847 $dbh->rollback if $oldAutoCommit;
2852 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2858 Returns the total owed for this customer on all invoices
2859 (see L<FS::cust_bill/owed>).
2865 $self->total_owed_date(2145859200); #12/31/2037
2868 =item total_owed_date TIME
2870 Returns the total owed for this customer on all invoices with date earlier than
2871 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2872 see L<Time::Local> and L<Date::Parse> for conversion functions.
2876 sub total_owed_date {
2880 my $custnum = $self->custnum;
2882 my $owed_sql = FS::cust_bill->owed_sql;
2885 SELECT SUM($owed_sql) FROM cust_bill
2886 WHERE custnum = $custnum
2890 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2894 =item total_owed_pkgnum PKGNUM
2896 Returns the total owed on all invoices for this customer's specific package
2897 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2901 sub total_owed_pkgnum {
2902 my( $self, $pkgnum ) = @_;
2903 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2906 =item total_owed_date_pkgnum TIME PKGNUM
2908 Returns the total owed for this customer's specific package when using
2909 experimental package balances on all invoices with date earlier than
2910 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2911 see L<Time::Local> and L<Date::Parse> for conversion functions.
2915 sub total_owed_date_pkgnum {
2916 my( $self, $time, $pkgnum ) = @_;
2919 foreach my $cust_bill (
2920 grep { $_->_date <= $time }
2921 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2923 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2925 sprintf( "%.2f", $total_bill );
2931 Returns the total amount of all payments.
2938 $total += $_->paid foreach $self->cust_pay;
2939 sprintf( "%.2f", $total );
2942 =item total_unapplied_credits
2944 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2945 customer. See L<FS::cust_credit/credited>.
2947 =item total_credited
2949 Old name for total_unapplied_credits. Don't use.
2953 sub total_credited {
2954 #carp "total_credited deprecated, use total_unapplied_credits";
2955 shift->total_unapplied_credits(@_);
2958 sub total_unapplied_credits {
2961 my $custnum = $self->custnum;
2963 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2966 SELECT SUM($unapplied_sql) FROM cust_credit
2967 WHERE custnum = $custnum
2970 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2974 =item total_unapplied_credits_pkgnum PKGNUM
2976 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2977 customer. See L<FS::cust_credit/credited>.
2981 sub total_unapplied_credits_pkgnum {
2982 my( $self, $pkgnum ) = @_;
2983 my $total_credit = 0;
2984 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2985 sprintf( "%.2f", $total_credit );
2989 =item total_unapplied_payments
2991 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2992 See L<FS::cust_pay/unapplied>.
2996 sub total_unapplied_payments {
2999 my $custnum = $self->custnum;
3001 my $unapplied_sql = FS::cust_pay->unapplied_sql;
3004 SELECT SUM($unapplied_sql) FROM cust_pay
3005 WHERE custnum = $custnum
3008 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
3012 =item total_unapplied_payments_pkgnum PKGNUM
3014 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
3015 specific package when using experimental package balances. See
3016 L<FS::cust_pay/unapplied>.
3020 sub total_unapplied_payments_pkgnum {
3021 my( $self, $pkgnum ) = @_;
3022 my $total_unapplied = 0;
3023 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
3024 sprintf( "%.2f", $total_unapplied );
3028 =item total_unapplied_refunds
3030 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
3031 customer. See L<FS::cust_refund/unapplied>.
3035 sub total_unapplied_refunds {
3037 my $custnum = $self->custnum;
3039 my $unapplied_sql = FS::cust_refund->unapplied_sql;
3042 SELECT SUM($unapplied_sql) FROM cust_refund
3043 WHERE custnum = $custnum
3046 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
3052 Returns the balance for this customer (total_owed plus total_unrefunded, minus
3053 total_unapplied_credits minus total_unapplied_payments).
3059 $self->balance_date_range;
3062 =item balance_date TIME
3064 Returns the balance for this customer, only considering invoices with date
3065 earlier than TIME (total_owed_date minus total_credited minus
3066 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
3067 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
3074 $self->balance_date_range(shift);
3077 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
3079 Returns the balance for this customer, optionally considering invoices with
3080 date earlier than START_TIME, and not later than END_TIME
3081 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
3083 Times are specified as SQL fragments or numeric
3084 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
3085 L<Date::Parse> for conversion functions. The empty string can be passed
3086 to disable that time constraint completely.
3088 Accepts the same options as L<balance_date_sql>:
3092 =item unapplied_date
3094 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)
3098 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
3099 time will be ignored. Note that START_TIME and END_TIME only limit the date
3100 range for invoices and I<unapplied> payments, credits, and refunds.
3106 sub balance_date_range {
3108 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
3109 ') FROM cust_main WHERE custnum='. $self->custnum;
3110 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
3113 =item balance_pkgnum PKGNUM
3115 Returns the balance for this customer's specific package when using
3116 experimental package balances (total_owed plus total_unrefunded, minus
3117 total_unapplied_credits minus total_unapplied_payments)
3121 sub balance_pkgnum {
3122 my( $self, $pkgnum ) = @_;
3125 $self->total_owed_pkgnum($pkgnum)
3126 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
3127 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
3128 - $self->total_unapplied_credits_pkgnum($pkgnum)
3129 - $self->total_unapplied_payments_pkgnum($pkgnum)
3133 =item in_transit_payments
3135 Returns the total of requests for payments for this customer pending in
3136 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
3140 sub in_transit_payments {
3142 my $in_transit_payments = 0;
3143 foreach my $pay_batch ( qsearch('pay_batch', {
3146 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
3147 'batchnum' => $pay_batch->batchnum,
3148 'custnum' => $self->custnum,
3151 $in_transit_payments += $cust_pay_batch->amount;
3154 sprintf( "%.2f", $in_transit_payments );
3159 Returns a hash of useful information for making a payment.
3169 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
3170 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
3171 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
3175 For credit card transactions:
3187 For electronic check transactions:
3202 $return{balance} = $self->balance;
3204 $return{payname} = $self->payname
3205 || ( $self->first. ' '. $self->get('last') );
3207 $return{$_} = $self->bill_location->$_
3208 for qw(address1 address2 city state zip);
3210 $return{payby} = $self->payby;
3211 $return{stateid_state} = $self->stateid_state;
3213 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
3214 $return{card_type} = cardtype($self->payinfo);
3215 $return{payinfo} = $self->paymask;
3217 @return{'month', 'year'} = $self->paydate_monthyear;
3221 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
3222 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
3223 $return{payinfo1} = $payinfo1;
3224 $return{payinfo2} = $payinfo2;
3225 $return{paytype} = $self->paytype;
3226 $return{paystate} = $self->paystate;
3230 #doubleclick protection
3232 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3238 =item paydate_monthyear
3240 Returns a two-element list consisting of the month and year of this customer's
3241 paydate (credit card expiration date for CARD customers)
3245 sub paydate_monthyear {
3247 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3249 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3258 Returns the exact time in seconds corresponding to the payment method
3259 expiration date. For CARD/DCRD customers this is the end of the month;
3260 for others (COMP is the only other payby that uses paydate) it's the start.
3261 Returns 0 if the paydate is empty or set to the far future.
3267 my ($month, $year) = $self->paydate_monthyear;
3268 return 0 if !$year or $year >= 2037;
3269 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3271 if ( $month == 13 ) {
3275 return timelocal(0,0,0,1,$month-1,$year) - 1;
3278 return timelocal(0,0,0,1,$month-1,$year);
3282 =item paydate_epoch_sql
3284 Class method. Returns an SQL expression to obtain the payment expiration date
3285 as a number of seconds.
3289 # Special expiration date behavior for non-CARD/DCRD customers has been
3290 # carefully preserved. Do we really use that?
3291 sub paydate_epoch_sql {
3293 my $table = shift || 'cust_main';
3294 my ($case1, $case2);
3295 if ( driver_name eq 'Pg' ) {
3296 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3297 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3299 elsif ( lc(driver_name) eq 'mysql' ) {
3300 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3301 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3304 return "CASE WHEN $table.payby IN('CARD','DCRD')
3310 =item tax_exemption TAXNAME
3315 my( $self, $taxname ) = @_;
3317 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3318 'taxname' => $taxname,
3323 =item cust_main_exemption
3327 sub cust_main_exemption {
3329 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3332 =item invoicing_list [ ARRAYREF ]
3334 If an arguement is given, sets these email addresses as invoice recipients
3335 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3336 (except as warnings), so use check_invoicing_list first.
3338 Returns a list of email addresses (with svcnum entries expanded).
3340 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3341 check it without disturbing anything by passing nothing.
3343 This interface may change in the future.
3347 sub invoicing_list {
3348 my( $self, $arrayref ) = @_;
3351 my @cust_main_invoice;
3352 if ( $self->custnum ) {
3353 @cust_main_invoice =
3354 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3356 @cust_main_invoice = ();
3358 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3359 #warn $cust_main_invoice->destnum;
3360 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3361 #warn $cust_main_invoice->destnum;
3362 my $error = $cust_main_invoice->delete;
3363 warn $error if $error;
3366 if ( $self->custnum ) {
3367 @cust_main_invoice =
3368 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3370 @cust_main_invoice = ();
3372 my %seen = map { $_->address => 1 } @cust_main_invoice;
3373 foreach my $address ( @{$arrayref} ) {
3374 next if exists $seen{$address} && $seen{$address};
3375 $seen{$address} = 1;
3376 my $cust_main_invoice = new FS::cust_main_invoice ( {
3377 'custnum' => $self->custnum,
3380 my $error = $cust_main_invoice->insert;
3381 warn $error if $error;
3385 if ( $self->custnum ) {
3387 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3394 =item check_invoicing_list ARRAYREF
3396 Checks these arguements as valid input for the invoicing_list method. If there
3397 is an error, returns the error, otherwise returns false.
3401 sub check_invoicing_list {
3402 my( $self, $arrayref ) = @_;
3404 foreach my $address ( @$arrayref ) {
3406 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3407 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3410 my $cust_main_invoice = new FS::cust_main_invoice ( {
3411 'custnum' => $self->custnum,
3414 my $error = $self->custnum
3415 ? $cust_main_invoice->check
3416 : $cust_main_invoice->checkdest
3418 return $error if $error;
3422 return "Email address required"
3423 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3424 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3429 =item set_default_invoicing_list
3431 Sets the invoicing list to all accounts associated with this customer,
3432 overwriting any previous invoicing list.
3436 sub set_default_invoicing_list {
3438 $self->invoicing_list($self->all_emails);
3443 Returns the email addresses of all accounts provisioned for this customer.
3450 foreach my $cust_pkg ( $self->all_pkgs ) {
3451 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3453 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3454 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3456 $list{$_}=1 foreach map { $_->email } @svc_acct;
3461 =item invoicing_list_addpost
3463 Adds postal invoicing to this customer. If this customer is already configured
3464 to receive postal invoices, does nothing.
3468 sub invoicing_list_addpost {
3470 return if grep { $_ eq 'POST' } $self->invoicing_list;
3471 my @invoicing_list = $self->invoicing_list;
3472 push @invoicing_list, 'POST';
3473 $self->invoicing_list(\@invoicing_list);
3476 =item invoicing_list_emailonly
3478 Returns the list of email invoice recipients (invoicing_list without non-email
3479 destinations such as POST and FAX).
3483 sub invoicing_list_emailonly {
3485 warn "$me invoicing_list_emailonly called"
3487 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3490 =item invoicing_list_emailonly_scalar
3492 Returns the list of email invoice recipients (invoicing_list without non-email
3493 destinations such as POST and FAX) as a comma-separated scalar.
3497 sub invoicing_list_emailonly_scalar {
3499 warn "$me invoicing_list_emailonly_scalar called"
3501 join(', ', $self->invoicing_list_emailonly);
3504 =item contact_list [ CLASSNUM, ... ]
3506 Returns a list of contacts (L<FS::contact> objects) for the customer. If
3507 a list of contact classnums is given, returns only contacts in those
3508 classes. If '0' is given, also returns contacts with no class.
3510 If no arguments are given, returns all contacts for the customer.
3518 select => 'contact.*',
3519 extra_sql => ' WHERE contact.custnum = '.$self->custnum,
3526 push @orwhere, 'contact.classnum is null';
3527 } elsif ( /^\d+$/ ) {
3528 push @classnums, $_;
3530 die "bad classnum argument '$_'";
3535 push @orwhere, 'contact.classnum IN ('.join(',', @classnums).')';
3538 $search->{extra_sql} .= ' AND (' .
3539 join(' OR ', map "( $_ )", @orwhere) .
3546 =item contact_list_email [ CLASSNUM, ... ]
3548 Same as L</contact_list>, but returns email destinations instead of contact
3549 objects. Also accepts 'invoice' as an argument, in which case this will also
3550 return the invoice email address if any.
3554 sub contact_list_email {
3562 push @classnums, $_;
3566 # if the only argument passed was 'invoice' then no classnums are
3567 # intended, so skip this.
3569 my @contacts = $self->contact_list(@classnums);
3570 foreach my $contact (@contacts) {
3571 foreach my $contact_email ($contact->contact_email) {
3572 # unlike on 4.x, we have a separate list of invoice email
3574 # make sure they're not redundant with contact emails
3575 $emails{ $contact_email->emailaddress } =
3576 Email::Address->new( $contact->firstlast,
3577 $contact_email->emailaddress
3582 if ( $and_invoice ) {
3583 foreach my $email ($self->invoicing_list_emailonly) {
3584 $emails{ $email } ||=
3585 Email::Address->new( $self->name_short, $email )->format;
3591 =item referral_custnum_cust_main
3593 Returns the customer who referred this customer (or the empty string, if
3594 this customer was not referred).
3596 Note the difference with referral_cust_main method: This method,
3597 referral_custnum_cust_main returns the single customer (if any) who referred
3598 this customer, while referral_cust_main returns an array of customers referred
3603 sub referral_custnum_cust_main {
3605 return '' unless $self->referral_custnum;
3606 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3609 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3611 Returns an array of customers referred by this customer (referral_custnum set
3612 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3613 customers referred by customers referred by this customer and so on, inclusive.
3614 The default behavior is DEPTH 1 (no recursion).
3616 Note the difference with referral_custnum_cust_main method: This method,
3617 referral_cust_main, returns an array of customers referred BY this customer,
3618 while referral_custnum_cust_main returns the single customer (if any) who
3619 referred this customer.
3623 sub referral_cust_main {
3625 my $depth = @_ ? shift : 1;
3626 my $exclude = @_ ? shift : {};
3629 map { $exclude->{$_->custnum}++; $_; }
3630 grep { ! $exclude->{ $_->custnum } }
3631 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3635 map { $_->referral_cust_main($depth-1, $exclude) }
3642 =item referral_cust_main_ncancelled
3644 Same as referral_cust_main, except only returns customers with uncancelled
3649 sub referral_cust_main_ncancelled {
3651 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3654 =item referral_cust_pkg [ DEPTH ]
3656 Like referral_cust_main, except returns a flat list of all unsuspended (and
3657 uncancelled) packages for each customer. The number of items in this list may
3658 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3662 sub referral_cust_pkg {
3664 my $depth = @_ ? shift : 1;
3666 map { $_->unsuspended_pkgs }
3667 grep { $_->unsuspended_pkgs }
3668 $self->referral_cust_main($depth);
3671 =item referring_cust_main
3673 Returns the single cust_main record for the customer who referred this customer
3674 (referral_custnum), or false.
3678 sub referring_cust_main {
3680 return '' unless $self->referral_custnum;
3681 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3684 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3686 Applies a credit to this customer. If there is an error, returns the error,
3687 otherwise returns false.
3689 REASON can be a text string, an FS::reason object, or a scalar reference to
3690 a reasonnum. If a text string, it will be automatically inserted as a new
3691 reason, and a 'reason_type' option must be passed to indicate the
3692 FS::reason_type for the new reason.
3694 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3695 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3696 I<commission_pkgnum>.
3698 Any other options are passed to FS::cust_credit::insert.
3703 my( $self, $amount, $reason, %options ) = @_;
3705 my $cust_credit = new FS::cust_credit {
3706 'custnum' => $self->custnum,
3707 'amount' => $amount,
3710 if ( ref($reason) ) {
3712 if ( ref($reason) eq 'SCALAR' ) {
3713 $cust_credit->reasonnum( $$reason );
3715 $cust_credit->reasonnum( $reason->reasonnum );
3719 $cust_credit->set('reason', $reason)
3722 $cust_credit->$_( delete $options{$_} )
3723 foreach grep exists($options{$_}),
3724 qw( addlinfo eventnum ),
3725 map "commission_$_", qw( agentnum salesnum pkgnum );
3727 $cust_credit->insert(%options);
3731 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3733 Creates a one-time charge for this customer. If there is an error, returns
3734 the error, otherwise returns false.
3736 New-style, with a hashref of options:
3738 my $error = $cust_main->charge(
3742 'start_date' => str2time('7/4/2009'),
3743 'pkg' => 'Description',
3744 'comment' => 'Comment',
3745 'additional' => [], #extra invoice detail
3746 'classnum' => 1, #pkg_class
3748 'setuptax' => '', # or 'Y' for tax exempt
3750 'locationnum'=> 1234, # optional
3753 'taxclass' => 'Tax class',
3756 'taxproduct' => 2, #part_pkg_taxproduct
3757 'override' => {}, #XXX describe
3759 #will be filled in with the new object
3760 'cust_pkg_ref' => \$cust_pkg,
3762 #generate an invoice immediately
3764 'invoice_terms' => '', #with these terms
3770 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3774 #super false laziness w/quotation::charge
3777 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3778 my ( $pkg, $comment, $additional );
3779 my ( $setuptax, $taxclass ); #internal taxes
3780 my ( $taxproduct, $override ); #vendor (CCH) taxes
3782 my $separate_bill = '';
3783 my $cust_pkg_ref = '';
3784 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3786 if ( ref( $_[0] ) ) {
3787 $amount = $_[0]->{amount};
3788 $setup_cost = $_[0]->{setup_cost};
3789 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3790 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3791 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3792 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3793 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3794 : '$'. sprintf("%.2f",$amount);
3795 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3796 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3797 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3798 $additional = $_[0]->{additional} || [];
3799 $taxproduct = $_[0]->{taxproductnum};
3800 $override = { '' => $_[0]->{tax_override} };
3801 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3802 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3803 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3804 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3805 $separate_bill = $_[0]->{separate_bill} || '';
3811 $pkg = @_ ? shift : 'One-time charge';
3812 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3814 $taxclass = @_ ? shift : '';
3818 local $SIG{HUP} = 'IGNORE';
3819 local $SIG{INT} = 'IGNORE';
3820 local $SIG{QUIT} = 'IGNORE';
3821 local $SIG{TERM} = 'IGNORE';
3822 local $SIG{TSTP} = 'IGNORE';
3823 local $SIG{PIPE} = 'IGNORE';
3825 my $oldAutoCommit = $FS::UID::AutoCommit;
3826 local $FS::UID::AutoCommit = 0;
3829 my $part_pkg = new FS::part_pkg ( {
3831 'comment' => $comment,
3835 'classnum' => ( $classnum ? $classnum : '' ),
3836 'setuptax' => $setuptax,
3837 'taxclass' => $taxclass,
3838 'taxproductnum' => $taxproduct,
3839 'setup_cost' => $setup_cost,
3842 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3843 ( 0 .. @$additional - 1 )
3845 'additional_count' => scalar(@$additional),
3846 'setup_fee' => $amount,
3849 my $error = $part_pkg->insert( options => \%options,
3850 tax_overrides => $override,
3853 $dbh->rollback if $oldAutoCommit;
3857 my $pkgpart = $part_pkg->pkgpart;
3858 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3859 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3860 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3861 $error = $type_pkgs->insert;
3863 $dbh->rollback if $oldAutoCommit;
3868 my $cust_pkg = new FS::cust_pkg ( {
3869 'custnum' => $self->custnum,
3870 'pkgpart' => $pkgpart,
3871 'quantity' => $quantity,
3872 'start_date' => $start_date,
3873 'no_auto' => $no_auto,
3874 'separate_bill' => $separate_bill,
3875 'locationnum'=> $locationnum,
3878 $error = $cust_pkg->insert;
3880 $dbh->rollback if $oldAutoCommit;
3882 } elsif ( $cust_pkg_ref ) {
3883 ${$cust_pkg_ref} = $cust_pkg;
3887 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3888 'pkg_list' => [ $cust_pkg ],
3891 $dbh->rollback if $oldAutoCommit;
3896 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3901 #=item charge_postal_fee
3903 #Applies a one time charge this customer. If there is an error,
3904 #returns the error, returns the cust_pkg charge object or false
3905 #if there was no charge.
3909 # This should be a customer event. For that to work requires that bill
3910 # also be a customer event.
3912 sub charge_postal_fee {
3915 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3916 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3918 my $cust_pkg = new FS::cust_pkg ( {
3919 'custnum' => $self->custnum,
3920 'pkgpart' => $pkgpart,
3924 my $error = $cust_pkg->insert;
3925 $error ? $error : $cust_pkg;
3928 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3930 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3932 Optionally, a list or hashref of additional arguments to the qsearch call can
3939 my $opt = ref($_[0]) ? shift : { @_ };
3941 #return $self->num_cust_bill unless wantarray || keys %$opt;
3943 $opt->{'table'} = 'cust_bill';
3944 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3945 $opt->{'hashref'}{'custnum'} = $self->custnum;
3946 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3948 map { $_ } #behavior of sort undefined in scalar context
3949 sort { $a->_date <=> $b->_date }
3953 =item open_cust_bill
3955 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3960 sub open_cust_bill {
3964 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3970 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3972 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3976 sub legacy_cust_bill {
3979 #return $self->num_legacy_cust_bill unless wantarray;
3981 map { $_ } #behavior of sort undefined in scalar context
3982 sort { $a->_date <=> $b->_date }
3983 qsearch({ 'table' => 'legacy_cust_bill',
3984 'hashref' => { 'custnum' => $self->custnum, },
3985 'order_by' => 'ORDER BY _date ASC',
3989 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3991 Returns all the statements (see L<FS::cust_statement>) for this customer.
3993 Optionally, a list or hashref of additional arguments to the qsearch call can
3998 =item cust_bill_void
4000 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
4004 sub cust_bill_void {
4007 map { $_ } #return $self->num_cust_bill_void unless wantarray;
4008 sort { $a->_date <=> $b->_date }
4009 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
4012 sub cust_statement {
4014 my $opt = ref($_[0]) ? shift : { @_ };
4016 #return $self->num_cust_statement unless wantarray || keys %$opt;
4018 $opt->{'table'} = 'cust_statement';
4019 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
4020 $opt->{'hashref'}{'custnum'} = $self->custnum;
4021 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
4023 map { $_ } #behavior of sort undefined in scalar context
4024 sort { $a->_date <=> $b->_date }
4028 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
4030 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
4032 Optionally, a list or hashref of additional arguments to the qsearch call can
4033 be passed following the SVCDB.
4040 if ( ! $svcdb =~ /^svc_\w+$/ ) {
4041 warn "$me svc_x requires a svcdb";
4044 my $opt = ref($_[0]) ? shift : { @_ };
4046 $opt->{'table'} = $svcdb;
4047 $opt->{'addl_from'} =
4048 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
4049 ($opt->{'addl_from'} || '');
4051 my $custnum = $self->custnum;
4052 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
4053 my $where = "cust_pkg.custnum = $custnum";
4055 my $extra_sql = $opt->{'extra_sql'} || '';
4056 if ( keys %{ $opt->{'hashref'} } ) {
4057 $extra_sql = " AND $where $extra_sql";
4060 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
4061 $extra_sql = "WHERE $where AND $1";
4064 $extra_sql = "WHERE $where $extra_sql";
4067 $opt->{'extra_sql'} = $extra_sql;
4072 # required for use as an eventtable;
4075 $self->svc_x('svc_acct', @_);
4080 Returns all the credits (see L<FS::cust_credit>) for this customer.
4086 map { $_ } #return $self->num_cust_credit unless wantarray;
4087 sort { $a->_date <=> $b->_date }
4088 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4091 =item cust_credit_pkgnum
4093 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
4094 package when using experimental package balances.
4098 sub cust_credit_pkgnum {
4099 my( $self, $pkgnum ) = @_;
4100 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
4101 sort { $a->_date <=> $b->_date }
4102 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
4103 'pkgnum' => $pkgnum,
4108 =item cust_credit_void
4110 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
4114 sub cust_credit_void {
4117 sort { $a->_date <=> $b->_date }
4118 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
4123 Returns all the payments (see L<FS::cust_pay>) for this customer.
4129 my $opt = ref($_[0]) ? shift : { @_ };
4131 return $self->num_cust_pay unless wantarray || keys %$opt;
4133 $opt->{'table'} = 'cust_pay';
4134 $opt->{'hashref'}{'custnum'} = $self->custnum;
4136 map { $_ } #behavior of sort undefined in scalar context
4137 sort { $a->_date <=> $b->_date }
4144 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
4145 called automatically when the cust_pay method is used in a scalar context.
4151 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
4152 my $sth = dbh->prepare($sql) or die dbh->errstr;
4153 $sth->execute($self->custnum) or die $sth->errstr;
4154 $sth->fetchrow_arrayref->[0];
4157 =item unapplied_cust_pay
4159 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
4163 sub unapplied_cust_pay {
4167 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
4173 =item cust_pay_pkgnum
4175 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
4176 package when using experimental package balances.
4180 sub cust_pay_pkgnum {
4181 my( $self, $pkgnum ) = @_;
4182 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
4183 sort { $a->_date <=> $b->_date }
4184 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
4185 'pkgnum' => $pkgnum,
4192 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4198 map { $_ } #return $self->num_cust_pay_void unless wantarray;
4199 sort { $a->_date <=> $b->_date }
4200 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4203 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
4205 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
4207 Optionally, a list or hashref of additional arguments to the qsearch call can
4212 sub cust_pay_batch {
4214 my $opt = ref($_[0]) ? shift : { @_ };
4216 #return $self->num_cust_statement unless wantarray || keys %$opt;
4218 $opt->{'table'} = 'cust_pay_batch';
4219 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
4220 $opt->{'hashref'}{'custnum'} = $self->custnum;
4221 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
4223 map { $_ } #behavior of sort undefined in scalar context
4224 sort { $a->paybatchnum <=> $b->paybatchnum }
4228 =item cust_pay_pending
4230 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
4231 (without status "done").
4235 sub cust_pay_pending {
4237 return $self->num_cust_pay_pending unless wantarray;
4238 sort { $a->_date <=> $b->_date }
4239 qsearch( 'cust_pay_pending', {
4240 'custnum' => $self->custnum,
4241 'status' => { op=>'!=', value=>'done' },
4246 =item cust_pay_pending_attempt
4248 Returns all payment attempts / declined payments for this customer, as pending
4249 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
4250 a corresponding payment (see L<FS::cust_pay>).
4254 sub cust_pay_pending_attempt {
4256 return $self->num_cust_pay_pending_attempt unless wantarray;
4257 sort { $a->_date <=> $b->_date }
4258 qsearch( 'cust_pay_pending', {
4259 'custnum' => $self->custnum,
4266 =item num_cust_pay_pending
4268 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
4269 customer (without status "done"). Also called automatically when the
4270 cust_pay_pending method is used in a scalar context.
4274 sub num_cust_pay_pending {
4277 " SELECT COUNT(*) FROM cust_pay_pending ".
4278 " WHERE custnum = ? AND status != 'done' ",
4283 =item num_cust_pay_pending_attempt
4285 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
4286 customer, with status "done" but without a corresp. Also called automatically when the
4287 cust_pay_pending method is used in a scalar context.
4291 sub num_cust_pay_pending_attempt {
4294 " SELECT COUNT(*) FROM cust_pay_pending ".
4295 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
4302 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4308 map { $_ } #return $self->num_cust_refund unless wantarray;
4309 sort { $a->_date <=> $b->_date }
4310 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4313 =item display_custnum
4315 Returns the displayed customer number for this customer: agent_custid if
4316 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
4320 sub display_custnum {
4323 return $self->agent_custid
4324 if $default_agent_custid && $self->agent_custid;
4326 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
4330 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
4331 } elsif ( $custnum_display_length ) {
4332 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
4334 return $self->custnum;
4340 Returns a name string for this customer, either "Company (Last, First)" or
4347 my $name = $self->contact;
4348 $name = $self->company. " ($name)" if $self->company;
4352 =item service_contact
4354 Returns the L<FS::contact> object for this customer that has the 'Service'
4355 contact class, or undef if there is no such contact. Deprecated; don't use
4360 sub service_contact {
4362 if ( !exists($self->{service_contact}) ) {
4363 my $classnum = $self->scalar_sql(
4364 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4365 ) || 0; #if it's zero, qsearchs will return nothing
4366 $self->{service_contact} = qsearchs('contact', {
4367 'classnum' => $classnum, 'custnum' => $self->custnum
4370 $self->{service_contact};
4375 Returns a name string for this (service/shipping) contact, either
4376 "Company (Last, First)" or "Last, First".
4383 my $name = $self->ship_contact;
4384 $name = $self->company. " ($name)" if $self->company;
4390 Returns a name string for this customer, either "Company" or "First Last".
4396 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4399 =item ship_name_short
4401 Returns a name string for this (service/shipping) contact, either "Company"
4406 sub ship_name_short {
4408 $self->service_contact
4409 ? $self->ship_contact_firstlast
4415 Returns this customer's full (billing) contact name only, "Last, First"
4421 $self->get('last'). ', '. $self->first;
4426 Returns this customer's full (shipping) contact name only, "Last, First"
4432 my $contact = $self->service_contact || $self;
4433 $contact->get('last') . ', ' . $contact->get('first');
4436 =item contact_firstlast
4438 Returns this customers full (billing) contact name only, "First Last".
4442 sub contact_firstlast {
4444 $self->first. ' '. $self->get('last');
4447 =item ship_contact_firstlast
4449 Returns this customer's full (shipping) contact name only, "First Last".
4453 sub ship_contact_firstlast {
4455 my $contact = $self->service_contact || $self;
4456 $contact->get('first') . ' '. $contact->get('last');
4459 sub bill_country_full {
4461 $self->bill_location->country_full;
4464 sub ship_country_full {
4466 $self->ship_location->country_full;
4469 =item county_state_county [ PREFIX ]
4471 Returns a string consisting of just the county, state and country.
4475 sub county_state_country {
4478 if ( @_ && $_[0] && $self->has_ship_address ) {
4479 $locationnum = $self->ship_locationnum;
4481 $locationnum = $self->bill_locationnum;
4483 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4484 $cust_location->county_state_country;
4487 =item geocode DATA_VENDOR
4489 Returns a value for the customer location as encoded by DATA_VENDOR.
4490 Currently this only makes sense for "CCH" as DATA_VENDOR.
4498 Returns a status string for this customer, currently:
4502 =item prospect - No packages have ever been ordered
4504 =item ordered - Recurring packages all are new (not yet billed).
4506 =item active - One or more recurring packages is active
4508 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4510 =item suspended - All non-cancelled recurring packages are suspended
4512 =item cancelled - All recurring packages are cancelled
4516 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4517 cust_main-status_module configuration option.
4521 sub status { shift->cust_status(@_); }
4525 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4526 for my $status ( FS::cust_main->statuses() ) {
4527 my $method = $status.'_sql';
4528 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4529 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4530 $sth->execute( ($self->custnum) x $numnum )
4531 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4532 if ( $sth->fetchrow_arrayref->[0] ) {
4533 $self->hashref->{cust_status} = $status;
4539 =item is_status_delay_cancel
4541 Returns true if customer status is 'suspended'
4542 and all suspended cust_pkg return true for
4543 cust_pkg->is_status_delay_cancel.
4545 This is not a real status, this only meant for hacking display
4546 values, because otherwise treating the customer as suspended is
4547 really the whole point of the delay_cancel option.
4551 sub is_status_delay_cancel {
4553 return 0 unless $self->status eq 'suspended';
4554 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4555 return 0 unless $cust_pkg->is_status_delay_cancel;
4560 =item ucfirst_cust_status
4562 =item ucfirst_status
4564 Returns the status with the first character capitalized.
4568 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4570 sub ucfirst_cust_status {
4572 ucfirst($self->cust_status);
4577 Returns a hex triplet color string for this customer's status.
4581 sub statuscolor { shift->cust_statuscolor(@_); }
4583 sub cust_statuscolor {
4585 __PACKAGE__->statuscolors->{$self->cust_status};
4588 =item tickets [ STATUS ]
4590 Returns an array of hashes representing the customer's RT tickets.
4592 An optional status (or arrayref or hashref of statuses) may be specified.
4598 my $status = ( @_ && $_[0] ) ? shift : '';
4600 my $num = $conf->config('cust_main-max_tickets') || 10;
4603 if ( $conf->config('ticket_system') ) {
4604 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4606 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4615 foreach my $priority (
4616 $conf->config('ticket_system-custom_priority_field-values'), ''
4618 last if scalar(@tickets) >= $num;
4620 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4621 $num - scalar(@tickets),
4632 =item appointments [ STATUS ]
4634 Returns an array of hashes representing the customer's RT tickets which
4641 my $status = ( @_ && $_[0] ) ? shift : '';
4643 return () unless $conf->config('ticket_system');
4645 my $queueid = $conf->config('ticket_system-appointment-queueid');
4647 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4656 # Return services representing svc_accts in customer support packages
4657 sub support_services {
4659 my %packages = map { $_ => 1 } $conf->config('support_packages');
4661 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4662 grep { $_->part_svc->svcdb eq 'svc_acct' }
4663 map { $_->cust_svc }
4664 grep { exists $packages{ $_->pkgpart } }
4665 $self->ncancelled_pkgs;
4669 # Return a list of latitude/longitude for one of the services (if any)
4670 sub service_coordinates {
4674 grep { $_->latitude && $_->longitude }
4676 map { $_->cust_svc }
4677 $self->ncancelled_pkgs;
4679 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4684 Returns a masked version of the named field
4689 my ($self,$field) = @_;
4693 'x'x(length($self->getfield($field))-4).
4694 substr($self->getfield($field), (length($self->getfield($field))-4));
4698 =item payment_history
4700 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4701 cust_credit and cust_refund objects. Each hashref has the following fields:
4703 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4705 I<date> - value of _date field, unix timestamp
4707 I<date_pretty> - user-friendly date
4709 I<description> - user-friendly description of item
4711 I<amount> - impact of item on user's balance
4712 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4713 Not to be confused with the native 'amount' field in cust_credit, see below.
4715 I<amount_pretty> - includes money char
4717 I<balance> - customer balance, chronologically as of this item
4719 I<balance_pretty> - includes money char
4721 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4723 I<paid> - amount paid for cust_pay records, undef for other types
4725 I<credit> - amount credited for cust_credit records, undef for other types.
4726 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4728 I<refund> - amount refunded for cust_refund records, undef for other types
4730 The four table-specific keys always have positive values, whether they reflect charges or payments.
4732 The following options may be passed to this method:
4734 I<line_items> - if true, returns charges ('Line item') rather than invoices
4736 I<start_date> - unix timestamp, only include records on or after.
4737 If specified, an item of type 'Previous' will also be included.
4738 It does not have table-specific fields.
4740 I<end_date> - unix timestamp, only include records before
4742 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4744 I<conf> - optional already-loaded FS::Conf object.
4748 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4749 # and also for sending customer statements, which should both be kept customer-friendly.
4750 # If you add anything that shouldn't be passed on through the API or exposed
4751 # to customers, add a new option to include it, don't include it by default
4752 sub payment_history {
4754 my $opt = ref($_[0]) ? $_[0] : { @_ };
4756 my $conf = $$opt{'conf'} || new FS::Conf;
4757 my $money_char = $conf->config("money_char") || '$',
4759 #first load entire history,
4760 #need previous to calculate previous balance
4761 #loading after end_date shouldn't hurt too much?
4763 if ( $$opt{'line_items'} ) {
4765 foreach my $cust_bill ( $self->cust_bill ) {
4768 'type' => 'Line item',
4769 'description' => $_->desc( $self->locale ).
4770 ( $_->sdate && $_->edate
4771 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4772 ' To '. time2str('%d-%b-%Y', $_->edate)
4775 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4776 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4777 'date' => $cust_bill->_date,
4778 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4780 foreach $cust_bill->cust_bill_pkg;
4787 'type' => 'Invoice',
4788 'description' => 'Invoice #'. $_->display_invnum,
4789 'amount' => sprintf('%.2f', $_->charged ),
4790 'charged' => sprintf('%.2f', $_->charged ),
4791 'date' => $_->_date,
4792 'date_pretty' => $self->time2str_local('short', $_->_date ),
4794 foreach $self->cust_bill;
4799 'type' => 'Payment',
4800 'description' => 'Payment', #XXX type
4801 'amount' => sprintf('%.2f', 0 - $_->paid ),
4802 'paid' => sprintf('%.2f', $_->paid ),
4803 'date' => $_->_date,
4804 'date_pretty' => $self->time2str_local('short', $_->_date ),
4806 foreach $self->cust_pay;
4810 'description' => 'Credit', #more info?
4811 'amount' => sprintf('%.2f', 0 -$_->amount ),
4812 'credit' => sprintf('%.2f', $_->amount ),
4813 'date' => $_->_date,
4814 'date_pretty' => $self->time2str_local('short', $_->_date ),
4816 foreach $self->cust_credit;
4820 'description' => 'Refund', #more info? type, like payment?
4821 'amount' => $_->refund,
4822 'refund' => $_->refund,
4823 'date' => $_->_date,
4824 'date_pretty' => $self->time2str_local('short', $_->_date ),
4826 foreach $self->cust_refund;
4828 #put it all in chronological order
4829 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4831 #calculate balance, filter items outside date range
4835 foreach my $item (@history) {
4836 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4837 $balance += $$item{'amount'};
4838 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4839 $previous += $$item{'amount'};
4842 $$item{'balance'} = sprintf("%.2f",$balance);
4843 foreach my $key ( qw(amount balance) ) {
4844 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4849 # start with previous balance, if there was one
4852 'type' => 'Previous',
4853 'description' => 'Previous balance',
4854 'amount' => sprintf("%.2f",$previous),
4855 'balance' => sprintf("%.2f",$previous),
4856 'date' => $$opt{'start_date'},
4857 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4859 #false laziness with above
4860 foreach my $key ( qw(amount balance) ) {
4861 $$item{$key.'_pretty'} = $$item{$key};
4862 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4864 unshift(@out,$item);
4867 @out = reverse @history if $$opt{'reverse_sort'};
4874 =head1 CLASS METHODS
4880 Class method that returns the list of possible status strings for customers
4881 (see L<the status method|/status>). For example:
4883 @statuses = FS::cust_main->statuses();
4889 keys %{ $self->statuscolors };
4892 =item cust_status_sql
4894 Returns an SQL fragment to determine the status of a cust_main record, as a
4899 sub cust_status_sql {
4901 for my $status ( FS::cust_main->statuses() ) {
4902 my $method = $status.'_sql';
4903 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4912 Returns an SQL expression identifying prospective cust_main records (customers
4913 with no packages ever ordered)
4917 use vars qw($select_count_pkgs);
4918 $select_count_pkgs =
4919 "SELECT COUNT(*) FROM cust_pkg
4920 WHERE cust_pkg.custnum = cust_main.custnum";
4922 sub select_count_pkgs_sql {
4927 " 0 = ( $select_count_pkgs ) ";
4932 Returns an SQL expression identifying ordered cust_main records (customers with
4933 no active packages, but recurring packages not yet setup or one time charges
4939 FS::cust_main->none_active_sql.
4940 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4945 Returns an SQL expression identifying active cust_main records (customers with
4946 active recurring packages).
4951 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4954 =item none_active_sql
4956 Returns an SQL expression identifying cust_main records with no active
4957 recurring packages. This includes customers of status prospect, ordered,
4958 inactive, and suspended.
4962 sub none_active_sql {
4963 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4968 Returns an SQL expression identifying inactive cust_main records (customers with
4969 no active recurring packages, but otherwise unsuspended/uncancelled).
4974 FS::cust_main->none_active_sql.
4975 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4981 Returns an SQL expression identifying suspended cust_main records.
4986 sub suspended_sql { susp_sql(@_); }
4988 FS::cust_main->none_active_sql.
4989 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4995 Returns an SQL expression identifying cancelled cust_main records.
4999 sub cancel_sql { shift->cancelled_sql(@_); }
5002 =item uncancelled_sql
5004 Returns an SQL expression identifying un-cancelled cust_main records.
5008 sub uncancelled_sql { uncancel_sql(@_); }
5011 "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
5016 Returns an SQL fragment to retreive the balance.
5021 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5022 WHERE cust_bill.custnum = cust_main.custnum )
5023 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5024 WHERE cust_pay.custnum = cust_main.custnum )
5025 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5026 WHERE cust_credit.custnum = cust_main.custnum )
5027 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5028 WHERE cust_refund.custnum = cust_main.custnum )
5031 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
5033 Returns an SQL fragment to retreive the balance for this customer, optionally
5034 considering invoices with date earlier than START_TIME, and not
5035 later than END_TIME (total_owed_date minus total_unapplied_credits minus
5036 total_unapplied_payments).
5038 Times are specified as SQL fragments or numeric
5039 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5040 L<Date::Parse> for conversion functions. The empty string can be passed
5041 to disable that time constraint completely.
5043 Available options are:
5047 =item unapplied_date
5049 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)
5054 set to true to remove all customer comparison clauses, for totals
5059 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5064 JOIN clause (typically used with the total option)
5068 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
5069 time will be ignored. Note that START_TIME and END_TIME only limit the date
5070 range for invoices and I<unapplied> payments, credits, and refunds.
5076 sub balance_date_sql {
5077 my( $class, $start, $end, %opt ) = @_;
5079 my $cutoff = $opt{'cutoff'};
5081 my $owed = FS::cust_bill->owed_sql($cutoff);
5082 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
5083 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
5084 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5086 my $j = $opt{'join'} || '';
5088 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5089 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5090 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5091 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5093 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5094 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5095 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5096 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5101 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
5103 Returns an SQL fragment to retreive the total unapplied payments for this
5104 customer, only considering payments with date earlier than START_TIME, and
5105 optionally not later than END_TIME.
5107 Times are specified as SQL fragments or numeric
5108 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5109 L<Date::Parse> for conversion functions. The empty string can be passed
5110 to disable that time constraint completely.
5112 Available options are:
5116 sub unapplied_payments_date_sql {
5117 my( $class, $start, $end, %opt ) = @_;
5119 my $cutoff = $opt{'cutoff'};
5121 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5123 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
5124 'unapplied_date'=>1 );
5126 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
5129 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5131 Helper method for balance_date_sql; name (and usage) subject to change
5132 (suggestions welcome).
5134 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5135 cust_refund, cust_credit or cust_pay).
5137 If TABLE is "cust_bill" or the unapplied_date option is true, only
5138 considers records with date earlier than START_TIME, and optionally not
5139 later than END_TIME .
5143 sub _money_table_where {
5144 my( $class, $table, $start, $end, %opt ) = @_;
5147 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5148 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5149 push @where, "$table._date <= $start" if defined($start) && length($start);
5150 push @where, "$table._date > $end" if defined($end) && length($end);
5152 push @where, @{$opt{'where'}} if $opt{'where'};
5153 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5159 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
5160 use FS::cust_main::Search;
5163 FS::cust_main::Search->search(@_);
5178 #warn join('-',keys %$param);
5179 my $fh = $param->{filehandle};
5180 my $agentnum = $param->{agentnum};
5181 my $format = $param->{format};
5183 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
5186 if ( $format eq 'simple' ) {
5187 @fields = qw( custnum agent_custid amount pkg );
5189 die "unknown format $format";
5192 eval "use Text::CSV_XS;";
5195 my $csv = new Text::CSV_XS;
5202 local $SIG{HUP} = 'IGNORE';
5203 local $SIG{INT} = 'IGNORE';
5204 local $SIG{QUIT} = 'IGNORE';
5205 local $SIG{TERM} = 'IGNORE';
5206 local $SIG{TSTP} = 'IGNORE';
5207 local $SIG{PIPE} = 'IGNORE';
5209 my $oldAutoCommit = $FS::UID::AutoCommit;
5210 local $FS::UID::AutoCommit = 0;
5213 #while ( $columns = $csv->getline($fh) ) {
5215 while ( defined($line=<$fh>) ) {
5217 $csv->parse($line) or do {
5218 $dbh->rollback if $oldAutoCommit;
5219 return "can't parse: ". $csv->error_input();
5222 my @columns = $csv->fields();
5223 #warn join('-',@columns);
5226 foreach my $field ( @fields ) {
5227 $row{$field} = shift @columns;
5230 if ( $row{custnum} && $row{agent_custid} ) {
5231 dbh->rollback if $oldAutoCommit;
5232 return "can't specify custnum with agent_custid $row{agent_custid}";
5236 if ( $row{agent_custid} && $agentnum ) {
5237 %hash = ( 'agent_custid' => $row{agent_custid},
5238 'agentnum' => $agentnum,
5242 if ( $row{custnum} ) {
5243 %hash = ( 'custnum' => $row{custnum} );
5246 unless ( scalar(keys %hash) ) {
5247 $dbh->rollback if $oldAutoCommit;
5248 return "can't find customer without custnum or agent_custid and agentnum";
5251 my $cust_main = qsearchs('cust_main', { %hash } );
5252 unless ( $cust_main ) {
5253 $dbh->rollback if $oldAutoCommit;
5254 my $custnum = $row{custnum} || $row{agent_custid};
5255 return "unknown custnum $custnum";
5258 if ( $row{'amount'} > 0 ) {
5259 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
5261 $dbh->rollback if $oldAutoCommit;
5265 } elsif ( $row{'amount'} < 0 ) {
5266 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
5269 $dbh->rollback if $oldAutoCommit;
5279 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5281 return "Empty file!" unless $imported;
5287 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5289 Deprecated. Use event notification and message templates
5290 (L<FS::msg_template>) instead.
5292 Sends a templated email notification to the customer (see L<Text::Template>).
5294 OPTIONS is a hash and may include
5296 I<from> - the email sender (default is invoice_from)
5298 I<to> - comma-separated scalar or arrayref of recipients
5299 (default is invoicing_list)
5301 I<subject> - The subject line of the sent email notification
5302 (default is "Notice from company_name")
5304 I<extra_fields> - a hashref of name/value pairs which will be substituted
5307 The following variables are vavailable in the template.
5309 I<$first> - the customer first name
5310 I<$last> - the customer last name
5311 I<$company> - the customer company
5312 I<$payby> - a description of the method of payment for the customer
5313 # would be nice to use FS::payby::shortname
5314 I<$payinfo> - the account information used to collect for this customer
5315 I<$expdate> - the expiration of the customer payment in seconds from epoch
5320 my ($self, $template, %options) = @_;
5322 return unless $conf->exists($template);
5324 my $from = $conf->invoice_from_full($self->agentnum)
5325 if $conf->exists('invoice_from', $self->agentnum);
5326 $from = $options{from} if exists($options{from});
5328 my $to = join(',', $self->invoicing_list_emailonly);
5329 $to = $options{to} if exists($options{to});
5331 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
5332 if $conf->exists('company_name', $self->agentnum);
5333 $subject = $options{subject} if exists($options{subject});
5335 my $notify_template = new Text::Template (TYPE => 'ARRAY',
5336 SOURCE => [ map "$_\n",
5337 $conf->config($template)]
5339 or die "can't create new Text::Template object: Text::Template::ERROR";
5340 $notify_template->compile()
5341 or die "can't compile template: Text::Template::ERROR";
5343 $FS::notify_template::_template::company_name =
5344 $conf->config('company_name', $self->agentnum);
5345 $FS::notify_template::_template::company_address =
5346 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
5348 my $paydate = $self->paydate || '2037-12-31';
5349 $FS::notify_template::_template::first = $self->first;
5350 $FS::notify_template::_template::last = $self->last;
5351 $FS::notify_template::_template::company = $self->company;
5352 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
5353 my $payby = $self->payby;
5354 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5355 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5357 #credit cards expire at the end of the month/year of their exp date
5358 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5359 $FS::notify_template::_template::payby = 'credit card';
5360 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5361 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5363 }elsif ($payby eq 'COMP') {
5364 $FS::notify_template::_template::payby = 'complimentary account';
5366 $FS::notify_template::_template::payby = 'current method';
5368 $FS::notify_template::_template::expdate = $expire_time;
5370 for (keys %{$options{extra_fields}}){
5372 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5375 send_email(from => $from,
5377 subject => $subject,
5378 body => $notify_template->fill_in( PACKAGE =>
5379 'FS::notify_template::_template' ),
5384 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5386 Generates a templated notification to the customer (see L<Text::Template>).
5388 OPTIONS is a hash and may include
5390 I<extra_fields> - a hashref of name/value pairs which will be substituted
5391 into the template. These values may override values mentioned below
5392 and those from the customer record.
5394 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5396 The following variables are available in the template instead of or in addition
5397 to the fields of the customer record.
5399 I<$payby> - a description of the method of payment for the customer
5400 # would be nice to use FS::payby::shortname
5401 I<$payinfo> - the masked account information used to collect for this customer
5402 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5403 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5407 # a lot like cust_bill::print_latex
5408 sub generate_letter {
5409 my ($self, $template, %options) = @_;
5411 warn "Template $template does not exist" && return
5412 unless $conf->exists($template) || $options{'template_text'};
5414 my $template_source = $options{'template_text'}
5415 ? [ $options{'template_text'} ]
5416 : [ map "$_\n", $conf->config($template) ];
5418 my $letter_template = new Text::Template
5420 SOURCE => $template_source,
5421 DELIMITERS => [ '[@--', '--@]' ],
5423 or die "can't create new Text::Template object: Text::Template::ERROR";
5425 $letter_template->compile()
5426 or die "can't compile template: Text::Template::ERROR";
5428 my %letter_data = map { $_ => $self->$_ } $self->fields;
5429 $letter_data{payinfo} = $self->mask_payinfo;
5431 #my $paydate = $self->paydate || '2037-12-31';
5432 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
5434 my $payby = $self->payby;
5435 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5436 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5438 #credit cards expire at the end of the month/year of their exp date
5439 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5440 $letter_data{payby} = 'credit card';
5441 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5442 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5444 }elsif ($payby eq 'COMP') {
5445 $letter_data{payby} = 'complimentary account';
5447 $letter_data{payby} = 'current method';
5449 $letter_data{expdate} = $expire_time;
5451 for (keys %{$options{extra_fields}}){
5452 $letter_data{$_} = $options{extra_fields}->{$_};
5455 unless(exists($letter_data{returnaddress})){
5456 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5457 $self->agent_template)
5459 if ( length($retadd) ) {
5460 $letter_data{returnaddress} = $retadd;
5461 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5462 $letter_data{returnaddress} =
5463 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5467 ( $conf->config('company_name', $self->agentnum),
5468 $conf->config('company_address', $self->agentnum),
5472 $letter_data{returnaddress} = '~';
5476 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5478 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5480 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5482 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5486 ) or die "can't open temp file: $!\n";
5487 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5488 or die "can't write temp file: $!\n";
5490 $letter_data{'logo_file'} = $lh->filename;
5492 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5496 ) or die "can't open temp file: $!\n";
5498 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5500 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5501 return ($1, $letter_data{'logo_file'});
5505 =item print_ps TEMPLATE
5507 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5513 my($file, $lfile) = $self->generate_letter(@_);
5514 my $ps = FS::Misc::generate_ps($file);
5515 unlink($file.'.tex');
5521 =item print TEMPLATE
5523 Prints the filled in template.
5525 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5529 sub queueable_print {
5532 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5533 or die "invalid customer number: " . $opt{custnum};
5535 my $error = $self->print( { 'template' => $opt{template} } );
5536 die $error if $error;
5540 my ($self, $template) = (shift, shift);
5542 [ $self->print_ps($template) ],
5543 'agentnum' => $self->agentnum,
5547 #these three subs should just go away once agent stuff is all config overrides
5549 sub agent_template {
5551 $self->_agent_plandata('agent_templatename');
5554 sub agent_invoice_from {
5556 $self->_agent_plandata('agent_invoice_from');
5559 sub _agent_plandata {
5560 my( $self, $option ) = @_;
5562 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5563 #agent-specific Conf
5565 use FS::part_event::Condition;
5567 my $agentnum = $self->agentnum;
5569 my $regexp = regexp_sql();
5571 my $part_event_option =
5573 'select' => 'part_event_option.*',
5574 'table' => 'part_event_option',
5576 LEFT JOIN part_event USING ( eventpart )
5577 LEFT JOIN part_event_option AS peo_agentnum
5578 ON ( part_event.eventpart = peo_agentnum.eventpart
5579 AND peo_agentnum.optionname = 'agentnum'
5580 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5582 LEFT JOIN part_event_condition
5583 ON ( part_event.eventpart = part_event_condition.eventpart
5584 AND part_event_condition.conditionname = 'cust_bill_age'
5586 LEFT JOIN part_event_condition_option
5587 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5588 AND part_event_condition_option.optionname = 'age'
5591 #'hashref' => { 'optionname' => $option },
5592 #'hashref' => { 'part_event_option.optionname' => $option },
5594 " WHERE part_event_option.optionname = ". dbh->quote($option).
5595 " AND action = 'cust_bill_send_agent' ".
5596 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5597 " AND peo_agentnum.optionname = 'agentnum' ".
5598 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5600 CASE WHEN part_event_condition_option.optionname IS NULL
5602 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5604 , part_event.weight".
5608 unless ( $part_event_option ) {
5609 return $self->agent->invoice_template || ''
5610 if $option eq 'agent_templatename';
5614 $part_event_option->optionvalue;
5618 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5620 Subroutine (not a method), designed to be called from the queue.
5622 Takes a list of options and values.
5624 Pulls up the customer record via the custnum option and calls bill_and_collect.
5629 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5631 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5632 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5634 #without this errors don't get rolled back
5635 $args{'fatal'} = 1; # runs from job queue, will be caught
5637 $cust_main->bill_and_collect( %args );
5640 sub process_bill_and_collect {
5642 my $param = thaw(decode_base64(shift));
5643 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5644 or die "custnum '$param->{custnum}' not found!\n";
5645 $param->{'job'} = $job;
5646 $param->{'fatal'} = 1; # runs from job queue, will be caught
5647 $param->{'retry'} = 1;
5649 $cust_main->bill_and_collect( %$param );
5652 #starting to take quite a while for big dbs
5653 # (JRNL: journaled so it only happens once per database)
5654 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5655 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5656 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5657 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5658 # JRNL leading/trailing spaces in first, last, company
5659 # - otaker upgrade? journal and call it good? (double check to make sure
5660 # we're not still setting otaker here)
5662 #only going to get worse with new location stuff...
5664 sub _upgrade_data { #class method
5665 my ($class, %opts) = @_;
5668 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5671 #this seems to be the only expensive one.. why does it take so long?
5672 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5674 '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';
5675 FS::upgrade_journal->set_done('cust_main__signupdate');
5678 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5680 # fix yyyy-m-dd formatted paydates
5681 if ( driver_name =~ /^mysql/i ) {
5683 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5684 } else { # the SQL standard
5686 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5688 FS::upgrade_journal->set_done('cust_main__paydate');
5691 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5693 push @statements, #fix the weird BILL with a cc# in payinfo problem
5695 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5697 FS::upgrade_journal->set_done('cust_main__payinfo');
5702 foreach my $sql ( @statements ) {
5703 my $sth = dbh->prepare($sql) or die dbh->errstr;
5704 $sth->execute or die $sth->errstr;
5705 #warn ( (time - $t). " seconds\n" );
5709 local($ignore_expired_card) = 1;
5710 local($ignore_banned_card) = 1;
5711 local($skip_fuzzyfiles) = 1;
5712 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5714 FS::cust_main::Location->_upgrade_data(%opts);
5716 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5718 foreach my $cust_main ( qsearch({
5719 'table' => 'cust_main',
5721 'extra_sql' => 'WHERE '.
5723 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5724 qw( first last company )
5727 my $error = $cust_main->replace;
5728 die $error if $error;
5731 FS::upgrade_journal->set_done('cust_main__trimspaces');
5735 $class->_upgrade_otaker(%opts);
5737 # turn on encryption as part of regular upgrade, so all new records are immediately encrypted
5738 # existing records will be encrypted in queueable_upgrade (below)
5739 unless ($conf->exists('encryptionpublickey') || $conf->exists('encryptionprivatekey')) {
5740 eval "use FS::Setup";
5742 FS::Setup::enable_encryption();
5747 sub queueable_upgrade {
5750 ### encryption gets turned on in _upgrade_data, above
5752 eval "use FS::upgrade_journal";
5755 # prior to 2013 (commit f16665c9) payinfo was stored in history if not encrypted,
5756 # clear that out before encrypting/tokenizing anything else
5757 if (!FS::upgrade_journal->is_done('clear_payinfo_history')) {
5758 foreach my $table ('cust_main','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
5759 my $sql = 'UPDATE h_'.$table.' SET payinfo = NULL WHERE payinfo IS NOT NULL';
5760 my $sth = dbh->prepare($sql) or die dbh->errstr;
5761 $sth->execute or die $sth->errstr;
5763 FS::upgrade_journal->set_done('clear_payinfo_history');
5766 # encrypt old records
5767 if ($conf->exists('encryption') && !FS::upgrade_journal->is_done('encryption_check')) {
5769 # allow replacement of closed cust_pay/cust_refund records
5770 local $FS::payinfo_Mixin::allow_closed_replace = 1;
5772 # because it looks like nothing's changing
5773 local $FS::Record::no_update_diff = 1;
5775 # commit everything immediately
5776 local $FS::UID::AutoCommit = 1;
5778 # encrypt what's there
5779 foreach my $table ('cust_main','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
5780 my $tclass = 'FS::'.$table;
5783 while (my $recnum = _upgrade_next_recnum(dbh,$table,\$lastrecnum,\@recnums)) {
5784 my $record = $tclass->by_key($recnum);
5785 next unless $record; # small chance it's been deleted, that's ok
5786 next unless grep { $record->payby eq $_ } @FS::Record::encrypt_payby;
5787 # window for possible conflict is practically nonexistant,
5788 # but just in case...
5789 $record = $record->select_for_update;
5790 if (!$record->custnum && $table eq 'cust_pay_pending') {
5791 $record->set('custnum_pending',1);
5793 my $error = $record->replace;
5794 die $error if $error;
5798 FS::upgrade_journal->set_done('encryption_check');
5803 # not entirely false laziness w/ Billing_Realtime::_token_check_next_recnum
5804 # cust_payby might get deleted while this runs
5806 sub _upgrade_next_recnum {
5807 my ($dbh,$table,$lastrecnum,$recnums) = @_;
5808 my $recnum = shift @$recnums;
5809 return $recnum if $recnum;
5810 my $tclass = 'FS::'.$table;
5811 my $sql = 'SELECT '.$tclass->primary_key.
5813 ' WHERE '.$tclass->primary_key.' > '.$$lastrecnum.
5814 ' ORDER BY '.$tclass->primary_key.' LIMIT 500';;
5815 my $sth = $dbh->prepare($sql) or die $dbh->errstr;
5816 $sth->execute() or die $sth->errstr;
5818 while (my $rec = $sth->fetchrow_hashref) {
5819 push @$recnums, $rec->{$tclass->primary_key};
5822 $$lastrecnum = $$recnums[-1];
5823 return shift @$recnums;
5832 The delete method should possibly take an FS::cust_main object reference
5833 instead of a scalar customer number.
5835 Bill and collect options should probably be passed as references instead of a
5838 There should probably be a configuration file with a list of allowed credit
5841 No multiple currency support (probably a larger project than just this module).
5843 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5845 Birthdates rely on negative epoch values.
5847 The payby for card/check batches is broken. With mixed batching, bad
5850 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5854 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5855 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5856 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.