2 use base qw( FS::cust_main::Packages
4 FS::cust_main::NationalID
6 FS::cust_main::Billing_Realtime
7 FS::cust_main::Billing_Batch
8 FS::cust_main::Billing_Discount
9 FS::cust_main::Billing_ThirdParty
10 FS::cust_main::Location
11 FS::cust_main::Credit_Limit
14 FS::otaker_Mixin FS::cust_main_Mixin
15 FS::geocode_Mixin FS::Quotable_Mixin FS::Sales_Mixin
24 use Scalar::Util qw( blessed );
25 use List::Util qw(min);
27 use File::Temp; #qw( tempfile );
29 use Time::Local qw(timelocal);
33 use Business::CreditCard 0.28;
34 use FS::UID qw( dbh driver_name );
35 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
37 use FS::Misc qw( generate_ps do_print money_pretty card_types );
38 use FS::Msgcat qw(gettext);
45 use FS::cust_bill_void;
46 use FS::legacy_cust_bill;
48 use FS::cust_pay_pending;
49 use FS::cust_pay_void;
50 use FS::cust_pay_batch;
53 use FS::part_referral;
54 use FS::cust_main_county;
55 use FS::cust_location;
58 use FS::cust_main_exemption;
59 use FS::cust_tax_adjustment;
60 use FS::cust_tax_location;
61 use FS::agent_currency;
62 use FS::cust_main_invoice;
64 use FS::prepay_credit;
70 use FS::payment_gateway;
71 use FS::agent_payment_gateway;
73 use FS::cust_main_note;
74 use FS::cust_attachment;
77 use FS::upgrade_journal;
83 # 1 is mostly method/subroutine entry and options
84 # 2 traces progress of some operations
85 # 3 is even more information including possibly sensitive data
87 our $me = '[FS::cust_main]';
90 our $ignore_expired_card = 0;
91 our $ignore_banned_card = 0;
92 our $ignore_invalid_card = 0;
94 our $skip_fuzzyfiles = 0;
96 our $ucfirst_nowarn = 0;
98 #this info is in cust_payby as of 4.x
99 #this and the fields themselves can be removed in 5.x
100 our @encrypted_fields = ('payinfo', 'paycvv');
101 sub nohistory_fields { ('payinfo', 'paycvv'); }
104 our $default_agent_custid;
105 our $custnum_display_length;
106 #ask FS::UID to run this stuff for us later
107 #$FS::UID::callback{'FS::cust_main'} = sub {
108 install_callback FS::UID sub {
109 $conf = new FS::Conf;
110 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
111 $default_agent_custid = $conf->exists('cust_main-default_agent_custid');
112 $custnum_display_length = $conf->config('cust_main-custnum-display_length');
117 my ( $hashref, $cache ) = @_;
118 if ( exists $hashref->{'pkgnum'} ) {
119 #@{ $self->{'_pkgnum'} } = ();
120 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
121 $self->{'_pkgnum'} = $subcache;
122 #push @{ $self->{'_pkgnum'} },
123 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
129 FS::cust_main - Object methods for cust_main records
135 $record = new FS::cust_main \%hash;
136 $record = new FS::cust_main { 'column' => 'value' };
138 $error = $record->insert;
140 $error = $new_record->replace($old_record);
142 $error = $record->delete;
144 $error = $record->check;
146 @cust_pkg = $record->all_pkgs;
148 @cust_pkg = $record->ncancelled_pkgs;
150 @cust_pkg = $record->suspended_pkgs;
152 $error = $record->bill;
153 $error = $record->bill %options;
154 $error = $record->bill 'time' => $time;
156 $error = $record->collect;
157 $error = $record->collect %options;
158 $error = $record->collect 'invoice_time' => $time,
163 An FS::cust_main object represents a customer. FS::cust_main inherits from
164 FS::Record. The following fields are currently supported:
170 Primary key (assigned automatically for new customers)
174 Agent (see L<FS::agent>)
178 Advertising source (see L<FS::part_referral>)
190 Cocial security number (optional)
214 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
218 Payment Information (See L<FS::payinfo_Mixin> for data format)
222 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
226 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
230 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
234 Start date month (maestro/solo cards only)
238 Start date year (maestro/solo cards only)
242 Issue number (maestro/solo cards only)
246 Name on card or billing name
250 IP address from which payment information was received
254 Tax exempt, empty or `Y'
258 Order taker (see L<FS::access_user>)
264 =item referral_custnum
266 Referring customer number
270 Enable individual CDR spooling, empty or `Y'
274 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
278 Discourage individual CDR printing, empty or `Y'
282 Allow self-service editing of ticket subjects, empty or 'Y'
284 =item calling_list_exempt
286 Do not call, empty or 'Y'
288 =item invoice_ship_address
290 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
300 Creates a new customer. To add the customer to the database, see L<"insert">.
302 Note that this stores the hash reference, not a distinct copy of the hash it
303 points to. You can ask the object for a copy with the I<hash> method.
307 sub table { 'cust_main'; }
309 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
311 Adds this customer to the database. If there is an error, returns the error,
312 otherwise returns false.
314 Usually the customer's location will not yet exist in the database, and
315 the C<bill_location> and C<ship_location> pseudo-fields must be set to
316 uninserted L<FS::cust_location> objects. These will be inserted and linked
317 (in both directions) to the new customer record. If they're references
318 to the same object, they will become the same location.
320 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
321 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
322 are inserted atomicly, or the transaction is rolled back. Passing an empty
323 hash reference is equivalent to not supplying this parameter. There should be
324 a better explanation of this, but until then, here's an example:
327 tie %hash, 'Tie::RefHash'; #this part is important
329 $cust_pkg => [ $svc_acct ],
332 $cust_main->insert( \%hash );
334 INVOICING_LIST_ARYREF: No longer supported.
336 Currently available options are: I<depend_jobnum>, I<noexport>,
337 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
339 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
340 on the supplied jobnum (they will not run until the specific job completes).
341 This can be used to defer provisioning until some action completes (such
342 as running the customer's credit card successfully).
344 The I<noexport> option is deprecated. If I<noexport> is set true, no
345 provisioning jobs (exports) are scheduled. (You can schedule them later with
346 the B<reexport> method.)
348 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
349 of tax names and exemption numbers. FS::cust_main_exemption records will be
350 created and inserted.
352 If I<prospectnum> is set, moves contacts and locations from that prospect.
354 If I<contact> is set to an arrayref of FS::contact objects, those will be
357 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
358 unset), inserts those new contacts with this new customer. Handles CGI
359 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
361 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
362 new stored payment records with this new customer. Handles CGI parameters
363 for an "m2" multiple entry field as passed by edit/cust_main.cgi
369 my $cust_pkgs = @_ ? shift : {};
371 if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
372 warn "cust_main::insert using deprecated invoicing list argument";
373 $invoicing_list = shift;
376 warn "$me insert called with options ".
377 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
380 local $SIG{HUP} = 'IGNORE';
381 local $SIG{INT} = 'IGNORE';
382 local $SIG{QUIT} = 'IGNORE';
383 local $SIG{TERM} = 'IGNORE';
384 local $SIG{TSTP} = 'IGNORE';
385 local $SIG{PIPE} = 'IGNORE';
387 my $oldAutoCommit = $FS::UID::AutoCommit;
388 local $FS::UID::AutoCommit = 0;
391 my $prepay_identifier = '';
392 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
394 if ( $self->payby eq 'PREPAY' ) {
396 $self->payby(''); #'BILL');
397 $prepay_identifier = $self->payinfo;
400 warn " looking up prepaid card $prepay_identifier\n"
403 my $error = $self->get_prepay( $prepay_identifier,
404 'amount_ref' => \$amount,
405 'seconds_ref' => \$seconds,
406 'upbytes_ref' => \$upbytes,
407 'downbytes_ref' => \$downbytes,
408 'totalbytes_ref' => \$totalbytes,
411 $dbh->rollback if $oldAutoCommit;
412 #return "error applying prepaid card (transaction rolled back): $error";
416 $payby = 'PREP' if $amount;
418 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
421 $self->payby(''); #'BILL');
422 $amount = $self->paid;
427 foreach my $l (qw(bill_location ship_location)) {
429 my $loc = delete $self->hashref->{$l} or next;
431 if ( !$loc->locationnum ) {
432 # warn the location that we're going to insert it with no custnum
433 $loc->set(custnum_pending => 1);
434 warn " inserting $l\n"
436 my $error = $loc->insert;
438 $dbh->rollback if $oldAutoCommit;
439 my $label = $l eq 'ship_location' ? 'service' : 'billing';
440 return "$error (in $label location)";
443 } elsif ( $loc->prospectnum ) {
445 $loc->prospectnum('');
446 $loc->set(custnum_pending => 1);
447 my $error = $loc->replace;
449 $dbh->rollback if $oldAutoCommit;
450 my $label = $l eq 'ship_location' ? 'service' : 'billing';
451 return "$error (moving $label location)";
454 } elsif ( ($loc->custnum || 0) > 0 ) {
455 # then it somehow belongs to another customer--shouldn't happen
456 $dbh->rollback if $oldAutoCommit;
457 return "$l belongs to customer ".$loc->custnum;
459 # else it already belongs to this customer
460 # (happens when ship_location is identical to bill_location)
462 $self->set($l.'num', $loc->locationnum);
464 if ( $self->get($l.'num') eq '' ) {
465 $dbh->rollback if $oldAutoCommit;
470 warn " inserting $self\n"
473 $self->signupdate(time) unless $self->signupdate;
475 $self->auto_agent_custid()
476 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
478 my $error = $self->check_payinfo_cardtype
479 || $self->SUPER::insert;
481 $dbh->rollback if $oldAutoCommit;
482 #return "inserting cust_main record (transaction rolled back): $error";
486 # now set cust_location.custnum
487 foreach my $l (qw(bill_location ship_location)) {
488 warn " setting $l.custnum\n"
490 my $loc = $self->$l or next;
491 unless ( $loc->custnum ) {
492 $loc->set(custnum => $self->custnum);
493 $error ||= $loc->replace;
497 $dbh->rollback if $oldAutoCommit;
498 return "error setting $l custnum: $error";
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 foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
536 my $cust_contact = new FS::cust_contact {
537 'custnum' => $self->custnum,
538 'invoice_dest' => 'Y', # invoice_dest currently not set for prospect contacts
539 map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
541 my $error = $cust_contact->insert
542 || $prospect_contact->delete;
544 $dbh->rollback if $oldAutoCommit;
549 my @cust_location = $prospect_main->cust_location;
550 my @qual = $prospect_main->qual;
552 foreach my $r ( @cust_location, @qual ) {
554 $r->custnum($self->custnum);
555 my $error = $r->replace;
557 $dbh->rollback if $oldAutoCommit;
561 # since we set invoice_dest on all migrated prospect contacts (for now),
562 # don't process invoicing_list.
563 delete $options{'invoicing_list'};
564 $invoicing_list = undef;
567 warn " setting contacts\n"
570 $invoicing_list ||= $options{'invoicing_list'};
571 if ( $invoicing_list ) {
573 $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
576 foreach my $dest (@$invoicing_list ) {
577 if ($dest eq 'POST') {
578 $self->set('postal_invoice', 'Y');
581 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
582 if ( $contact_email ) {
583 my $cust_contact = FS::cust_contact->new({
584 contactnum => $contact_email->contactnum,
585 custnum => $self->custnum,
587 $cust_contact->set('invoice_dest', 'Y');
588 my $error = $cust_contact->insert;
590 $dbh->rollback if $oldAutoCommit;
591 return "$error (linking to email address $dest)";
595 # this email address is not yet linked to any contact
596 $email .= ',' if length($email);
604 my $contact = FS::contact->new({
605 'custnum' => $self->get('custnum'),
606 'last' => $self->get('last'),
607 'first' => $self->get('first'),
608 'emailaddress' => $email,
609 'invoice_dest' => 'Y', # yes, you can set this via the contact
611 my $error = $contact->insert;
613 $dbh->rollback if $oldAutoCommit;
621 if ( my $contact = delete $options{'contact'} ) {
623 foreach my $c ( @$contact ) {
624 $c->custnum($self->custnum);
625 my $error = $c->insert;
627 $dbh->rollback if $oldAutoCommit;
633 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
635 my $error = $self->process_o2m( 'table' => 'contact',
636 'fields' => FS::contact->cgi_contact_fields,
637 'params' => $contact_params,
640 $dbh->rollback if $oldAutoCommit;
645 warn " setting cust_payby\n"
648 if ( $options{cust_payby} ) {
650 foreach my $cust_payby ( @{ $options{cust_payby} } ) {
651 $cust_payby->custnum($self->custnum);
652 my $error = $cust_payby->insert;
654 $dbh->rollback if $oldAutoCommit;
659 } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
661 my $error = $self->process_o2m(
662 'table' => 'cust_payby',
663 'fields' => FS::cust_payby->cgi_cust_payby_fields,
664 'params' => $cust_payby_params,
665 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
668 $dbh->rollback if $oldAutoCommit;
674 warn " setting cust_main_exemption\n"
677 my $tax_exemption = delete $options{'tax_exemption'};
678 if ( $tax_exemption ) {
680 $tax_exemption = { map { $_ => '' } @$tax_exemption }
681 if ref($tax_exemption) eq 'ARRAY';
683 foreach my $taxname ( keys %$tax_exemption ) {
684 my $cust_main_exemption = new FS::cust_main_exemption {
685 'custnum' => $self->custnum,
686 'taxname' => $taxname,
687 'exempt_number' => $tax_exemption->{$taxname},
689 my $error = $cust_main_exemption->insert;
691 $dbh->rollback if $oldAutoCommit;
692 return "inserting cust_main_exemption (transaction rolled back): $error";
697 warn " ordering packages\n"
700 $error = $self->order_pkgs( $cust_pkgs,
702 'seconds_ref' => \$seconds,
703 'upbytes_ref' => \$upbytes,
704 'downbytes_ref' => \$downbytes,
705 'totalbytes_ref' => \$totalbytes,
708 $dbh->rollback if $oldAutoCommit;
713 $dbh->rollback if $oldAutoCommit;
714 return "No svc_acct record to apply pre-paid time";
716 if ( $upbytes || $downbytes || $totalbytes ) {
717 $dbh->rollback if $oldAutoCommit;
718 return "No svc_acct record to apply pre-paid data";
722 warn " inserting initial $payby payment of $amount\n"
724 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
726 $dbh->rollback if $oldAutoCommit;
727 return "inserting payment (transaction rolled back): $error";
731 unless ( $import || $skip_fuzzyfiles ) {
732 warn " queueing fuzzyfiles update\n"
734 $error = $self->queue_fuzzyfiles_update;
736 $dbh->rollback if $oldAutoCommit;
737 return "updating fuzzy search cache: $error";
741 # FS::geocode_Mixin::after_insert or something?
742 if ( $conf->config('tax_district_method') and !$import ) {
743 # if anything non-empty, try to look it up
744 my $queue = new FS::queue {
745 'job' => 'FS::geocode_Mixin::process_district_update',
746 'custnum' => $self->custnum,
748 my $error = $queue->insert( ref($self), $self->custnum );
750 $dbh->rollback if $oldAutoCommit;
751 return "queueing tax district update: $error";
756 warn " exporting\n" if $DEBUG > 1;
758 my $export_args = $options{'export_args'} || [];
761 map qsearch( 'part_export', {exportnum=>$_} ),
762 $conf->config('cust_main-exports'); #, $agentnum
764 foreach my $part_export ( @part_export ) {
765 my $error = $part_export->export_insert($self, @$export_args);
767 $dbh->rollback if $oldAutoCommit;
768 return "exporting to ". $part_export->exporttype.
769 " (transaction rolled back): $error";
773 #foreach my $depend_jobnum ( @$depend_jobnums ) {
774 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
776 # foreach my $jobnum ( @jobnums ) {
777 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
778 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
780 # my $error = $queue->depend_insert($depend_jobnum);
782 # $dbh->rollback if $oldAutoCommit;
783 # return "error queuing job dependancy: $error";
790 #if ( exists $options{'jobnums'} ) {
791 # push @{ $options{'jobnums'} }, @jobnums;
794 warn " insert complete; committing transaction\n"
797 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
802 use File::CounterFile;
803 sub auto_agent_custid {
806 my $format = $conf->config('cust_main-auto_agent_custid');
808 if ( $format eq '1YMMXXXXXXXX' ) {
810 my $counter = new File::CounterFile 'cust_main.agent_custid';
813 my $ym = 100000000000 + time2str('%y%m00000000', time);
814 if ( $ym > $counter->value ) {
815 $counter->{'value'} = $agent_custid = $ym;
816 $counter->{'updated'} = 1;
818 $agent_custid = $counter->inc;
824 die "Unknown cust_main-auto_agent_custid format: $format";
827 $self->agent_custid($agent_custid);
831 =item PACKAGE METHODS
833 Documentation on customer package methods has been moved to
834 L<FS::cust_main::Packages>.
836 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
838 Recharges this (existing) customer with the specified prepaid card (see
839 L<FS::prepay_credit>), specified either by I<identifier> or as an
840 FS::prepay_credit object. If there is an error, returns the error, otherwise
843 Optionally, five scalar references can be passed as well. They will have their
844 values filled in with the amount, number of seconds, and number of upload,
845 download, and total bytes applied by this prepaid card.
849 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
850 #the only place that uses these args
851 sub recharge_prepay {
852 my( $self, $prepay_credit, $amountref, $secondsref,
853 $upbytesref, $downbytesref, $totalbytesref ) = @_;
855 local $SIG{HUP} = 'IGNORE';
856 local $SIG{INT} = 'IGNORE';
857 local $SIG{QUIT} = 'IGNORE';
858 local $SIG{TERM} = 'IGNORE';
859 local $SIG{TSTP} = 'IGNORE';
860 local $SIG{PIPE} = 'IGNORE';
862 my $oldAutoCommit = $FS::UID::AutoCommit;
863 local $FS::UID::AutoCommit = 0;
866 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
868 my $error = $self->get_prepay( $prepay_credit,
869 'amount_ref' => \$amount,
870 'seconds_ref' => \$seconds,
871 'upbytes_ref' => \$upbytes,
872 'downbytes_ref' => \$downbytes,
873 'totalbytes_ref' => \$totalbytes,
875 || $self->increment_seconds($seconds)
876 || $self->increment_upbytes($upbytes)
877 || $self->increment_downbytes($downbytes)
878 || $self->increment_totalbytes($totalbytes)
879 || $self->insert_cust_pay_prepay( $amount,
881 ? $prepay_credit->identifier
886 $dbh->rollback if $oldAutoCommit;
890 if ( defined($amountref) ) { $$amountref = $amount; }
891 if ( defined($secondsref) ) { $$secondsref = $seconds; }
892 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
893 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
894 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
896 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
901 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
903 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
904 specified either by I<identifier> or as an FS::prepay_credit object.
906 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
907 incremented by the values of the prepaid card.
909 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
910 check or set this customer's I<agentnum>.
912 If there is an error, returns the error, otherwise returns false.
918 my( $self, $prepay_credit, %opt ) = @_;
920 local $SIG{HUP} = 'IGNORE';
921 local $SIG{INT} = 'IGNORE';
922 local $SIG{QUIT} = 'IGNORE';
923 local $SIG{TERM} = 'IGNORE';
924 local $SIG{TSTP} = 'IGNORE';
925 local $SIG{PIPE} = 'IGNORE';
927 my $oldAutoCommit = $FS::UID::AutoCommit;
928 local $FS::UID::AutoCommit = 0;
931 unless ( ref($prepay_credit) ) {
933 my $identifier = $prepay_credit;
935 $prepay_credit = qsearchs(
937 { 'identifier' => $identifier },
942 unless ( $prepay_credit ) {
943 $dbh->rollback if $oldAutoCommit;
944 return "Invalid prepaid card: ". $identifier;
949 if ( $prepay_credit->agentnum ) {
950 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
951 $dbh->rollback if $oldAutoCommit;
952 return "prepaid card not valid for agent ". $self->agentnum;
954 $self->agentnum($prepay_credit->agentnum);
957 my $error = $prepay_credit->delete;
959 $dbh->rollback if $oldAutoCommit;
960 return "removing prepay_credit (transaction rolled back): $error";
963 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
964 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
966 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
971 =item increment_upbytes SECONDS
973 Updates this customer's single or primary account (see L<FS::svc_acct>) by
974 the specified number of upbytes. If there is an error, returns the error,
975 otherwise returns false.
979 sub increment_upbytes {
980 _increment_column( shift, 'upbytes', @_);
983 =item increment_downbytes SECONDS
985 Updates this customer's single or primary account (see L<FS::svc_acct>) by
986 the specified number of downbytes. If there is an error, returns the error,
987 otherwise returns false.
991 sub increment_downbytes {
992 _increment_column( shift, 'downbytes', @_);
995 =item increment_totalbytes SECONDS
997 Updates this customer's single or primary account (see L<FS::svc_acct>) by
998 the specified number of totalbytes. If there is an error, returns the error,
999 otherwise returns false.
1003 sub increment_totalbytes {
1004 _increment_column( shift, 'totalbytes', @_);
1007 =item increment_seconds SECONDS
1009 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1010 the specified number of seconds. If there is an error, returns the error,
1011 otherwise returns false.
1015 sub increment_seconds {
1016 _increment_column( shift, 'seconds', @_);
1019 =item _increment_column AMOUNT
1021 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1022 the specified number of seconds or bytes. If there is an error, returns
1023 the error, otherwise returns false.
1027 sub _increment_column {
1028 my( $self, $column, $amount ) = @_;
1029 warn "$me increment_column called: $column, $amount\n"
1032 return '' unless $amount;
1034 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1035 $self->ncancelled_pkgs;
1037 if ( ! @cust_pkg ) {
1038 return 'No packages with primary or single services found'.
1039 ' to apply pre-paid time';
1040 } elsif ( scalar(@cust_pkg) > 1 ) {
1041 #maybe have a way to specify the package/account?
1042 return 'Multiple packages found to apply pre-paid time';
1045 my $cust_pkg = $cust_pkg[0];
1046 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1050 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1052 if ( ! @cust_svc ) {
1053 return 'No account found to apply pre-paid time';
1054 } elsif ( scalar(@cust_svc) > 1 ) {
1055 return 'Multiple accounts found to apply pre-paid time';
1058 my $svc_acct = $cust_svc[0]->svc_x;
1059 warn " found service svcnum ". $svc_acct->pkgnum.
1060 ' ('. $svc_acct->email. ")\n"
1063 $column = "increment_$column";
1064 $svc_acct->$column($amount);
1068 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1070 Inserts a prepayment in the specified amount for this customer. An optional
1071 second argument can specify the prepayment identifier for tracking purposes.
1072 If there is an error, returns the error, otherwise returns false.
1076 sub insert_cust_pay_prepay {
1077 shift->insert_cust_pay('PREP', @_);
1080 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1082 Inserts a cash payment in the specified amount for this customer. An optional
1083 second argument can specify the payment identifier for tracking purposes.
1084 If there is an error, returns the error, otherwise returns false.
1088 sub insert_cust_pay_cash {
1089 shift->insert_cust_pay('CASH', @_);
1092 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1094 Inserts a Western Union payment in the specified amount for this customer. An
1095 optional second argument can specify the prepayment identifier for tracking
1096 purposes. If there is an error, returns the error, otherwise returns false.
1100 sub insert_cust_pay_west {
1101 shift->insert_cust_pay('WEST', @_);
1104 sub insert_cust_pay {
1105 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1106 my $payinfo = scalar(@_) ? shift : '';
1108 my $cust_pay = new FS::cust_pay {
1109 'custnum' => $self->custnum,
1110 'paid' => sprintf('%.2f', $amount),
1111 #'_date' => #date the prepaid card was purchased???
1113 'payinfo' => $payinfo,
1119 =item delete [ OPTION => VALUE ... ]
1121 This deletes the customer. If there is an error, returns the error, otherwise
1124 This will completely remove all traces of the customer record. This is not
1125 what you want when a customer cancels service; for that, cancel all of the
1126 customer's packages (see L</cancel>).
1128 If the customer has any uncancelled packages, you need to pass a new (valid)
1129 customer number for those packages to be transferred to, as the "new_customer"
1130 option. Cancelled packages will be deleted. Did I mention that this is NOT
1131 what you want when a customer cancels service and that you really should be
1132 looking at L<FS::cust_pkg/cancel>?
1134 You can't delete a customer with invoices (see L<FS::cust_bill>),
1135 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1136 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1137 set the "delete_financials" option to a true value.
1142 my( $self, %opt ) = @_;
1144 local $SIG{HUP} = 'IGNORE';
1145 local $SIG{INT} = 'IGNORE';
1146 local $SIG{QUIT} = 'IGNORE';
1147 local $SIG{TERM} = 'IGNORE';
1148 local $SIG{TSTP} = 'IGNORE';
1149 local $SIG{PIPE} = 'IGNORE';
1151 my $oldAutoCommit = $FS::UID::AutoCommit;
1152 local $FS::UID::AutoCommit = 0;
1155 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1156 $dbh->rollback if $oldAutoCommit;
1157 return "Can't delete a master agent customer";
1160 #use FS::access_user
1161 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1162 $dbh->rollback if $oldAutoCommit;
1163 return "Can't delete a master employee customer";
1166 tie my %financial_tables, 'Tie::IxHash',
1167 'cust_bill' => 'invoices',
1168 'cust_statement' => 'statements',
1169 'cust_credit' => 'credits',
1170 'cust_pay' => 'payments',
1171 'cust_refund' => 'refunds',
1174 foreach my $table ( keys %financial_tables ) {
1176 my @records = $self->$table();
1178 if ( @records && ! $opt{'delete_financials'} ) {
1179 $dbh->rollback if $oldAutoCommit;
1180 return "Can't delete a customer with ". $financial_tables{$table};
1183 foreach my $record ( @records ) {
1184 my $error = $record->delete;
1186 $dbh->rollback if $oldAutoCommit;
1187 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1193 my @cust_pkg = $self->ncancelled_pkgs;
1195 my $new_custnum = $opt{'new_custnum'};
1196 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1197 $dbh->rollback if $oldAutoCommit;
1198 return "Invalid new customer number: $new_custnum";
1200 foreach my $cust_pkg ( @cust_pkg ) {
1201 my %hash = $cust_pkg->hash;
1202 $hash{'custnum'} = $new_custnum;
1203 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1204 my $error = $new_cust_pkg->replace($cust_pkg,
1205 options => { $cust_pkg->options },
1208 $dbh->rollback if $oldAutoCommit;
1213 my @cancelled_cust_pkg = $self->all_pkgs;
1214 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1215 my $error = $cust_pkg->delete;
1217 $dbh->rollback if $oldAutoCommit;
1222 #cust_tax_adjustment in financials?
1223 #cust_pay_pending? ouch
1224 foreach my $table (qw(
1225 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1226 cust_payby cust_location cust_main_note cust_tax_adjustment
1227 cust_pay_void cust_pay_batch queue cust_tax_exempt
1229 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1230 my $error = $record->delete;
1232 $dbh->rollback if $oldAutoCommit;
1238 my $sth = $dbh->prepare(
1239 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1241 my $errstr = $dbh->errstr;
1242 $dbh->rollback if $oldAutoCommit;
1245 $sth->execute($self->custnum) or do {
1246 my $errstr = $sth->errstr;
1247 $dbh->rollback if $oldAutoCommit;
1253 my $ticket_dbh = '';
1254 if ($conf->config('ticket_system') eq 'RT_Internal') {
1256 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1257 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1258 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1259 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1262 if ( $ticket_dbh ) {
1264 my $ticket_sth = $ticket_dbh->prepare(
1265 'DELETE FROM Links WHERE Target = ?'
1267 my $errstr = $ticket_dbh->errstr;
1268 $dbh->rollback if $oldAutoCommit;
1271 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1273 my $errstr = $ticket_sth->errstr;
1274 $dbh->rollback if $oldAutoCommit;
1278 #check and see if the customer is the only link on the ticket, and
1279 #if so, set the ticket to deleted status in RT?
1280 #maybe someday, for now this will at least fix tickets not displaying
1284 #delete the customer record
1286 my $error = $self->SUPER::delete;
1288 $dbh->rollback if $oldAutoCommit;
1292 # cust_main exports!
1294 #my $export_args = $options{'export_args'} || [];
1297 map qsearch( 'part_export', {exportnum=>$_} ),
1298 $conf->config('cust_main-exports'); #, $agentnum
1300 foreach my $part_export ( @part_export ) {
1301 my $error = $part_export->export_delete( $self ); #, @$export_args);
1303 $dbh->rollback if $oldAutoCommit;
1304 return "exporting to ". $part_export->exporttype.
1305 " (transaction rolled back): $error";
1309 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1314 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1316 Replaces the OLD_RECORD with this one in the database. If there is an error,
1317 returns the error, otherwise returns false.
1319 To change the customer's address, set the pseudo-fields C<bill_location> and
1320 C<ship_location>. The address will still only change if at least one of the
1321 address fields differs from the existing values.
1323 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1324 set as the contact email address for a default contact with the same name as
1327 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1328 I<contact_params>, I<invoicing_list>, and I<move_pkgs>.
1330 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1331 of tax names and exemption numbers. FS::cust_main_exemption records will be
1332 deleted and inserted as appropriate.
1334 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1335 groups (describing the customer's payment methods and contacts, respectively)
1336 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1337 and L<FS::contact> for the fields these can contain.
1339 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1340 should be used instead if possible.
1342 If I<move_pkgs> is an arrayref, it will override the list of packages
1343 to be moved to the new address (see L<FS::cust_location/move_pkgs>.)
1350 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1352 : $self->replace_old;
1356 warn "$me replace called\n"
1359 my $curuser = $FS::CurrentUser::CurrentUser;
1360 return "You are not permitted to create complimentary accounts."
1361 if $self->complimentary eq 'Y'
1362 && $self->complimentary ne $old->complimentary
1363 && ! $curuser->access_right('Complimentary customer');
1365 local($ignore_expired_card) = 1
1366 if $old->payby =~ /^(CARD|DCRD)$/
1367 && $self->payby =~ /^(CARD|DCRD)$/
1368 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1370 local($ignore_banned_card) = 1
1371 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1372 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1373 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1375 if ( $self->payby =~ /^(CARD|DCRD)$/
1376 && $old->payinfo ne $self->payinfo
1377 && $old->paymask ne $self->paymask )
1379 my $error = $self->check_payinfo_cardtype;
1380 return $error if $error;
1383 return "Invoicing locale is required"
1386 && $conf->exists('cust_main-require_locale');
1388 local $SIG{HUP} = 'IGNORE';
1389 local $SIG{INT} = 'IGNORE';
1390 local $SIG{QUIT} = 'IGNORE';
1391 local $SIG{TERM} = 'IGNORE';
1392 local $SIG{TSTP} = 'IGNORE';
1393 local $SIG{PIPE} = 'IGNORE';
1395 my $oldAutoCommit = $FS::UID::AutoCommit;
1396 local $FS::UID::AutoCommit = 0;
1399 for my $l (qw(bill_location ship_location)) {
1400 #my $old_loc = $old->$l;
1401 my $new_loc = $self->$l or next;
1403 # find the existing location if there is one
1404 $new_loc->set('custnum' => $self->custnum);
1405 my $error = $new_loc->find_or_insert;
1407 $dbh->rollback if $oldAutoCommit;
1410 $self->set($l.'num', $new_loc->locationnum);
1414 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1415 warn "cust_main::replace: using deprecated invoicing list argument";
1416 $invoicing_list = shift @param;
1419 my %options = @param;
1421 $invoicing_list ||= $options{invoicing_list};
1423 my @contacts = map { $_->contact } $self->cust_contact;
1424 # find a contact that matches the customer's name
1425 my ($implicit_contact) = grep { $_->first eq $old->get('first')
1426 and $_->last eq $old->get('last') }
1428 $implicit_contact ||= FS::contact->new({
1429 'custnum' => $self->custnum,
1430 'locationnum' => $self->get('bill_locationnum'),
1433 # for any of these that are already contact emails, link to the existing
1435 if ( $invoicing_list ) {
1438 # kind of like process_m2m on these, except:
1439 # - the other side is two tables in a join
1440 # - and we might have to create new contact_emails
1441 # - and possibly a new contact
1443 # Find existing invoice emails that aren't on the implicit contact.
1444 # Any of these that are not on the new invoicing list will be removed.
1445 my %old_email_cust_contact;
1446 foreach my $cust_contact ($self->cust_contact) {
1447 next if !$cust_contact->invoice_dest;
1448 next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1450 foreach my $contact_email ($cust_contact->contact->contact_email) {
1451 $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1455 foreach my $dest (@$invoicing_list) {
1457 if ($dest eq 'POST') {
1459 $self->set('postal_invoice', 'Y');
1461 } elsif ( exists($old_email_cust_contact{$dest}) ) {
1463 delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1467 # See if it belongs to some other contact; if so, link it.
1468 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1470 and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1471 my $cust_contact = qsearchs('cust_contact', {
1472 contactnum => $contact_email->contactnum,
1473 custnum => $self->custnum,
1474 }) || FS::cust_contact->new({
1475 contactnum => $contact_email->contactnum,
1476 custnum => $self->custnum,
1478 $cust_contact->set('invoice_dest', 'Y');
1479 my $error = $cust_contact->custcontactnum ?
1480 $cust_contact->replace : $cust_contact->insert;
1482 $dbh->rollback if $oldAutoCommit;
1483 return "$error (linking to email address $dest)";
1487 # This email address is not yet linked to any contact, so it will
1488 # be added to the implicit contact.
1489 $email .= ',' if length($email);
1495 foreach my $remove_dest (keys %old_email_cust_contact) {
1496 my $cust_contact = $old_email_cust_contact{$remove_dest};
1497 # These were not in the list of requested destinations, so take them off.
1498 $cust_contact->set('invoice_dest', '');
1499 my $error = $cust_contact->replace;
1501 $dbh->rollback if $oldAutoCommit;
1502 return "$error (unlinking email address $remove_dest)";
1506 # make sure it keeps up with the changed customer name, if any
1507 $implicit_contact->set('last', $self->get('last'));
1508 $implicit_contact->set('first', $self->get('first'));
1509 $implicit_contact->set('emailaddress', $email);
1510 $implicit_contact->set('invoice_dest', 'Y');
1511 $implicit_contact->set('custnum', $self->custnum);
1514 if ( $implicit_contact->contactnum ) {
1515 $error = $implicit_contact->replace;
1516 } elsif ( length($email) ) { # don't create a new contact if not needed
1517 $error = $implicit_contact->insert;
1521 $dbh->rollback if $oldAutoCommit;
1522 return "$error (adding email address $email)";
1527 # replace the customer record
1528 my $error = $self->SUPER::replace($old);
1531 $dbh->rollback if $oldAutoCommit;
1535 # now move packages to the new service location
1536 $self->set('ship_location', ''); #flush cache
1537 if ( $old->ship_locationnum and # should only be null during upgrade...
1538 $old->ship_locationnum != $self->ship_locationnum ) {
1539 $error = $old->ship_location->move_to($self->ship_location, move_pkgs => $options{'move_pkgs'});
1541 $dbh->rollback if $oldAutoCommit;
1545 # don't move packages based on the billing location, but
1546 # disable it if it's no longer in use
1547 if ( $old->bill_locationnum and
1548 $old->bill_locationnum != $self->bill_locationnum ) {
1549 $error = $old->bill_location->disable_if_unused;
1551 $dbh->rollback if $oldAutoCommit;
1556 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1558 #this could be more efficient than deleting and re-inserting, if it matters
1559 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1560 my $error = $cust_tag->delete;
1562 $dbh->rollback if $oldAutoCommit;
1566 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1567 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1568 'custnum' => $self->custnum };
1569 my $error = $cust_tag->insert;
1571 $dbh->rollback if $oldAutoCommit;
1578 my $tax_exemption = delete $options{'tax_exemption'};
1579 if ( $tax_exemption ) {
1581 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1582 if ref($tax_exemption) eq 'ARRAY';
1584 my %cust_main_exemption =
1585 map { $_->taxname => $_ }
1586 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1588 foreach my $taxname ( keys %$tax_exemption ) {
1590 if ( $cust_main_exemption{$taxname} &&
1591 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1594 delete $cust_main_exemption{$taxname};
1598 my $cust_main_exemption = new FS::cust_main_exemption {
1599 'custnum' => $self->custnum,
1600 'taxname' => $taxname,
1601 'exempt_number' => $tax_exemption->{$taxname},
1603 my $error = $cust_main_exemption->insert;
1605 $dbh->rollback if $oldAutoCommit;
1606 return "inserting cust_main_exemption (transaction rolled back): $error";
1610 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1611 my $error = $cust_main_exemption->delete;
1613 $dbh->rollback if $oldAutoCommit;
1614 return "deleting cust_main_exemption (transaction rolled back): $error";
1620 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1622 my $error = $self->process_o2m(
1623 'table' => 'cust_payby',
1624 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1625 'params' => $cust_payby_params,
1626 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1629 $dbh->rollback if $oldAutoCommit;
1635 if ( my $contact_params = delete $options{'contact_params'} ) {
1637 # this can potentially replace contacts that were created by the
1638 # invoicing list argument, but the UI shouldn't allow both of them
1641 my $error = $self->process_o2m(
1642 'table' => 'contact',
1643 'fields' => FS::contact->cgi_contact_fields,
1644 'params' => $contact_params,
1647 $dbh->rollback if $oldAutoCommit;
1653 unless ( $import || $skip_fuzzyfiles ) {
1654 $error = $self->queue_fuzzyfiles_update;
1656 $dbh->rollback if $oldAutoCommit;
1657 return "updating fuzzy search cache: $error";
1661 # tax district update in cust_location
1663 # cust_main exports!
1665 my $export_args = $options{'export_args'} || [];
1668 map qsearch( 'part_export', {exportnum=>$_} ),
1669 $conf->config('cust_main-exports'); #, $agentnum
1671 foreach my $part_export ( @part_export ) {
1672 my $error = $part_export->export_replace( $self, $old, @$export_args);
1674 $dbh->rollback if $oldAutoCommit;
1675 return "exporting to ". $part_export->exporttype.
1676 " (transaction rolled back): $error";
1680 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1685 =item queue_fuzzyfiles_update
1687 Used by insert & replace to update the fuzzy search cache
1691 use FS::cust_main::Search;
1692 sub queue_fuzzyfiles_update {
1695 local $SIG{HUP} = 'IGNORE';
1696 local $SIG{INT} = 'IGNORE';
1697 local $SIG{QUIT} = 'IGNORE';
1698 local $SIG{TERM} = 'IGNORE';
1699 local $SIG{TSTP} = 'IGNORE';
1700 local $SIG{PIPE} = 'IGNORE';
1702 my $oldAutoCommit = $FS::UID::AutoCommit;
1703 local $FS::UID::AutoCommit = 0;
1706 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1707 my $queue = new FS::queue {
1708 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1710 my @args = "cust_main.$field", $self->get($field);
1711 my $error = $queue->insert( @args );
1713 $dbh->rollback if $oldAutoCommit;
1714 return "queueing job (transaction rolled back): $error";
1719 push @locations, $self->bill_location if $self->bill_locationnum;
1720 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1721 foreach my $location (@locations) {
1722 my $queue = new FS::queue {
1723 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1725 my @args = 'cust_location.address1', $location->address1;
1726 my $error = $queue->insert( @args );
1728 $dbh->rollback if $oldAutoCommit;
1729 return "queueing job (transaction rolled back): $error";
1733 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1740 Checks all fields to make sure this is a valid customer record. If there is
1741 an error, returns the error, otherwise returns false. Called by the insert
1742 and replace methods.
1749 warn "$me check BEFORE: \n". $self->_dump
1753 $self->ut_numbern('custnum')
1754 || $self->ut_number('agentnum')
1755 || $self->ut_textn('agent_custid')
1756 || $self->ut_number('refnum')
1757 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1758 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1759 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1760 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1761 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1762 || $self->ut_textn('custbatch')
1763 || $self->ut_name('last')
1764 || $self->ut_name('first')
1765 || $self->ut_snumbern('signupdate')
1766 || $self->ut_snumbern('birthdate')
1767 || $self->ut_namen('spouse_last')
1768 || $self->ut_namen('spouse_first')
1769 || $self->ut_snumbern('spouse_birthdate')
1770 || $self->ut_snumbern('anniversary_date')
1771 || $self->ut_textn('company')
1772 || $self->ut_textn('ship_company')
1773 || $self->ut_anything('comments')
1774 || $self->ut_numbern('referral_custnum')
1775 || $self->ut_textn('stateid')
1776 || $self->ut_textn('stateid_state')
1777 || $self->ut_textn('invoice_terms')
1778 || $self->ut_floatn('cdr_termination_percentage')
1779 || $self->ut_floatn('credit_limit')
1780 || $self->ut_numbern('billday')
1781 || $self->ut_numbern('prorate_day')
1782 || $self->ut_flag('force_prorate_day')
1783 || $self->ut_flag('edit_subject')
1784 || $self->ut_flag('calling_list_exempt')
1785 || $self->ut_flag('invoice_noemail')
1786 || $self->ut_flag('message_noemail')
1787 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1788 || $self->ut_currencyn('currency')
1789 || $self->ut_textn('po_number')
1790 || $self->ut_enum('complimentary', [ '', 'Y' ])
1791 || $self->ut_flag('invoice_ship_address')
1792 || $self->ut_flag('invoice_dest')
1795 foreach (qw(company ship_company)) {
1796 my $company = $self->get($_);
1797 $company =~ s/^\s+//;
1798 $company =~ s/\s+$//;
1799 $company =~ s/\s+/ /g;
1800 $self->set($_, $company);
1803 #barf. need message catalogs. i18n. etc.
1804 $error .= "Please select an advertising source."
1805 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1806 return $error if $error;
1808 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1809 or return "Unknown agent";
1811 if ( $self->currency ) {
1812 my $agent_currency = qsearchs( 'agent_currency', {
1813 'agentnum' => $agent->agentnum,
1814 'currency' => $self->currency,
1816 or return "Agent ". $agent->agent.
1817 " not permitted to offer ". $self->currency. " invoicing";
1820 return "Unknown refnum"
1821 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1823 return "Unknown referring custnum: ". $self->referral_custnum
1824 unless ! $self->referral_custnum
1825 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1827 if ( $self->ss eq '' ) {
1832 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1833 or return "Illegal social security number: ". $self->ss;
1834 $self->ss("$1-$2-$3");
1837 #turn off invoice_ship_address if ship & bill are the same
1838 if ($self->bill_locationnum eq $self->ship_locationnum) {
1839 $self->invoice_ship_address('');
1842 # cust_main_county verification now handled by cust_location check
1845 $self->ut_phonen('daytime', $self->country)
1846 || $self->ut_phonen('night', $self->country)
1847 || $self->ut_phonen('fax', $self->country)
1848 || $self->ut_phonen('mobile', $self->country)
1850 return $error if $error;
1852 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1854 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1857 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1859 : FS::Msgcat::_gettext('daytime');
1860 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1862 : FS::Msgcat::_gettext('night');
1864 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1866 : FS::Msgcat::_gettext('mobile');
1868 return "$daytime_label, $night_label or $mobile_label is required"
1872 return "Please select an invoicing locale"
1875 && $conf->exists('cust_main-require_locale');
1877 return "Please select a customer class"
1878 if ! $self->classnum
1879 && $conf->exists('cust_main-require_classnum');
1881 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1882 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1886 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
1888 warn "$me check AFTER: \n". $self->_dump
1891 $self->SUPER::check;
1894 sub check_payinfo_cardtype {
1897 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
1899 my $payinfo = $self->payinfo;
1900 $payinfo =~ s/\D//g;
1902 return '' if $self->tokenized($payinfo); #token
1904 my %bop_card_types = map { $_=>1 } values %{ card_types() };
1905 my $cardtype = cardtype($payinfo);
1907 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
1915 Additional checks for replace only.
1920 my ($new,$old) = @_;
1921 #preserve old value if global config is set
1922 if ($old && $conf->exists('invoice-ship_address')) {
1923 $new->invoice_ship_address($old->invoice_ship_address);
1930 Returns a list of fields which have ship_ duplicates.
1935 qw( last first company
1937 address1 address2 city county state zip country
1939 daytime night fax mobile
1943 =item has_ship_address
1945 Returns true if this customer record has a separate shipping address.
1949 sub has_ship_address {
1951 $self->bill_locationnum != $self->ship_locationnum;
1956 Returns a list of key/value pairs, with the following keys: address1,
1957 adddress2, city, county, state, zip, country, district, and geocode. The
1958 shipping address is used if present.
1964 $self->ship_location->location_hash;
1969 Returns all locations (see L<FS::cust_location>) for this customer.
1976 'table' => 'cust_location',
1977 'hashref' => { 'custnum' => $self->custnum,
1978 'prospectnum' => '',
1980 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
1986 Returns all contact associations (see L<FS::cust_contact>) for this customer.
1992 qsearch('cust_contact', { 'custnum' => $self->custnum } );
1995 =item cust_payby PAYBY
1997 Returns all payment methods (see L<FS::cust_payby>) for this customer.
1999 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
2000 Does not validate PAYBY.
2008 'table' => 'cust_payby',
2009 'hashref' => { 'custnum' => $self->custnum },
2010 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
2012 $search->{'extra_sql'} = ' AND payby IN ( '.
2013 join(',', map dbh->quote($_), @payby).
2020 =item has_cust_payby_auto
2022 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2026 sub has_cust_payby_auto {
2029 'table' => 'cust_payby',
2030 'hashref' => { 'custnum' => $self->custnum, },
2031 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2032 'order_by' => 'LIMIT 1',
2039 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2040 and L<FS::cust_pkg>) for this customer, except those on hold.
2042 Returns a list: an empty list on success or a list of errors.
2048 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2053 Unsuspends all suspended packages in the on-hold state (those without setup
2054 dates) for this customer.
2060 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2065 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2067 Returns a list: an empty list on success or a list of errors.
2073 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2076 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2078 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2079 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2080 of a list of pkgparts; the hashref has the following keys:
2084 =item pkgparts - listref of pkgparts
2086 =item (other options are passed to the suspend method)
2091 Returns a list: an empty list on success or a list of errors.
2095 sub suspend_if_pkgpart {
2097 my (@pkgparts, %opt);
2098 if (ref($_[0]) eq 'HASH'){
2099 @pkgparts = @{$_[0]{pkgparts}};
2104 grep { $_->suspend(%opt) }
2105 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2106 $self->unsuspended_pkgs;
2109 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2111 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2112 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2113 instead of a list of pkgparts; the hashref has the following keys:
2117 =item pkgparts - listref of pkgparts
2119 =item (other options are passed to the suspend method)
2123 Returns a list: an empty list on success or a list of errors.
2127 sub suspend_unless_pkgpart {
2129 my (@pkgparts, %opt);
2130 if (ref($_[0]) eq 'HASH'){
2131 @pkgparts = @{$_[0]{pkgparts}};
2136 grep { $_->suspend(%opt) }
2137 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2138 $self->unsuspended_pkgs;
2141 =item cancel [ OPTION => VALUE ... ]
2143 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2144 The cancellation time will be now.
2148 Always returns a list: an empty list on success or a list of errors.
2155 warn "$me cancel called on customer ". $self->custnum. " with options ".
2156 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2158 my @pkgs = $self->ncancelled_pkgs;
2160 $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2163 =item cancel_pkgs OPTIONS
2165 Cancels a specified list of packages. OPTIONS can include:
2169 =item cust_pkg - an arrayref of the packages. Required.
2171 =item time - the cancellation time, used to calculate final bills and
2172 unused-time credits if any. Will be passed through to the bill() and
2173 FS::cust_pkg::cancel() methods.
2175 =item quiet - can be set true to supress email cancellation notices.
2177 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a
2178 reasonnum of an existing reason, or passing a hashref will create a new reason.
2179 The hashref should have the following keys:
2180 typenum - Reason type (see L<FS::reason_type>)
2181 reason - Text of the new reason.
2183 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2184 for the individual packages, parallel to the C<cust_pkg> argument. The
2185 reason and reason_otaker arguments will be taken from those objects.
2187 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2189 =item nobill - can be set true to skip billing if it might otherwise be done.
2194 my( $self, %opt ) = @_;
2196 # we're going to cancel services, which is not reversible
2197 die "cancel_pkgs cannot be run inside a transaction"
2198 if $FS::UID::AutoCommit == 0;
2200 local $FS::UID::AutoCommit = 0;
2202 return ( 'access denied' )
2203 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2205 if ( $opt{'ban'} ) {
2207 foreach my $cust_payby ( $self->cust_payby ) {
2209 #well, if they didn't get decrypted on search, then we don't have to
2210 # try again... queue a job for the server that does have decryption
2211 # capability if we're in a paranoid multi-server implementation?
2212 return ( "Can't (yet) ban encrypted credit cards" )
2213 if $cust_payby->is_encrypted($cust_payby->payinfo);
2215 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2216 my $error = $ban->insert;
2226 my @pkgs = @{ delete $opt{'cust_pkg'} };
2227 my $cancel_time = $opt{'time'} || time;
2229 # bill all packages first, so we don't lose usage, service counts for
2230 # bulk billing, etc.
2231 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2233 my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2235 'time' => $cancel_time );
2237 warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2239 return ( "Error billing during cancellation: $error" );
2245 # try to cancel each service, the same way we would for individual packages,
2246 # but in cancel weight order.
2247 my @cust_svc = map { $_->cust_svc } @pkgs;
2248 my @sorted_cust_svc =
2250 sort { $a->[1] <=> $b->[1] }
2251 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2253 warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2256 foreach my $cust_svc (@sorted_cust_svc) {
2257 my $part_svc = $cust_svc->part_svc;
2258 next if ( defined($part_svc) and $part_svc->preserve );
2259 # immediate cancel, no date option
2260 # transactionize individually
2261 my $error = try { $cust_svc->cancel } catch { $_ };
2264 push @errors, $error;
2273 warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2274 $self->custnum. "\n"
2278 if ($opt{'cust_pkg_reason'}) {
2279 @cprs = @{ delete $opt{'cust_pkg_reason'} };
2285 my $cpr = shift @cprs;
2287 $lopt{'reason'} = $cpr->reasonnum;
2288 $lopt{'reason_otaker'} = $cpr->otaker;
2290 warn "no reason found when canceling package ".$_->pkgnum."\n";
2291 # we're not actually required to pass a reason to cust_pkg::cancel,
2292 # but if we're getting to this point, something has gone awry.
2293 $null_reason ||= FS::reason->new_or_existing(
2294 reason => 'unknown reason',
2295 type => 'Cancel Reason',
2298 $lopt{'reason'} = $null_reason->reasonnum;
2299 $lopt{'reason_otaker'} = $FS::CurrentUser::CurrentUser->username;
2302 my $error = $_->cancel(%lopt);
2305 push @errors, 'pkgnum '.$_->pkgnum.': '.$error;
2314 sub _banned_pay_hashref {
2315 die 'cust_main->_banned_pay_hashref deprecated';
2327 'payby' => $payby2ban{$self->payby},
2328 'payinfo' => $self->payinfo,
2329 #don't ever *search* on reason! #'reason' =>
2335 Returns all notes (see L<FS::cust_main_note>) for this customer.
2340 my($self,$orderby_classnum) = (shift,shift);
2341 my $orderby = "sticky DESC, _date DESC";
2342 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2343 qsearch( 'cust_main_note',
2344 { 'custnum' => $self->custnum },
2346 "ORDER BY $orderby",
2352 Returns the agent (see L<FS::agent>) for this customer.
2356 Returns the agent name (see L<FS::agent>) for this customer.
2362 $self->agent->agent;
2367 Returns any tags associated with this customer, as FS::cust_tag objects,
2368 or an empty list if there are no tags.
2372 Returns any tags associated with this customer, as FS::part_tag objects,
2373 or an empty list if there are no tags.
2379 map $_->part_tag, $self->cust_tag;
2385 Returns the customer class, as an FS::cust_class object, or the empty string
2386 if there is no customer class.
2390 Returns the customer category name, or the empty string if there is no customer
2397 my $cust_class = $self->cust_class;
2399 ? $cust_class->categoryname
2405 Returns the customer class name, or the empty string if there is no customer
2412 my $cust_class = $self->cust_class;
2414 ? $cust_class->classname
2420 Returns the external tax status, as an FS::tax_status object, or the empty
2421 string if there is no tax status.
2427 if ( $self->taxstatusnum ) {
2428 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2436 Returns the tax status code if there is one.
2442 my $tax_status = $self->tax_status;
2444 ? $tax_status->taxstatus
2448 =item BILLING METHODS
2450 Documentation on billing methods has been moved to
2451 L<FS::cust_main::Billing>.
2453 =item REALTIME BILLING METHODS
2455 Documentation on realtime billing methods has been moved to
2456 L<FS::cust_main::Billing_Realtime>.
2460 Removes the I<paycvv> field from the database directly.
2462 If there is an error, returns the error, otherwise returns false.
2464 DEPRECATED. Use L</remove_cvv_from_cust_payby> instead.
2469 die 'cust_main->remove_cvv deprecated';
2471 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2472 or return dbh->errstr;
2473 $sth->execute($self->custnum)
2474 or return $sth->errstr;
2481 Returns the total owed for this customer on all invoices
2482 (see L<FS::cust_bill/owed>).
2488 $self->total_owed_date(2145859200); #12/31/2037
2491 =item total_owed_date TIME
2493 Returns the total owed for this customer on all invoices with date earlier than
2494 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2495 see L<Time::Local> and L<Date::Parse> for conversion functions.
2499 sub total_owed_date {
2503 my $custnum = $self->custnum;
2505 my $owed_sql = FS::cust_bill->owed_sql;
2508 SELECT SUM($owed_sql) FROM cust_bill
2509 WHERE custnum = $custnum
2513 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2517 =item total_owed_pkgnum PKGNUM
2519 Returns the total owed on all invoices for this customer's specific package
2520 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2524 sub total_owed_pkgnum {
2525 my( $self, $pkgnum ) = @_;
2526 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2529 =item total_owed_date_pkgnum TIME PKGNUM
2531 Returns the total owed for this customer's specific package when using
2532 experimental package balances on all invoices with date earlier than
2533 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2534 see L<Time::Local> and L<Date::Parse> for conversion functions.
2538 sub total_owed_date_pkgnum {
2539 my( $self, $time, $pkgnum ) = @_;
2542 foreach my $cust_bill (
2543 grep { $_->_date <= $time }
2544 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2546 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2548 sprintf( "%.2f", $total_bill );
2554 Returns the total amount of all payments.
2561 $total += $_->paid foreach $self->cust_pay;
2562 sprintf( "%.2f", $total );
2565 =item total_unapplied_credits
2567 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2568 customer. See L<FS::cust_credit/credited>.
2570 =item total_credited
2572 Old name for total_unapplied_credits. Don't use.
2576 sub total_credited {
2577 #carp "total_credited deprecated, use total_unapplied_credits";
2578 shift->total_unapplied_credits(@_);
2581 sub total_unapplied_credits {
2584 my $custnum = $self->custnum;
2586 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2589 SELECT SUM($unapplied_sql) FROM cust_credit
2590 WHERE custnum = $custnum
2593 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2597 =item total_unapplied_credits_pkgnum PKGNUM
2599 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2600 customer. See L<FS::cust_credit/credited>.
2604 sub total_unapplied_credits_pkgnum {
2605 my( $self, $pkgnum ) = @_;
2606 my $total_credit = 0;
2607 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2608 sprintf( "%.2f", $total_credit );
2612 =item total_unapplied_payments
2614 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2615 See L<FS::cust_pay/unapplied>.
2619 sub total_unapplied_payments {
2622 my $custnum = $self->custnum;
2624 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2627 SELECT SUM($unapplied_sql) FROM cust_pay
2628 WHERE custnum = $custnum
2631 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2635 =item total_unapplied_payments_pkgnum PKGNUM
2637 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2638 specific package when using experimental package balances. See
2639 L<FS::cust_pay/unapplied>.
2643 sub total_unapplied_payments_pkgnum {
2644 my( $self, $pkgnum ) = @_;
2645 my $total_unapplied = 0;
2646 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2647 sprintf( "%.2f", $total_unapplied );
2651 =item total_unapplied_refunds
2653 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2654 customer. See L<FS::cust_refund/unapplied>.
2658 sub total_unapplied_refunds {
2660 my $custnum = $self->custnum;
2662 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2665 SELECT SUM($unapplied_sql) FROM cust_refund
2666 WHERE custnum = $custnum
2669 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2675 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2676 total_unapplied_credits minus total_unapplied_payments).
2682 $self->balance_date_range;
2685 =item balance_date TIME
2687 Returns the balance for this customer, only considering invoices with date
2688 earlier than TIME (total_owed_date minus total_credited minus
2689 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2690 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2697 $self->balance_date_range(shift);
2700 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2702 Returns the balance for this customer, optionally considering invoices with
2703 date earlier than START_TIME, and not later than END_TIME
2704 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2706 Times are specified as SQL fragments or numeric
2707 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2708 L<Date::Parse> for conversion functions. The empty string can be passed
2709 to disable that time constraint completely.
2711 Accepts the same options as L<balance_date_sql>:
2715 =item unapplied_date
2717 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)
2721 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2722 time will be ignored. Note that START_TIME and END_TIME only limit the date
2723 range for invoices and I<unapplied> payments, credits, and refunds.
2729 sub balance_date_range {
2731 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2732 ') FROM cust_main WHERE custnum='. $self->custnum;
2733 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2736 =item balance_pkgnum PKGNUM
2738 Returns the balance for this customer's specific package when using
2739 experimental package balances (total_owed plus total_unrefunded, minus
2740 total_unapplied_credits minus total_unapplied_payments)
2744 sub balance_pkgnum {
2745 my( $self, $pkgnum ) = @_;
2748 $self->total_owed_pkgnum($pkgnum)
2749 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2750 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2751 - $self->total_unapplied_credits_pkgnum($pkgnum)
2752 - $self->total_unapplied_payments_pkgnum($pkgnum)
2758 Returns a hash of useful information for making a payment.
2768 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2769 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2770 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2774 For credit card transactions:
2786 For electronic check transactions:
2796 #XXX i need to be updated for 4.x+
2802 $return{balance} = $self->balance;
2804 $return{payname} = $self->payname
2805 || ( $self->first. ' '. $self->get('last') );
2807 $return{$_} = $self->bill_location->$_
2808 for qw(address1 address2 city state zip);
2810 $return{payby} = $self->payby;
2811 $return{stateid_state} = $self->stateid_state;
2813 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2814 $return{card_type} = cardtype($self->payinfo);
2815 $return{payinfo} = $self->paymask;
2817 @return{'month', 'year'} = $self->paydate_monthyear;
2821 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2822 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2823 $return{payinfo1} = $payinfo1;
2824 $return{payinfo2} = $payinfo2;
2825 $return{paytype} = $self->paytype;
2826 $return{paystate} = $self->paystate;
2830 #doubleclick protection
2832 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2840 Returns the next payment expiration date for this customer. If they have no
2841 payment methods that will expire, returns 0.
2847 # filter out the ones that individually return 0, but then return 0 if
2848 # there are no results
2849 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
2850 min( @epochs ) || 0;
2853 =item paydate_epoch_sql
2855 Returns an SQL expression to get the next payment expiration date for a
2856 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
2857 dates, so that it's safe to test for "will it expire before date X" for any
2862 sub paydate_epoch_sql {
2864 my $paydate = FS::cust_payby->paydate_epoch_sql;
2865 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
2869 my( $self, $taxname ) = @_;
2871 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2872 'taxname' => $taxname,
2877 =item cust_main_exemption
2879 =item invoicing_list
2881 Returns a list of email addresses (with svcnum entries expanded), and the word
2882 'POST' if the customer receives postal invoices.
2886 sub invoicing_list {
2887 my( $self, $arrayref ) = @_;
2890 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
2893 my @emails = $self->invoicing_list_emailonly;
2894 push @emails, 'POST' if $self->get('postal_invoice');
2899 =item check_invoicing_list ARRAYREF
2901 Checks these arguements as valid input for the invoicing_list method. If there
2902 is an error, returns the error, otherwise returns false.
2906 sub check_invoicing_list {
2907 my( $self, $arrayref ) = @_;
2909 foreach my $address ( @$arrayref ) {
2911 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
2912 return 'Can\'t add FAX invoice destination with a blank FAX number.';
2915 my $cust_main_invoice = new FS::cust_main_invoice ( {
2916 'custnum' => $self->custnum,
2919 my $error = $self->custnum
2920 ? $cust_main_invoice->check
2921 : $cust_main_invoice->checkdest
2923 return $error if $error;
2927 return "Email address required"
2928 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
2929 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
2936 Returns the email addresses of all accounts provisioned for this customer.
2943 foreach my $cust_pkg ( $self->all_pkgs ) {
2944 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
2946 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2947 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2949 $list{$_}=1 foreach map { $_->email } @svc_acct;
2954 =item invoicing_list_addpost
2956 Adds postal invoicing to this customer. If this customer is already configured
2957 to receive postal invoices, does nothing.
2961 sub invoicing_list_addpost {
2963 if ( $self->get('postal_invoice') eq '' ) {
2964 $self->set('postal_invoice', 'Y');
2965 my $error = $self->replace;
2966 warn $error if $error; # should fail harder, but this is traditional
2970 =item invoicing_list_emailonly
2972 Returns the list of email invoice recipients (invoicing_list without non-email
2973 destinations such as POST and FAX).
2977 sub invoicing_list_emailonly {
2979 warn "$me invoicing_list_emailonly called"
2981 return () if !$self->custnum; # not yet inserted
2982 return map { $_->emailaddress }
2984 table => 'cust_contact',
2985 select => 'emailaddress',
2986 addl_from => ' JOIN contact USING (contactnum) '.
2987 ' JOIN contact_email USING (contactnum)',
2988 hashref => { 'custnum' => $self->custnum, },
2989 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
2993 =item invoicing_list_emailonly_scalar
2995 Returns the list of email invoice recipients (invoicing_list without non-email
2996 destinations such as POST and FAX) as a comma-separated scalar.
3000 sub invoicing_list_emailonly_scalar {
3002 warn "$me invoicing_list_emailonly_scalar called"
3004 join(', ', $self->invoicing_list_emailonly);
3007 =item contact_list [ CLASSNUM, ... ]
3009 Returns a list of contacts (L<FS::contact> objects) for the customer. If
3010 a list of contact classnums is given, returns only contacts in those
3011 classes. If the pseudo-classnum 'invoice' is given, returns contacts that
3012 are marked as invoice destinations. If '0' is given, also returns contacts
3015 If no arguments are given, returns all contacts for the customer.
3023 select => 'contact.*, cust_contact.invoice_dest',
3024 addl_from => ' JOIN cust_contact USING (contactnum)',
3025 extra_sql => ' WHERE cust_contact.custnum = '.$self->custnum,
3031 if ( $_ eq 'invoice' ) {
3032 push @orwhere, 'cust_contact.invoice_dest = \'Y\'';
3033 } elsif ( $_ eq '0' ) {
3034 push @orwhere, 'cust_contact.classnum is null';
3035 } elsif ( /^\d+$/ ) {
3036 push @classnums, $_;
3038 die "bad classnum argument '$_'";
3043 push @orwhere, 'cust_contact.classnum IN ('.join(',', @classnums).')';
3046 $search->{extra_sql} .= ' AND (' .
3047 join(' OR ', map "( $_ )", @orwhere) .
3054 =item contact_list_email [ CLASSNUM, ... ]
3056 Same as L</contact_list>, but returns email destinations instead of contact
3061 sub contact_list_email {
3063 my @contacts = $self->contact_list(@_);
3065 foreach my $contact (@contacts) {
3066 foreach my $contact_email ($contact->contact_email) {
3067 push @emails, Email::Address->new( $contact->firstlast,
3068 $contact_email->emailaddress
3075 =item referral_custnum_cust_main
3077 Returns the customer who referred this customer (or the empty string, if
3078 this customer was not referred).
3080 Note the difference with referral_cust_main method: This method,
3081 referral_custnum_cust_main returns the single customer (if any) who referred
3082 this customer, while referral_cust_main returns an array of customers referred
3087 sub referral_custnum_cust_main {
3089 return '' unless $self->referral_custnum;
3090 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3093 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3095 Returns an array of customers referred by this customer (referral_custnum set
3096 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3097 customers referred by customers referred by this customer and so on, inclusive.
3098 The default behavior is DEPTH 1 (no recursion).
3100 Note the difference with referral_custnum_cust_main method: This method,
3101 referral_cust_main, returns an array of customers referred BY this customer,
3102 while referral_custnum_cust_main returns the single customer (if any) who
3103 referred this customer.
3107 sub referral_cust_main {
3109 my $depth = @_ ? shift : 1;
3110 my $exclude = @_ ? shift : {};
3113 map { $exclude->{$_->custnum}++; $_; }
3114 grep { ! $exclude->{ $_->custnum } }
3115 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3119 map { $_->referral_cust_main($depth-1, $exclude) }
3126 =item referral_cust_main_ncancelled
3128 Same as referral_cust_main, except only returns customers with uncancelled
3133 sub referral_cust_main_ncancelled {
3135 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3138 =item referral_cust_pkg [ DEPTH ]
3140 Like referral_cust_main, except returns a flat list of all unsuspended (and
3141 uncancelled) packages for each customer. The number of items in this list may
3142 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3146 sub referral_cust_pkg {
3148 my $depth = @_ ? shift : 1;
3150 map { $_->unsuspended_pkgs }
3151 grep { $_->unsuspended_pkgs }
3152 $self->referral_cust_main($depth);
3155 =item referring_cust_main
3157 Returns the single cust_main record for the customer who referred this customer
3158 (referral_custnum), or false.
3162 sub referring_cust_main {
3164 return '' unless $self->referral_custnum;
3165 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3168 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3170 Applies a credit to this customer. If there is an error, returns the error,
3171 otherwise returns false.
3173 REASON can be a text string, an FS::reason object, or a scalar reference to
3174 a reasonnum. If a text string, it will be automatically inserted as a new
3175 reason, and a 'reason_type' option must be passed to indicate the
3176 FS::reason_type for the new reason.
3178 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3179 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3180 I<commission_pkgnum>.
3182 Any other options are passed to FS::cust_credit::insert.
3187 my( $self, $amount, $reason, %options ) = @_;
3189 my $cust_credit = new FS::cust_credit {
3190 'custnum' => $self->custnum,
3191 'amount' => $amount,
3194 if ( ref($reason) ) {
3196 if ( ref($reason) eq 'SCALAR' ) {
3197 $cust_credit->reasonnum( $$reason );
3199 $cust_credit->reasonnum( $reason->reasonnum );
3203 $cust_credit->set('reason', $reason)
3206 $cust_credit->$_( delete $options{$_} )
3207 foreach grep exists($options{$_}),
3208 qw( addlinfo eventnum ),
3209 map "commission_$_", qw( agentnum salesnum pkgnum );
3211 $cust_credit->insert(%options);
3215 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3217 Creates a one-time charge for this customer. If there is an error, returns
3218 the error, otherwise returns false.
3220 New-style, with a hashref of options:
3222 my $error = $cust_main->charge(
3226 'start_date' => str2time('7/4/2009'),
3227 'pkg' => 'Description',
3228 'comment' => 'Comment',
3229 'additional' => [], #extra invoice detail
3230 'classnum' => 1, #pkg_class
3232 'setuptax' => '', # or 'Y' for tax exempt
3234 'locationnum'=> 1234, # optional
3237 'taxclass' => 'Tax class',
3240 'taxproduct' => 2, #part_pkg_taxproduct
3241 'override' => {}, #XXX describe
3243 #will be filled in with the new object
3244 'cust_pkg_ref' => \$cust_pkg,
3246 #generate an invoice immediately
3248 'invoice_terms' => '', #with these terms
3254 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3258 #super false laziness w/quotation::charge
3261 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3262 my ( $pkg, $comment, $additional );
3263 my ( $setuptax, $taxclass ); #internal taxes
3264 my ( $taxproduct, $override ); #vendor (CCH) taxes
3266 my $separate_bill = '';
3267 my $cust_pkg_ref = '';
3268 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3270 my ( $discountnum, $discountnum_amount, $discountnum_percent ) = ( '','','' );
3271 if ( ref( $_[0] ) ) {
3272 $amount = $_[0]->{amount};
3273 $setup_cost = $_[0]->{setup_cost};
3274 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3275 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3276 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3277 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3278 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3279 : '$'. sprintf("%.2f",$amount);
3280 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3281 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3282 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3283 $additional = $_[0]->{additional} || [];
3284 $taxproduct = $_[0]->{taxproductnum};
3285 $override = { '' => $_[0]->{tax_override} };
3286 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3287 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3288 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3289 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3290 $separate_bill = $_[0]->{separate_bill} || '';
3291 $discountnum = $_[0]->{setup_discountnum};
3292 $discountnum_amount = $_[0]->{setup_discountnum_amount};
3293 $discountnum_percent = $_[0]->{setup_discountnum_percent};
3299 $pkg = @_ ? shift : 'One-time charge';
3300 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3302 $taxclass = @_ ? shift : '';
3306 local $SIG{HUP} = 'IGNORE';
3307 local $SIG{INT} = 'IGNORE';
3308 local $SIG{QUIT} = 'IGNORE';
3309 local $SIG{TERM} = 'IGNORE';
3310 local $SIG{TSTP} = 'IGNORE';
3311 local $SIG{PIPE} = 'IGNORE';
3313 my $oldAutoCommit = $FS::UID::AutoCommit;
3314 local $FS::UID::AutoCommit = 0;
3317 my $part_pkg = new FS::part_pkg ( {
3319 'comment' => $comment,
3323 'classnum' => ( $classnum ? $classnum : '' ),
3324 'setuptax' => $setuptax,
3325 'taxclass' => $taxclass,
3326 'taxproductnum' => $taxproduct,
3327 'setup_cost' => $setup_cost,
3330 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3331 ( 0 .. @$additional - 1 )
3333 'additional_count' => scalar(@$additional),
3334 'setup_fee' => $amount,
3337 my $error = $part_pkg->insert( options => \%options,
3338 tax_overrides => $override,
3341 $dbh->rollback if $oldAutoCommit;
3345 my $pkgpart = $part_pkg->pkgpart;
3346 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3347 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3348 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3349 $error = $type_pkgs->insert;
3351 $dbh->rollback if $oldAutoCommit;
3356 my $cust_pkg = new FS::cust_pkg ( {
3357 'custnum' => $self->custnum,
3358 'pkgpart' => $pkgpart,
3359 'quantity' => $quantity,
3360 'start_date' => $start_date,
3361 'no_auto' => $no_auto,
3362 'separate_bill' => $separate_bill,
3363 'locationnum' => $locationnum,
3364 'setup_discountnum' => $discountnum,
3365 'setup_discountnum_amount' => $discountnum_amount,
3366 'setup_discountnum_percent' => $discountnum_percent,
3369 $error = $cust_pkg->insert;
3371 $dbh->rollback if $oldAutoCommit;
3373 } elsif ( $cust_pkg_ref ) {
3374 ${$cust_pkg_ref} = $cust_pkg;
3378 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3379 'pkg_list' => [ $cust_pkg ],
3382 $dbh->rollback if $oldAutoCommit;
3387 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3392 #=item charge_postal_fee
3394 #Applies a one time charge this customer. If there is an error,
3395 #returns the error, returns the cust_pkg charge object or false
3396 #if there was no charge.
3400 # This should be a customer event. For that to work requires that bill
3401 # also be a customer event.
3403 sub charge_postal_fee {
3406 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3407 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3409 my $cust_pkg = new FS::cust_pkg ( {
3410 'custnum' => $self->custnum,
3411 'pkgpart' => $pkgpart,
3415 my $error = $cust_pkg->insert;
3416 $error ? $error : $cust_pkg;
3419 =item num_cust_attachment_deleted
3421 Returns the number of deleted attachments for this customer (see
3422 L<FS::num_cust_attachment>).
3426 sub num_cust_attachments_deleted {
3429 " SELECT COUNT(*) FROM cust_attachment ".
3430 " WHERE custnum = ? AND disabled IS NOT NULL AND disabled > 0",
3437 Returns the most recent invnum (invoice number) for this customer.
3444 " SELECT MAX(invnum) FROM cust_bill WHERE custnum = ?",
3449 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3451 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3453 Optionally, a list or hashref of additional arguments to the qsearch call can
3460 my $opt = ref($_[0]) ? shift : { @_ };
3462 #return $self->num_cust_bill unless wantarray || keys %$opt;
3464 $opt->{'table'} = 'cust_bill';
3465 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3466 $opt->{'hashref'}{'custnum'} = $self->custnum;
3467 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3469 map { $_ } #behavior of sort undefined in scalar context
3470 sort { $a->_date <=> $b->_date }
3474 =item open_cust_bill
3476 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3481 sub open_cust_bill {
3485 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3491 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3493 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3497 sub legacy_cust_bill {
3500 #return $self->num_legacy_cust_bill unless wantarray;
3502 map { $_ } #behavior of sort undefined in scalar context
3503 sort { $a->_date <=> $b->_date }
3504 qsearch({ 'table' => 'legacy_cust_bill',
3505 'hashref' => { 'custnum' => $self->custnum, },
3506 'order_by' => 'ORDER BY _date ASC',
3510 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3512 Returns all the statements (see L<FS::cust_statement>) for this customer.
3514 Optionally, a list or hashref of additional arguments to the qsearch call can
3519 =item cust_bill_void
3521 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3525 sub cust_bill_void {
3528 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3529 sort { $a->_date <=> $b->_date }
3530 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3533 sub cust_statement {
3535 my $opt = ref($_[0]) ? shift : { @_ };
3537 #return $self->num_cust_statement unless wantarray || keys %$opt;
3539 $opt->{'table'} = 'cust_statement';
3540 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3541 $opt->{'hashref'}{'custnum'} = $self->custnum;
3542 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3544 map { $_ } #behavior of sort undefined in scalar context
3545 sort { $a->_date <=> $b->_date }
3549 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3551 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3553 Optionally, a list or hashref of additional arguments to the qsearch call can
3554 be passed following the SVCDB.
3561 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3562 warn "$me svc_x requires a svcdb";
3565 my $opt = ref($_[0]) ? shift : { @_ };
3567 $opt->{'table'} = $svcdb;
3568 $opt->{'addl_from'} =
3569 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3570 ($opt->{'addl_from'} || '');
3572 my $custnum = $self->custnum;
3573 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3574 my $where = "cust_pkg.custnum = $custnum";
3576 my $extra_sql = $opt->{'extra_sql'} || '';
3577 if ( keys %{ $opt->{'hashref'} } ) {
3578 $extra_sql = " AND $where $extra_sql";
3581 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3582 $extra_sql = "WHERE $where AND $1";
3585 $extra_sql = "WHERE $where $extra_sql";
3588 $opt->{'extra_sql'} = $extra_sql;
3593 # required for use as an eventtable;
3596 $self->svc_x('svc_acct', @_);
3601 Returns all the credits (see L<FS::cust_credit>) for this customer.
3608 #return $self->num_cust_credit unless wantarray;
3610 map { $_ } #behavior of sort undefined in scalar context
3611 sort { $a->_date <=> $b->_date }
3612 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3615 =item cust_credit_pkgnum
3617 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3618 package when using experimental package balances.
3622 sub cust_credit_pkgnum {
3623 my( $self, $pkgnum ) = @_;
3624 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3625 sort { $a->_date <=> $b->_date }
3626 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3627 'pkgnum' => $pkgnum,
3632 =item cust_credit_void
3634 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3638 sub cust_credit_void {
3641 sort { $a->_date <=> $b->_date }
3642 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3647 Returns all the payments (see L<FS::cust_pay>) for this customer.
3653 my $opt = ref($_[0]) ? shift : { @_ };
3655 return $self->num_cust_pay unless wantarray || keys %$opt;
3657 $opt->{'table'} = 'cust_pay';
3658 $opt->{'hashref'}{'custnum'} = $self->custnum;
3660 map { $_ } #behavior of sort undefined in scalar context
3661 sort { $a->_date <=> $b->_date }
3668 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3669 called automatically when the cust_pay method is used in a scalar context.
3675 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3676 my $sth = dbh->prepare($sql) or die dbh->errstr;
3677 $sth->execute($self->custnum) or die $sth->errstr;
3678 $sth->fetchrow_arrayref->[0];
3681 =item unapplied_cust_pay
3683 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3687 sub unapplied_cust_pay {
3691 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3697 =item cust_pay_pkgnum
3699 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3700 package when using experimental package balances.
3704 sub cust_pay_pkgnum {
3705 my( $self, $pkgnum ) = @_;
3706 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3707 sort { $a->_date <=> $b->_date }
3708 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3709 'pkgnum' => $pkgnum,
3716 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3722 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3723 sort { $a->_date <=> $b->_date }
3724 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3727 =item cust_pay_pending
3729 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3730 (without status "done").
3734 sub cust_pay_pending {
3736 return $self->num_cust_pay_pending unless wantarray;
3737 sort { $a->_date <=> $b->_date }
3738 qsearch( 'cust_pay_pending', {
3739 'custnum' => $self->custnum,
3740 'status' => { op=>'!=', value=>'done' },
3745 =item cust_pay_pending_attempt
3747 Returns all payment attempts / declined payments for this customer, as pending
3748 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3749 a corresponding payment (see L<FS::cust_pay>).
3753 sub cust_pay_pending_attempt {
3755 return $self->num_cust_pay_pending_attempt unless wantarray;
3756 sort { $a->_date <=> $b->_date }
3757 qsearch( 'cust_pay_pending', {
3758 'custnum' => $self->custnum,
3765 =item num_cust_pay_pending
3767 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3768 customer (without status "done"). Also called automatically when the
3769 cust_pay_pending method is used in a scalar context.
3773 sub num_cust_pay_pending {
3776 " SELECT COUNT(*) FROM cust_pay_pending ".
3777 " WHERE custnum = ? AND status != 'done' ",
3782 =item num_cust_pay_pending_attempt
3784 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3785 customer, with status "done" but without a corresp. Also called automatically when the
3786 cust_pay_pending method is used in a scalar context.
3790 sub num_cust_pay_pending_attempt {
3793 " SELECT COUNT(*) FROM cust_pay_pending ".
3794 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3801 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3807 map { $_ } #return $self->num_cust_refund unless wantarray;
3808 sort { $a->_date <=> $b->_date }
3809 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3812 =item display_custnum
3814 Returns the displayed customer number for this customer: agent_custid if
3815 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3819 sub display_custnum {
3822 return $self->agent_custid
3823 if $default_agent_custid && $self->agent_custid;
3825 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3829 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
3830 } elsif ( $custnum_display_length ) {
3831 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
3833 return $self->custnum;
3839 Returns a name string for this customer, either "Company (Last, First)" or
3846 my $name = $self->contact;
3847 $name = $self->company. " ($name)" if $self->company;
3851 =item service_contact
3853 Returns the L<FS::contact> object for this customer that has the 'Service'
3854 contact class, or undef if there is no such contact. Deprecated; don't use
3859 sub service_contact {
3861 if ( !exists($self->{service_contact}) ) {
3862 my $classnum = $self->scalar_sql(
3863 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3864 ) || 0; #if it's zero, qsearchs will return nothing
3865 my $cust_contact = qsearchs('cust_contact', {
3866 'classnum' => $classnum,
3867 'custnum' => $self->custnum,
3869 $self->{service_contact} = $cust_contact->contact if $cust_contact;
3871 $self->{service_contact};
3876 Returns a name string for this (service/shipping) contact, either
3877 "Company (Last, First)" or "Last, First".
3884 my $name = $self->ship_contact;
3885 $name = $self->company. " ($name)" if $self->company;
3891 Returns a name string for this customer, either "Company" or "First Last".
3897 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3900 =item ship_name_short
3902 Returns a name string for this (service/shipping) contact, either "Company"
3907 sub ship_name_short {
3909 $self->service_contact
3910 ? $self->ship_contact_firstlast
3916 Returns this customer's full (billing) contact name only, "Last, First"
3922 $self->get('last'). ', '. $self->first;
3927 Returns this customer's full (shipping) contact name only, "Last, First"
3933 my $contact = $self->service_contact || $self;
3934 $contact->get('last') . ', ' . $contact->get('first');
3937 =item contact_firstlast
3939 Returns this customers full (billing) contact name only, "First Last".
3943 sub contact_firstlast {
3945 $self->first. ' '. $self->get('last');
3948 =item ship_contact_firstlast
3950 Returns this customer's full (shipping) contact name only, "First Last".
3954 sub ship_contact_firstlast {
3956 my $contact = $self->service_contact || $self;
3957 $contact->get('first') . ' '. $contact->get('last');
3960 sub bill_country_full {
3962 $self->bill_location->country_full;
3965 sub ship_country_full {
3967 $self->ship_location->country_full;
3970 =item county_state_county [ PREFIX ]
3972 Returns a string consisting of just the county, state and country.
3976 sub county_state_country {
3979 if ( @_ && $_[0] && $self->has_ship_address ) {
3980 $locationnum = $self->ship_locationnum;
3982 $locationnum = $self->bill_locationnum;
3984 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
3985 $cust_location->county_state_country;
3988 =item geocode DATA_VENDOR
3990 Returns a value for the customer location as encoded by DATA_VENDOR.
3991 Currently this only makes sense for "CCH" as DATA_VENDOR.
3999 Returns a status string for this customer, currently:
4005 No packages have ever been ordered. Displayed as "No packages".
4009 Recurring packages all are new (not yet billed).
4013 One or more recurring packages is active.
4017 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
4021 All non-cancelled recurring packages are suspended.
4025 All recurring packages are cancelled.
4029 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4030 cust_main-status_module configuration option.
4034 sub status { shift->cust_status(@_); }
4038 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4039 for my $status ( FS::cust_main->statuses() ) {
4040 my $method = $status.'_sql';
4041 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4042 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4043 $sth->execute( ($self->custnum) x $numnum )
4044 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4045 if ( $sth->fetchrow_arrayref->[0] ) {
4046 $self->hashref->{cust_status} = $status;
4052 =item is_status_delay_cancel
4054 Returns true if customer status is 'suspended'
4055 and all suspended cust_pkg return true for
4056 cust_pkg->is_status_delay_cancel.
4058 This is not a real status, this only meant for hacking display
4059 values, because otherwise treating the customer as suspended is
4060 really the whole point of the delay_cancel option.
4064 sub is_status_delay_cancel {
4066 return 0 unless $self->status eq 'suspended';
4067 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4068 return 0 unless $cust_pkg->is_status_delay_cancel;
4073 =item ucfirst_cust_status
4075 =item ucfirst_status
4077 Deprecated, use the cust_status_label method instead.
4079 Returns the status with the first character capitalized.
4083 sub ucfirst_status {
4084 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4085 local($ucfirst_nowarn) = 1;
4086 shift->ucfirst_cust_status(@_);
4089 sub ucfirst_cust_status {
4090 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4092 ucfirst($self->cust_status);
4095 =item cust_status_label
4099 Returns the display label for this status.
4103 sub status_label { shift->cust_status_label(@_); }
4105 sub cust_status_label {
4107 __PACKAGE__->statuslabels->{$self->cust_status};
4112 Returns a hex triplet color string for this customer's status.
4116 sub statuscolor { shift->cust_statuscolor(@_); }
4118 sub cust_statuscolor {
4120 __PACKAGE__->statuscolors->{$self->cust_status};
4123 =item tickets [ STATUS ]
4125 Returns an array of hashes representing the customer's RT tickets.
4127 An optional status (or arrayref or hashref of statuses) may be specified.
4133 my $status = ( @_ && $_[0] ) ? shift : '';
4135 my $num = $conf->config('cust_main-max_tickets') || 10;
4138 if ( $conf->config('ticket_system') ) {
4139 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4141 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4150 foreach my $priority (
4151 $conf->config('ticket_system-custom_priority_field-values'), ''
4153 last if scalar(@tickets) >= $num;
4155 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4156 $num - scalar(@tickets),
4167 =item appointments [ STATUS ]
4169 Returns an array of hashes representing the customer's RT tickets which
4176 my $status = ( @_ && $_[0] ) ? shift : '';
4178 return () unless $conf->config('ticket_system');
4180 my $queueid = $conf->config('ticket_system-appointment-queueid');
4182 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4191 # Return services representing svc_accts in customer support packages
4192 sub support_services {
4194 my %packages = map { $_ => 1 } $conf->config('support_packages');
4196 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4197 grep { $_->part_svc->svcdb eq 'svc_acct' }
4198 map { $_->cust_svc }
4199 grep { exists $packages{ $_->pkgpart } }
4200 $self->ncancelled_pkgs;
4204 # Return a list of latitude/longitude for one of the services (if any)
4205 sub service_coordinates {
4209 grep { $_->latitude && $_->longitude }
4211 map { $_->cust_svc }
4212 $self->ncancelled_pkgs;
4214 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4219 Returns a masked version of the named field
4224 my ($self,$field) = @_;
4228 'x'x(length($self->getfield($field))-4).
4229 substr($self->getfield($field), (length($self->getfield($field))-4));
4233 =item payment_history
4235 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4236 cust_credit and cust_refund objects. Each hashref has the following fields:
4238 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4240 I<date> - value of _date field, unix timestamp
4242 I<date_pretty> - user-friendly date
4244 I<description> - user-friendly description of item
4246 I<amount> - impact of item on user's balance
4247 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4248 Not to be confused with the native 'amount' field in cust_credit, see below.
4250 I<amount_pretty> - includes money char
4252 I<balance> - customer balance, chronologically as of this item
4254 I<balance_pretty> - includes money char
4256 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4258 I<paid> - amount paid for cust_pay records, undef for other types
4260 I<credit> - amount credited for cust_credit records, undef for other types.
4261 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4263 I<refund> - amount refunded for cust_refund records, undef for other types
4265 The four table-specific keys always have positive values, whether they reflect charges or payments.
4267 The following options may be passed to this method:
4269 I<line_items> - if true, returns charges ('Line item') rather than invoices
4271 I<start_date> - unix timestamp, only include records on or after.
4272 If specified, an item of type 'Previous' will also be included.
4273 It does not have table-specific fields.
4275 I<end_date> - unix timestamp, only include records before
4277 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4279 I<conf> - optional already-loaded FS::Conf object.
4283 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4284 # and also for sending customer statements, which should both be kept customer-friendly.
4285 # If you add anything that shouldn't be passed on through the API or exposed
4286 # to customers, add a new option to include it, don't include it by default
4287 sub payment_history {
4289 my $opt = ref($_[0]) ? $_[0] : { @_ };
4291 my $conf = $$opt{'conf'} || new FS::Conf;
4292 my $money_char = $conf->config("money_char") || '$',
4294 #first load entire history,
4295 #need previous to calculate previous balance
4296 #loading after end_date shouldn't hurt too much?
4298 if ( $$opt{'line_items'} ) {
4300 foreach my $cust_bill ( $self->cust_bill ) {
4303 'type' => 'Line item',
4304 'description' => $_->desc( $self->locale ).
4305 ( $_->sdate && $_->edate
4306 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4307 ' To '. time2str('%d-%b-%Y', $_->edate)
4310 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4311 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4312 'date' => $cust_bill->_date,
4313 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4315 foreach $cust_bill->cust_bill_pkg;
4322 'type' => 'Invoice',
4323 'description' => 'Invoice #'. $_->display_invnum,
4324 'amount' => sprintf('%.2f', $_->charged ),
4325 'charged' => sprintf('%.2f', $_->charged ),
4326 'date' => $_->_date,
4327 'date_pretty' => $self->time2str_local('short', $_->_date ),
4329 foreach $self->cust_bill;
4334 'type' => 'Payment',
4335 'description' => 'Payment', #XXX type
4336 'amount' => sprintf('%.2f', 0 - $_->paid ),
4337 'paid' => sprintf('%.2f', $_->paid ),
4338 'date' => $_->_date,
4339 'date_pretty' => $self->time2str_local('short', $_->_date ),
4341 foreach $self->cust_pay;
4345 'description' => 'Credit', #more info?
4346 'amount' => sprintf('%.2f', 0 -$_->amount ),
4347 'credit' => sprintf('%.2f', $_->amount ),
4348 'date' => $_->_date,
4349 'date_pretty' => $self->time2str_local('short', $_->_date ),
4351 foreach $self->cust_credit;
4355 'description' => 'Refund', #more info? type, like payment?
4356 'amount' => $_->refund,
4357 'refund' => $_->refund,
4358 'date' => $_->_date,
4359 'date_pretty' => $self->time2str_local('short', $_->_date ),
4361 foreach $self->cust_refund;
4363 #put it all in chronological order
4364 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4366 #calculate balance, filter items outside date range
4370 foreach my $item (@history) {
4371 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4372 $balance += $$item{'amount'};
4373 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4374 $previous += $$item{'amount'};
4377 $$item{'balance'} = sprintf("%.2f",$balance);
4378 foreach my $key ( qw(amount balance) ) {
4379 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4384 # start with previous balance, if there was one
4387 'type' => 'Previous',
4388 'description' => 'Previous balance',
4389 'amount' => sprintf("%.2f",$previous),
4390 'balance' => sprintf("%.2f",$previous),
4391 'date' => $$opt{'start_date'},
4392 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4394 #false laziness with above
4395 foreach my $key ( qw(amount balance) ) {
4396 $$item{$key.'_pretty'} = $$item{$key};
4397 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4399 unshift(@out,$item);
4402 @out = reverse @history if $$opt{'reverse_sort'};
4407 =item save_cust_payby
4409 Saves a new cust_payby for this customer, replacing an existing entry only
4410 in select circumstances. Does not validate input.
4412 If auto is specified, marks this as the customer's primary method, or the
4413 specified weight. Existing payment methods have their weight incremented as
4416 If bill_location is specified with auto, also sets location in cust_main.
4418 Will not insert complete duplicates of existing records, or records in which the
4419 only difference from an existing record is to turn off automatic payment (will
4420 return without error.) Will replace existing records in which the only difference
4421 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4422 Fields marked as preserved are optional, and existing values will not be overwritten with
4423 blanks when replacing.
4425 Accepts the following named parameters:
4435 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4439 optional, set higher than 1 for secondary, etc.
4447 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4455 optional, will be preserved when replacing
4463 CARD only, required, FS::cust_location object
4465 =item paystart_month
4467 CARD only, optional, will be preserved when replacing
4471 CARD only, optional, will be preserved when replacing
4475 CARD only, optional, will be preserved when replacing
4479 CARD only, only used if conf cvv-save is set appropriately
4489 =item saved_cust_payby
4491 scalar reference, for returning saved object
4497 #The code for this option is in place, but it's not currently used
4501 # existing cust_payby object to be replaced (must match custnum)
4503 # stateid/stateid_state/ss are not currently supported in cust_payby,
4504 # might not even work properly in 4.x, but will need to work here if ever added
4506 sub save_cust_payby {
4510 my $old = $opt{'replace'};
4511 my $new = new FS::cust_payby { $old ? $old->hash : () };
4512 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4513 $new->set( 'custnum' => $self->custnum );
4515 my $payby = $opt{'payment_payby'};
4516 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4518 # don't allow turning off auto when replacing
4519 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4521 my @check_existing; # payby relevant to this payment_payby
4523 # set payby based on auto
4524 if ( $payby eq 'CARD' ) {
4525 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4526 @check_existing = qw( CARD DCRD );
4527 } elsif ( $payby eq 'CHEK' ) {
4528 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4529 @check_existing = qw( CHEK DCHK );
4532 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4535 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4536 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4537 $new->set( 'payname' => $opt{'payname'} );
4538 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4540 my $conf = new FS::Conf;
4542 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4543 if ( $payby eq 'CARD' &&
4544 ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4545 || $conf->exists('business-onlinepayment-verification')
4548 $new->set( 'paycvv' => $opt{'paycvv'} );
4550 $new->set( 'paycvv' => '');
4553 local $SIG{HUP} = 'IGNORE';
4554 local $SIG{INT} = 'IGNORE';
4555 local $SIG{QUIT} = 'IGNORE';
4556 local $SIG{TERM} = 'IGNORE';
4557 local $SIG{TSTP} = 'IGNORE';
4558 local $SIG{PIPE} = 'IGNORE';
4560 my $oldAutoCommit = $FS::UID::AutoCommit;
4561 local $FS::UID::AutoCommit = 0;
4564 # set fields specific to payment_payby
4565 if ( $payby eq 'CARD' ) {
4566 if ($opt{'bill_location'}) {
4567 $opt{'bill_location'}->set('custnum' => $self->custnum);
4568 my $error = $opt{'bill_location'}->find_or_insert;
4570 $dbh->rollback if $oldAutoCommit;
4573 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4575 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4576 $new->set( $field => $opt{$field} );
4579 foreach my $field ( qw(paytype paystate) ) {
4580 $new->set( $field => $opt{$field} );
4584 # other cust_payby to compare this to
4585 my @existing = $self->cust_payby(@check_existing);
4587 # fields that can overwrite blanks with values, but not values with blanks
4588 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4590 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4592 # generally, we don't want to overwrite existing cust_payby with this,
4593 # but we can replace if we're only marking it auto or adding a preserved field
4594 # and we can avoid saving a total duplicate or merely turning off auto
4596 foreach my $cust_payby (@existing) {
4597 # check fields that absolutely should not change
4598 foreach my $field ($new->fields) {
4599 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4600 next if grep(/^$field$/, @preserve );
4601 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4603 # now check fields that can replace if one value is blank
4605 foreach my $field (@preserve) {
4607 ( $new->get($field) and !$cust_payby->get($field) ) or
4608 ( $cust_payby->get($field) and !$new->get($field) )
4610 # prevention of overwriting values with blanks happens farther below
4612 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4616 unless ( $replace ) {
4617 # nearly identical, now check weight
4618 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4619 # ignore identical cust_payby, and ignore attempts to turn off auto
4620 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4621 $skip_cust_payby = 1;
4624 # otherwise, only change is to mark this as primary
4626 # if we got this far, we're definitely replacing
4633 $new->set( 'custpaybynum' => $old->custpaybynum );
4634 # don't turn off automatic payment (but allow it to be turned on)
4635 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4637 $new->set( 'payby' => $old->payby );
4638 $new->set( 'weight' => 1 );
4640 # make sure we're not overwriting values with blanks
4641 foreach my $field (@preserve) {
4642 if ( $old->get($field) and !$new->get($field) ) {
4643 $new->set( $field => $old->get($field) );
4648 # only overwrite cust_main bill_location if auto
4649 if ($opt{'auto'} && $opt{'bill_location'}) {
4650 $self->set('bill_location' => $opt{'bill_location'});
4651 my $error = $self->replace;
4653 $dbh->rollback if $oldAutoCommit;
4658 # done with everything except reweighting and saving cust_payby
4659 # still need to commit changes to cust_main and cust_location
4660 if ($skip_cust_payby) {
4661 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4665 # re-weight existing primary cust_pay for this payby
4667 foreach my $cust_payby (@existing) {
4668 # relies on cust_payby return order
4669 last unless $cust_payby->payby !~ /^D/;
4670 last if $cust_payby->weight > 1;
4671 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4672 next if $cust_payby->weight < ($opt{'weight'} || 1);
4673 $cust_payby->weight( $cust_payby->weight + 1 );
4674 my $error = $cust_payby->replace;
4676 $dbh->rollback if $oldAutoCommit;
4677 return "Error reweighting cust_payby: $error";
4682 # finally, save cust_payby
4683 my $error = $old ? $new->replace($old) : $new->insert;
4685 $dbh->rollback if $oldAutoCommit;
4689 ${$opt{'saved_cust_payby'}} = $new
4690 if $opt{'saved_cust_payby'};
4692 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4697 =item remove_cvv_from_cust_payby PAYINFO
4699 Removes paycvv from associated cust_payby with matching PAYINFO.
4703 sub remove_cvv_from_cust_payby {
4704 my ($self,$payinfo) = @_;
4706 my $oldAutoCommit = $FS::UID::AutoCommit;
4707 local $FS::UID::AutoCommit = 0;
4710 foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
4711 next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
4712 $cust_payby->paycvv('');
4713 my $error = $cust_payby->replace;
4715 $dbh->rollback if $oldAutoCommit;
4720 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4726 =head1 CLASS METHODS
4732 Class method that returns the list of possible status strings for customers
4733 (see L<the status method|/status>). For example:
4735 @statuses = FS::cust_main->statuses();
4741 keys %{ $self->statuscolors };
4744 =item cust_status_sql
4746 Returns an SQL fragment to determine the status of a cust_main record, as a
4751 sub cust_status_sql {
4753 for my $status ( FS::cust_main->statuses() ) {
4754 my $method = $status.'_sql';
4755 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4764 Returns an SQL expression identifying prospective cust_main records (customers
4765 with no packages ever ordered)
4769 use vars qw($select_count_pkgs);
4770 $select_count_pkgs =
4771 "SELECT COUNT(*) FROM cust_pkg
4772 WHERE cust_pkg.custnum = cust_main.custnum";
4774 sub select_count_pkgs_sql {
4779 " 0 = ( $select_count_pkgs ) ";
4784 Returns an SQL expression identifying ordered cust_main records (customers with
4785 no active packages, but recurring packages not yet setup or one time charges
4791 FS::cust_main->none_active_sql.
4792 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4797 Returns an SQL expression identifying active cust_main records (customers with
4798 active recurring packages).
4803 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4806 =item none_active_sql
4808 Returns an SQL expression identifying cust_main records with no active
4809 recurring packages. This includes customers of status prospect, ordered,
4810 inactive, and suspended.
4814 sub none_active_sql {
4815 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4820 Returns an SQL expression identifying inactive cust_main records (customers with
4821 no active recurring packages, but otherwise unsuspended/uncancelled).
4826 FS::cust_main->none_active_sql.
4827 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4833 Returns an SQL expression identifying suspended cust_main records.
4838 sub suspended_sql { susp_sql(@_); }
4840 FS::cust_main->none_active_sql.
4841 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4847 Returns an SQL expression identifying cancelled cust_main records.
4851 sub cancel_sql { shift->cancelled_sql(@_); }
4854 =item uncancelled_sql
4856 Returns an SQL expression identifying un-cancelled cust_main records.
4860 sub uncancelled_sql { uncancel_sql(@_); }
4863 "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
4868 Returns an SQL fragment to retreive the balance.
4873 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4874 WHERE cust_bill.custnum = cust_main.custnum )
4875 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4876 WHERE cust_pay.custnum = cust_main.custnum )
4877 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4878 WHERE cust_credit.custnum = cust_main.custnum )
4879 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4880 WHERE cust_refund.custnum = cust_main.custnum )
4883 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4885 Returns an SQL fragment to retreive the balance for this customer, optionally
4886 considering invoices with date earlier than START_TIME, and not
4887 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4888 total_unapplied_payments).
4890 Times are specified as SQL fragments or numeric
4891 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4892 L<Date::Parse> for conversion functions. The empty string can be passed
4893 to disable that time constraint completely.
4895 Available options are:
4899 =item unapplied_date
4901 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)
4906 set to true to remove all customer comparison clauses, for totals
4911 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4916 JOIN clause (typically used with the total option)
4920 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4921 time will be ignored. Note that START_TIME and END_TIME only limit the date
4922 range for invoices and I<unapplied> payments, credits, and refunds.
4928 sub balance_date_sql {
4929 my( $class, $start, $end, %opt ) = @_;
4931 my $cutoff = $opt{'cutoff'};
4933 my $owed = FS::cust_bill->owed_sql($cutoff);
4934 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4935 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4936 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4938 my $j = $opt{'join'} || '';
4940 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4941 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4942 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4943 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4945 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4946 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4947 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4948 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4953 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4955 Returns an SQL fragment to retreive the total unapplied payments for this
4956 customer, only considering payments with date earlier than START_TIME, and
4957 optionally not later than END_TIME.
4959 Times are specified as SQL fragments or numeric
4960 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4961 L<Date::Parse> for conversion functions. The empty string can be passed
4962 to disable that time constraint completely.
4964 Available options are:
4968 sub unapplied_payments_date_sql {
4969 my( $class, $start, $end, %opt ) = @_;
4971 my $cutoff = $opt{'cutoff'};
4973 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4975 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4976 'unapplied_date'=>1 );
4978 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4981 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4983 Helper method for balance_date_sql; name (and usage) subject to change
4984 (suggestions welcome).
4986 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4987 cust_refund, cust_credit or cust_pay).
4989 If TABLE is "cust_bill" or the unapplied_date option is true, only
4990 considers records with date earlier than START_TIME, and optionally not
4991 later than END_TIME .
4995 sub _money_table_where {
4996 my( $class, $table, $start, $end, %opt ) = @_;
4999 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5000 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5001 push @where, "$table._date <= $start" if defined($start) && length($start);
5002 push @where, "$table._date > $end" if defined($end) && length($end);
5004 push @where, @{$opt{'where'}} if $opt{'where'};
5005 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5011 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
5012 use FS::cust_main::Search;
5015 FS::cust_main::Search->search(@_);
5024 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5026 Generates a templated notification to the customer (see L<Text::Template>).
5028 OPTIONS is a hash and may include
5030 I<extra_fields> - a hashref of name/value pairs which will be substituted
5031 into the template. These values may override values mentioned below
5032 and those from the customer record.
5034 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5036 The following variables are available in the template instead of or in addition
5037 to the fields of the customer record.
5039 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5043 # a lot like cust_bill::print_latex
5044 sub generate_letter {
5045 my ($self, $template, %options) = @_;
5047 warn "Template $template does not exist" && return
5048 unless $conf->exists($template) || $options{'template_text'};
5050 my $template_source = $options{'template_text'}
5051 ? [ $options{'template_text'} ]
5052 : [ map "$_\n", $conf->config($template) ];
5054 my $letter_template = new Text::Template
5056 SOURCE => $template_source,
5057 DELIMITERS => [ '[@--', '--@]' ],
5059 or die "can't create new Text::Template object: Text::Template::ERROR";
5061 $letter_template->compile()
5062 or die "can't compile template: Text::Template::ERROR";
5064 my %letter_data = map { $_ => $self->$_ } $self->fields;
5066 for (keys %{$options{extra_fields}}){
5067 $letter_data{$_} = $options{extra_fields}->{$_};
5070 unless(exists($letter_data{returnaddress})){
5071 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5072 $self->agent_template)
5074 if ( length($retadd) ) {
5075 $letter_data{returnaddress} = $retadd;
5076 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5077 $letter_data{returnaddress} =
5078 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5082 ( $conf->config('company_name', $self->agentnum),
5083 $conf->config('company_address', $self->agentnum),
5087 $letter_data{returnaddress} = '~';
5091 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5093 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5095 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5097 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5101 ) or die "can't open temp file: $!\n";
5102 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5103 or die "can't write temp file: $!\n";
5105 $letter_data{'logo_file'} = $lh->filename;
5107 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5111 ) or die "can't open temp file: $!\n";
5113 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5115 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5116 return ($1, $letter_data{'logo_file'});
5120 =item print_ps TEMPLATE
5122 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5128 my($file, $lfile) = $self->generate_letter(@_);
5129 my $ps = FS::Misc::generate_ps($file);
5130 unlink($file.'.tex');
5136 =item print TEMPLATE
5138 Prints the filled in template.
5140 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5144 sub queueable_print {
5147 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5148 or die "invalid customer number: " . $opt{custnum};
5150 #do not backport this change to 3.x
5151 # my $error = $self->print( { 'template' => $opt{template} } );
5152 my $error = $self->print( $opt{'template'} );
5153 die $error if $error;
5157 my ($self, $template) = (shift, shift);
5159 [ $self->print_ps($template) ],
5160 'agentnum' => $self->agentnum,
5164 #these three subs should just go away once agent stuff is all config overrides
5166 sub agent_template {
5168 $self->_agent_plandata('agent_templatename');
5171 sub agent_invoice_from {
5173 $self->_agent_plandata('agent_invoice_from');
5176 sub _agent_plandata {
5177 my( $self, $option ) = @_;
5179 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5180 #agent-specific Conf
5182 use FS::part_event::Condition;
5184 my $agentnum = $self->agentnum;
5186 my $regexp = regexp_sql();
5188 my $part_event_option =
5190 'select' => 'part_event_option.*',
5191 'table' => 'part_event_option',
5193 LEFT JOIN part_event USING ( eventpart )
5194 LEFT JOIN part_event_option AS peo_agentnum
5195 ON ( part_event.eventpart = peo_agentnum.eventpart
5196 AND peo_agentnum.optionname = 'agentnum'
5197 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5199 LEFT JOIN part_event_condition
5200 ON ( part_event.eventpart = part_event_condition.eventpart
5201 AND part_event_condition.conditionname = 'cust_bill_age'
5203 LEFT JOIN part_event_condition_option
5204 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5205 AND part_event_condition_option.optionname = 'age'
5208 #'hashref' => { 'optionname' => $option },
5209 #'hashref' => { 'part_event_option.optionname' => $option },
5211 " WHERE part_event_option.optionname = ". dbh->quote($option).
5212 " AND action = 'cust_bill_send_agent' ".
5213 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5214 " AND peo_agentnum.optionname = 'agentnum' ".
5215 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5217 CASE WHEN part_event_condition_option.optionname IS NULL
5219 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5221 , part_event.weight".
5225 unless ( $part_event_option ) {
5226 return $self->agent->invoice_template || ''
5227 if $option eq 'agent_templatename';
5231 $part_event_option->optionvalue;
5235 sub process_o2m_qsearch {
5238 return qsearch($table, @_) unless $table eq 'contact';
5240 my $hashref = shift;
5241 my %hash = %$hashref;
5242 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5243 or die 'guru meditation #4343';
5245 qsearch({ 'table' => 'contact',
5246 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5247 'hashref' => \%hash,
5248 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5249 " cust_contact.custnum = $custnum "
5253 sub process_o2m_qsearchs {
5256 return qsearchs($table, @_) unless $table eq 'contact';
5258 my $hashref = shift;
5259 my %hash = %$hashref;
5260 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5261 or die 'guru meditation #2121';
5263 qsearchs({ 'table' => 'contact',
5264 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5265 'hashref' => \%hash,
5266 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5267 " cust_contact.custnum = $custnum "
5271 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5273 Subroutine (not a method), designed to be called from the queue.
5275 Takes a list of options and values.
5277 Pulls up the customer record via the custnum option and calls bill_and_collect.
5282 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5284 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5285 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5287 #without this errors don't get rolled back
5288 $args{'fatal'} = 1; # runs from job queue, will be caught
5290 $cust_main->bill_and_collect( %args );
5293 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5295 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5296 C<collect> part. This is used in batch tax calculation, where invoice
5297 generation and collection events have to be completely separated.
5301 sub queued_collect {
5303 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5305 $cust_main->collect(%args);
5308 sub process_bill_and_collect {
5311 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5312 or die "custnum '$param->{custnum}' not found!\n";
5313 $param->{'job'} = $job;
5314 $param->{'fatal'} = 1; # runs from job queue, will be caught
5315 $param->{'retry'} = 1;
5317 $cust_main->bill_and_collect( %$param );
5320 #starting to take quite a while for big dbs
5321 # (JRNL: journaled so it only happens once per database)
5322 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5323 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5324 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5325 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5326 # JRNL leading/trailing spaces in first, last, company
5327 # JRNL migrate to cust_payby
5328 # - otaker upgrade? journal and call it good? (double check to make sure
5329 # we're not still setting otaker here)
5331 #only going to get worse with new location stuff...
5333 sub _upgrade_data { #class method
5334 my ($class, %opts) = @_;
5336 my @statements = ();
5338 #this seems to be the only expensive one.. why does it take so long?
5339 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5341 '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';
5342 FS::upgrade_journal->set_done('cust_main__signupdate');
5346 foreach my $sql ( @statements ) {
5347 my $sth = dbh->prepare($sql) or die dbh->errstr;
5348 $sth->execute or die $sth->errstr;
5349 #warn ( (time - $t). " seconds\n" );
5353 local($ignore_expired_card) = 1;
5354 local($ignore_banned_card) = 1;
5355 local($skip_fuzzyfiles) = 1;
5356 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5358 FS::cust_main::Location->_upgrade_data(%opts);
5360 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5362 foreach my $cust_main ( qsearch({
5363 'table' => 'cust_main',
5365 'extra_sql' => 'WHERE '.
5367 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5368 qw( first last company )
5371 my $error = $cust_main->replace;
5372 die $error if $error;
5375 FS::upgrade_journal->set_done('cust_main__trimspaces');
5379 $class->_upgrade_otaker(%opts);
5381 # turn on encryption as part of regular upgrade, so all new records are immediately encrypted
5382 # existing records will be encrypted in queueable_upgrade (below)
5383 unless ($conf->exists('encryptionpublickey') || $conf->exists('encryptionprivatekey')) {
5384 eval "use FS::Setup";
5386 FS::Setup::enable_encryption();
5391 sub queueable_upgrade {
5394 ### encryption gets turned on in _upgrade_data, above
5396 eval "use FS::upgrade_journal";
5399 # prior to 2013 (commit f16665c9) payinfo was stored in history if not
5400 # encrypted, clear that out before encrypting/tokenizing anything else
5401 if (!FS::upgrade_journal->is_done('clear_payinfo_history')) {
5402 foreach my $table (qw(
5403 cust_payby cust_pay_pending cust_pay cust_pay_void cust_refund
5406 'UPDATE h_'.$table.' SET payinfo = NULL WHERE payinfo IS NOT NULL';
5407 my $sth = dbh->prepare($sql) or die dbh->errstr;
5408 $sth->execute or die $sth->errstr;
5410 FS::upgrade_journal->set_done('clear_payinfo_history');
5413 # fix Tokenized paycardtype and encrypt old records
5414 if ( ! FS::upgrade_journal->is_done('paycardtype_Tokenized')
5415 || ! FS::upgrade_journal->is_done('encryption_check')
5419 # allow replacement of closed cust_pay/cust_refund records
5420 local $FS::payinfo_Mixin::allow_closed_replace = 1;
5422 # because it looks like nothing's changing
5423 local $FS::Record::no_update_diff = 1;
5425 # commit everything immediately
5426 local $FS::UID::AutoCommit = 1;
5428 # encrypt what's there
5429 foreach my $table (qw(
5430 cust_payby cust_pay_pending cust_pay cust_pay_void cust_refund
5432 my $tclass = 'FS::'.$table;
5436 my $recnum = _upgrade_next_recnum(dbh,$table,\$lastrecnum,\@recnums)
5438 my $record = $tclass->by_key($recnum);
5439 next unless $record; # small chance it's been deleted, that's ok
5440 next unless grep { $record->payby eq $_ } @FS::Record::encrypt_payby;
5441 # window for possible conflict is practically nonexistant,
5442 # but just in case...
5443 $record = $record->select_for_update;
5444 if (!$record->custnum && $table eq 'cust_pay_pending') {
5445 $record->set('custnum_pending',1);
5447 $record->paycardtype('') if $record->paycardtype eq 'Tokenized';
5449 local($ignore_expired_card) = 1;
5450 local($ignore_banned_card) = 1;
5451 local($skip_fuzzyfiles) = 1;
5452 local($import) = 1;#prevent automatic geocoding (need its own variable?)
5454 my $error = $record->replace;
5455 die "Error replacing $table ".$record->get($record->primary_key).": $error" if $error;
5459 FS::upgrade_journal->set_done('paycardtype_Tokenized');
5460 FS::upgrade_journal->set_done('encryption_check') if $conf->exists('encryption');
5463 # now that everything's encrypted, tokenize...
5464 FS::cust_main::Billing_Realtime::token_check(@_);
5467 # not entirely false laziness w/ Billing_Realtime::_token_check_next_recnum
5468 # cust_payby might get deleted while this runs
5470 sub _upgrade_next_recnum {
5471 my ($dbh,$table,$lastrecnum,$recnums) = @_;
5472 my $recnum = shift @$recnums;
5473 return $recnum if $recnum;
5474 my $tclass = 'FS::'.$table;
5475 my $paycardtypecheck = ($table ne 'cust_pay_pending') ? q( OR paycardtype = 'Tokenized') : '';
5476 my $sql = 'SELECT '.$tclass->primary_key.
5478 ' WHERE '.$tclass->primary_key.' > '.$$lastrecnum.
5479 " AND payby IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
5480 " AND ( length(payinfo) < 80$paycardtypecheck ) ".
5481 ' ORDER BY '.$tclass->primary_key.' LIMIT 500';
5482 my $sth = $dbh->prepare($sql) or die $dbh->errstr;
5483 $sth->execute() or die $sth->errstr;
5485 while (my $rec = $sth->fetchrow_hashref) {
5486 push @$recnums, $rec->{$tclass->primary_key};
5489 $$lastrecnum = $$recnums[-1];
5490 return shift @$recnums;
5499 The delete method should possibly take an FS::cust_main object reference
5500 instead of a scalar customer number.
5502 Bill and collect options should probably be passed as references instead of a
5505 There should probably be a configuration file with a list of allowed credit
5508 No multiple currency support (probably a larger project than just this module).
5510 Birthdates rely on negative epoch values.
5512 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5516 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5517 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5518 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.