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
23 use Scalar::Util qw( blessed );
24 use Time::Local qw(timelocal);
29 use File::Temp; #qw( tempfile );
30 use Business::CreditCard 0.28;
31 use List::Util qw(min);
32 use FS::UID qw( dbh driver_name );
33 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
35 use FS::Misc qw( generate_ps do_print money_pretty card_types );
36 use FS::Msgcat qw(gettext);
43 use FS::cust_bill_void;
44 use FS::legacy_cust_bill;
46 use FS::cust_pay_pending;
47 use FS::cust_pay_void;
48 use FS::cust_pay_batch;
51 use FS::part_referral;
52 use FS::cust_main_county;
53 use FS::cust_location;
56 use FS::cust_main_exemption;
57 use FS::cust_tax_adjustment;
58 use FS::cust_tax_location;
59 use FS::agent_currency;
60 use FS::cust_main_invoice;
62 use FS::prepay_credit;
68 use FS::payment_gateway;
69 use FS::agent_payment_gateway;
71 use FS::cust_main_note;
72 use FS::cust_attachment;
75 use FS::upgrade_journal;
80 # 1 is mostly method/subroutine entry and options
81 # 2 traces progress of some operations
82 # 3 is even more information including possibly sensitive data
84 our $me = '[FS::cust_main]';
87 our $ignore_expired_card = 0;
88 our $ignore_banned_card = 0;
89 our $ignore_invalid_card = 0;
91 our $skip_fuzzyfiles = 0;
93 our $ucfirst_nowarn = 0;
95 #this info is in cust_payby as of 4.x
96 #this and the fields themselves can be removed in 5.x
97 our @encrypted_fields = ('payinfo', 'paycvv');
98 sub nohistory_fields { ('payinfo', 'paycvv'); }
101 our $default_agent_custid;
102 our $custnum_display_length;
103 #ask FS::UID to run this stuff for us later
104 #$FS::UID::callback{'FS::cust_main'} = sub {
105 install_callback FS::UID sub {
106 $conf = new FS::Conf;
107 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
108 $default_agent_custid = $conf->exists('cust_main-default_agent_custid');
109 $custnum_display_length = $conf->config('cust_main-custnum-display_length');
114 my ( $hashref, $cache ) = @_;
115 if ( exists $hashref->{'pkgnum'} ) {
116 #@{ $self->{'_pkgnum'} } = ();
117 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
118 $self->{'_pkgnum'} = $subcache;
119 #push @{ $self->{'_pkgnum'} },
120 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
126 FS::cust_main - Object methods for cust_main records
132 $record = new FS::cust_main \%hash;
133 $record = new FS::cust_main { 'column' => 'value' };
135 $error = $record->insert;
137 $error = $new_record->replace($old_record);
139 $error = $record->delete;
141 $error = $record->check;
143 @cust_pkg = $record->all_pkgs;
145 @cust_pkg = $record->ncancelled_pkgs;
147 @cust_pkg = $record->suspended_pkgs;
149 $error = $record->bill;
150 $error = $record->bill %options;
151 $error = $record->bill 'time' => $time;
153 $error = $record->collect;
154 $error = $record->collect %options;
155 $error = $record->collect 'invoice_time' => $time,
160 An FS::cust_main object represents a customer. FS::cust_main inherits from
161 FS::Record. The following fields are currently supported:
167 Primary key (assigned automatically for new customers)
171 Agent (see L<FS::agent>)
175 Advertising source (see L<FS::part_referral>)
187 Cocial security number (optional)
211 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
215 Payment Information (See L<FS::payinfo_Mixin> for data format)
219 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
223 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
227 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
231 Start date month (maestro/solo cards only)
235 Start date year (maestro/solo cards only)
239 Issue number (maestro/solo cards only)
243 Name on card or billing name
247 IP address from which payment information was received
251 Tax exempt, empty or `Y'
255 Order taker (see L<FS::access_user>)
261 =item referral_custnum
263 Referring customer number
267 Enable individual CDR spooling, empty or `Y'
271 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
275 Discourage individual CDR printing, empty or `Y'
279 Allow self-service editing of ticket subjects, empty or 'Y'
281 =item calling_list_exempt
283 Do not call, empty or 'Y'
285 =item invoice_ship_address
287 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
297 Creates a new customer. To add the customer to the database, see L<"insert">.
299 Note that this stores the hash reference, not a distinct copy of the hash it
300 points to. You can ask the object for a copy with the I<hash> method.
304 sub table { 'cust_main'; }
306 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
308 Adds this customer to the database. If there is an error, returns the error,
309 otherwise returns false.
311 Usually the customer's location will not yet exist in the database, and
312 the C<bill_location> and C<ship_location> pseudo-fields must be set to
313 uninserted L<FS::cust_location> objects. These will be inserted and linked
314 (in both directions) to the new customer record. If they're references
315 to the same object, they will become the same location.
317 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
318 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
319 are inserted atomicly, or the transaction is rolled back. Passing an empty
320 hash reference is equivalent to not supplying this parameter. There should be
321 a better explanation of this, but until then, here's an example:
324 tie %hash, 'Tie::RefHash'; #this part is important
326 $cust_pkg => [ $svc_acct ],
329 $cust_main->insert( \%hash );
331 INVOICING_LIST_ARYREF: No longer supported.
333 Currently available options are: I<depend_jobnum>, I<noexport>,
334 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
336 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
337 on the supplied jobnum (they will not run until the specific job completes).
338 This can be used to defer provisioning until some action completes (such
339 as running the customer's credit card successfully).
341 The I<noexport> option is deprecated. If I<noexport> is set true, no
342 provisioning jobs (exports) are scheduled. (You can schedule them later with
343 the B<reexport> method.)
345 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
346 of tax names and exemption numbers. FS::cust_main_exemption records will be
347 created and inserted.
349 If I<prospectnum> is set, moves contacts and locations from that prospect.
351 If I<contact> is set to an arrayref of FS::contact objects, those will be
354 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
355 unset), inserts those new contacts with this new customer. Handles CGI
356 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
358 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
359 new stored payment records with this new customer. Handles CGI parameters
360 for an "m2" multiple entry field as passed by edit/cust_main.cgi
366 my $cust_pkgs = @_ ? shift : {};
368 if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
369 warn "cust_main::insert using deprecated invoicing list argument";
370 $invoicing_list = shift;
373 warn "$me insert called with options ".
374 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
377 local $SIG{HUP} = 'IGNORE';
378 local $SIG{INT} = 'IGNORE';
379 local $SIG{QUIT} = 'IGNORE';
380 local $SIG{TERM} = 'IGNORE';
381 local $SIG{TSTP} = 'IGNORE';
382 local $SIG{PIPE} = 'IGNORE';
384 my $oldAutoCommit = $FS::UID::AutoCommit;
385 local $FS::UID::AutoCommit = 0;
388 my $prepay_identifier = '';
389 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
391 if ( $self->payby eq 'PREPAY' ) {
393 $self->payby(''); #'BILL');
394 $prepay_identifier = $self->payinfo;
397 warn " looking up prepaid card $prepay_identifier\n"
400 my $error = $self->get_prepay( $prepay_identifier,
401 'amount_ref' => \$amount,
402 'seconds_ref' => \$seconds,
403 'upbytes_ref' => \$upbytes,
404 'downbytes_ref' => \$downbytes,
405 'totalbytes_ref' => \$totalbytes,
408 $dbh->rollback if $oldAutoCommit;
409 #return "error applying prepaid card (transaction rolled back): $error";
413 $payby = 'PREP' if $amount;
415 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
418 $self->payby(''); #'BILL');
419 $amount = $self->paid;
424 foreach my $l (qw(bill_location ship_location)) {
426 my $loc = delete $self->hashref->{$l} or next;
428 if ( !$loc->locationnum ) {
429 # warn the location that we're going to insert it with no custnum
430 $loc->set(custnum_pending => 1);
431 warn " inserting $l\n"
433 my $error = $loc->insert;
435 $dbh->rollback if $oldAutoCommit;
436 my $label = $l eq 'ship_location' ? 'service' : 'billing';
437 return "$error (in $label location)";
440 } elsif ( $loc->prospectnum ) {
442 $loc->prospectnum('');
443 $loc->set(custnum_pending => 1);
444 my $error = $loc->replace;
446 $dbh->rollback if $oldAutoCommit;
447 my $label = $l eq 'ship_location' ? 'service' : 'billing';
448 return "$error (moving $label location)";
451 } elsif ( ($loc->custnum || 0) > 0 ) {
452 # then it somehow belongs to another customer--shouldn't happen
453 $dbh->rollback if $oldAutoCommit;
454 return "$l belongs to customer ".$loc->custnum;
456 # else it already belongs to this customer
457 # (happens when ship_location is identical to bill_location)
459 $self->set($l.'num', $loc->locationnum);
461 if ( $self->get($l.'num') eq '' ) {
462 $dbh->rollback if $oldAutoCommit;
467 warn " inserting $self\n"
470 $self->signupdate(time) unless $self->signupdate;
472 $self->auto_agent_custid()
473 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
475 my $error = $self->check_payinfo_cardtype
476 || $self->SUPER::insert;
478 $dbh->rollback if $oldAutoCommit;
479 #return "inserting cust_main record (transaction rolled back): $error";
483 # now set cust_location.custnum
484 foreach my $l (qw(bill_location ship_location)) {
485 warn " setting $l.custnum\n"
487 my $loc = $self->$l or next;
488 unless ( $loc->custnum ) {
489 $loc->set(custnum => $self->custnum);
490 $error ||= $loc->replace;
494 $dbh->rollback if $oldAutoCommit;
495 return "error setting $l custnum: $error";
499 warn " setting customer tags\n"
502 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
503 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
504 'custnum' => $self->custnum };
505 my $error = $cust_tag->insert;
507 $dbh->rollback if $oldAutoCommit;
512 my $prospectnum = delete $options{'prospectnum'};
513 if ( $prospectnum ) {
515 warn " moving contacts and locations from prospect $prospectnum\n"
519 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
520 unless ( $prospect_main ) {
521 $dbh->rollback if $oldAutoCommit;
522 return "Unknown prospectnum $prospectnum";
524 $prospect_main->custnum($self->custnum);
525 $prospect_main->disabled('Y');
526 my $error = $prospect_main->replace;
528 $dbh->rollback if $oldAutoCommit;
532 foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
533 my $cust_contact = new FS::cust_contact {
534 'custnum' => $self->custnum,
535 'invoice_dest' => 'Y', # invoice_dest currently not set for prospect contacts
536 map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
538 my $error = $cust_contact->insert
539 || $prospect_contact->delete;
541 $dbh->rollback if $oldAutoCommit;
546 my @cust_location = $prospect_main->cust_location;
547 my @qual = $prospect_main->qual;
549 foreach my $r ( @cust_location, @qual ) {
551 $r->custnum($self->custnum);
552 my $error = $r->replace;
554 $dbh->rollback if $oldAutoCommit;
558 # since we set invoice_dest on all migrated prospect contacts (for now),
559 # don't process invoicing_list.
560 delete $options{'invoicing_list'};
561 $invoicing_list = undef;
564 warn " setting contacts\n"
567 $invoicing_list ||= $options{'invoicing_list'};
568 if ( $invoicing_list ) {
570 $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
573 foreach my $dest (@$invoicing_list ) {
574 if ($dest eq 'POST') {
575 $self->set('postal_invoice', 'Y');
578 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
579 if ( $contact_email ) {
580 my $cust_contact = FS::cust_contact->new({
581 contactnum => $contact_email->contactnum,
582 custnum => $self->custnum,
584 $cust_contact->set('invoice_dest', 'Y');
585 my $error = $cust_contact->insert;
587 $dbh->rollback if $oldAutoCommit;
588 return "$error (linking to email address $dest)";
592 # this email address is not yet linked to any contact
593 $email .= ',' if length($email);
599 my $contact = FS::contact->new({
600 'custnum' => $self->get('custnum'),
601 'last' => $self->get('last'),
602 'first' => $self->get('first'),
603 'emailaddress' => $email,
604 'invoice_dest' => 'Y', # yes, you can set this via the contact
606 my $error = $contact->insert;
608 $dbh->rollback if $oldAutoCommit;
614 if ( my $contact = delete $options{'contact'} ) {
616 foreach my $c ( @$contact ) {
617 $c->custnum($self->custnum);
618 my $error = $c->insert;
620 $dbh->rollback if $oldAutoCommit;
626 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
628 my $error = $self->process_o2m( 'table' => 'contact',
629 'fields' => FS::contact->cgi_contact_fields,
630 'params' => $contact_params,
633 $dbh->rollback if $oldAutoCommit;
638 warn " setting cust_payby\n"
641 if ( $options{cust_payby} ) {
643 foreach my $cust_payby ( @{ $options{cust_payby} } ) {
644 $cust_payby->custnum($self->custnum);
645 my $error = $cust_payby->insert;
647 $dbh->rollback if $oldAutoCommit;
652 } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
654 my $error = $self->process_o2m(
655 'table' => 'cust_payby',
656 'fields' => FS::cust_payby->cgi_cust_payby_fields,
657 'params' => $cust_payby_params,
658 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
661 $dbh->rollback if $oldAutoCommit;
667 warn " setting cust_main_exemption\n"
670 my $tax_exemption = delete $options{'tax_exemption'};
671 if ( $tax_exemption ) {
673 $tax_exemption = { map { $_ => '' } @$tax_exemption }
674 if ref($tax_exemption) eq 'ARRAY';
676 foreach my $taxname ( keys %$tax_exemption ) {
677 my $cust_main_exemption = new FS::cust_main_exemption {
678 'custnum' => $self->custnum,
679 'taxname' => $taxname,
680 'exempt_number' => $tax_exemption->{$taxname},
682 my $error = $cust_main_exemption->insert;
684 $dbh->rollback if $oldAutoCommit;
685 return "inserting cust_main_exemption (transaction rolled back): $error";
690 warn " ordering packages\n"
693 $error = $self->order_pkgs( $cust_pkgs,
695 'seconds_ref' => \$seconds,
696 'upbytes_ref' => \$upbytes,
697 'downbytes_ref' => \$downbytes,
698 'totalbytes_ref' => \$totalbytes,
701 $dbh->rollback if $oldAutoCommit;
706 $dbh->rollback if $oldAutoCommit;
707 return "No svc_acct record to apply pre-paid time";
709 if ( $upbytes || $downbytes || $totalbytes ) {
710 $dbh->rollback if $oldAutoCommit;
711 return "No svc_acct record to apply pre-paid data";
715 warn " inserting initial $payby payment of $amount\n"
717 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
719 $dbh->rollback if $oldAutoCommit;
720 return "inserting payment (transaction rolled back): $error";
724 unless ( $import || $skip_fuzzyfiles ) {
725 warn " queueing fuzzyfiles update\n"
727 $error = $self->queue_fuzzyfiles_update;
729 $dbh->rollback if $oldAutoCommit;
730 return "updating fuzzy search cache: $error";
734 # FS::geocode_Mixin::after_insert or something?
735 if ( $conf->config('tax_district_method') and !$import ) {
736 # if anything non-empty, try to look it up
737 my $queue = new FS::queue {
738 'job' => 'FS::geocode_Mixin::process_district_update',
739 'custnum' => $self->custnum,
741 my $error = $queue->insert( ref($self), $self->custnum );
743 $dbh->rollback if $oldAutoCommit;
744 return "queueing tax district update: $error";
749 warn " exporting\n" if $DEBUG > 1;
751 my $export_args = $options{'export_args'} || [];
754 map qsearch( 'part_export', {exportnum=>$_} ),
755 $conf->config('cust_main-exports'); #, $agentnum
757 foreach my $part_export ( @part_export ) {
758 my $error = $part_export->export_insert($self, @$export_args);
760 $dbh->rollback if $oldAutoCommit;
761 return "exporting to ". $part_export->exporttype.
762 " (transaction rolled back): $error";
766 #foreach my $depend_jobnum ( @$depend_jobnums ) {
767 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
769 # foreach my $jobnum ( @jobnums ) {
770 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
771 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
773 # my $error = $queue->depend_insert($depend_jobnum);
775 # $dbh->rollback if $oldAutoCommit;
776 # return "error queuing job dependancy: $error";
783 #if ( exists $options{'jobnums'} ) {
784 # push @{ $options{'jobnums'} }, @jobnums;
787 warn " insert complete; committing transaction\n"
790 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
795 use File::CounterFile;
796 sub auto_agent_custid {
799 my $format = $conf->config('cust_main-auto_agent_custid');
801 if ( $format eq '1YMMXXXXXXXX' ) {
803 my $counter = new File::CounterFile 'cust_main.agent_custid';
806 my $ym = 100000000000 + time2str('%y%m00000000', time);
807 if ( $ym > $counter->value ) {
808 $counter->{'value'} = $agent_custid = $ym;
809 $counter->{'updated'} = 1;
811 $agent_custid = $counter->inc;
817 die "Unknown cust_main-auto_agent_custid format: $format";
820 $self->agent_custid($agent_custid);
824 =item PACKAGE METHODS
826 Documentation on customer package methods has been moved to
827 L<FS::cust_main::Packages>.
829 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
831 Recharges this (existing) customer with the specified prepaid card (see
832 L<FS::prepay_credit>), specified either by I<identifier> or as an
833 FS::prepay_credit object. If there is an error, returns the error, otherwise
836 Optionally, five scalar references can be passed as well. They will have their
837 values filled in with the amount, number of seconds, and number of upload,
838 download, and total bytes applied by this prepaid card.
842 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
843 #the only place that uses these args
844 sub recharge_prepay {
845 my( $self, $prepay_credit, $amountref, $secondsref,
846 $upbytesref, $downbytesref, $totalbytesref ) = @_;
848 local $SIG{HUP} = 'IGNORE';
849 local $SIG{INT} = 'IGNORE';
850 local $SIG{QUIT} = 'IGNORE';
851 local $SIG{TERM} = 'IGNORE';
852 local $SIG{TSTP} = 'IGNORE';
853 local $SIG{PIPE} = 'IGNORE';
855 my $oldAutoCommit = $FS::UID::AutoCommit;
856 local $FS::UID::AutoCommit = 0;
859 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
861 my $error = $self->get_prepay( $prepay_credit,
862 'amount_ref' => \$amount,
863 'seconds_ref' => \$seconds,
864 'upbytes_ref' => \$upbytes,
865 'downbytes_ref' => \$downbytes,
866 'totalbytes_ref' => \$totalbytes,
868 || $self->increment_seconds($seconds)
869 || $self->increment_upbytes($upbytes)
870 || $self->increment_downbytes($downbytes)
871 || $self->increment_totalbytes($totalbytes)
872 || $self->insert_cust_pay_prepay( $amount,
874 ? $prepay_credit->identifier
879 $dbh->rollback if $oldAutoCommit;
883 if ( defined($amountref) ) { $$amountref = $amount; }
884 if ( defined($secondsref) ) { $$secondsref = $seconds; }
885 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
886 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
887 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
889 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
894 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
896 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
897 specified either by I<identifier> or as an FS::prepay_credit object.
899 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
900 incremented by the values of the prepaid card.
902 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
903 check or set this customer's I<agentnum>.
905 If there is an error, returns the error, otherwise returns false.
911 my( $self, $prepay_credit, %opt ) = @_;
913 local $SIG{HUP} = 'IGNORE';
914 local $SIG{INT} = 'IGNORE';
915 local $SIG{QUIT} = 'IGNORE';
916 local $SIG{TERM} = 'IGNORE';
917 local $SIG{TSTP} = 'IGNORE';
918 local $SIG{PIPE} = 'IGNORE';
920 my $oldAutoCommit = $FS::UID::AutoCommit;
921 local $FS::UID::AutoCommit = 0;
924 unless ( ref($prepay_credit) ) {
926 my $identifier = $prepay_credit;
928 $prepay_credit = qsearchs(
930 { 'identifier' => $identifier },
935 unless ( $prepay_credit ) {
936 $dbh->rollback if $oldAutoCommit;
937 return "Invalid prepaid card: ". $identifier;
942 if ( $prepay_credit->agentnum ) {
943 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
944 $dbh->rollback if $oldAutoCommit;
945 return "prepaid card not valid for agent ". $self->agentnum;
947 $self->agentnum($prepay_credit->agentnum);
950 my $error = $prepay_credit->delete;
952 $dbh->rollback if $oldAutoCommit;
953 return "removing prepay_credit (transaction rolled back): $error";
956 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
957 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
959 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
964 =item increment_upbytes SECONDS
966 Updates this customer's single or primary account (see L<FS::svc_acct>) by
967 the specified number of upbytes. If there is an error, returns the error,
968 otherwise returns false.
972 sub increment_upbytes {
973 _increment_column( shift, 'upbytes', @_);
976 =item increment_downbytes SECONDS
978 Updates this customer's single or primary account (see L<FS::svc_acct>) by
979 the specified number of downbytes. If there is an error, returns the error,
980 otherwise returns false.
984 sub increment_downbytes {
985 _increment_column( shift, 'downbytes', @_);
988 =item increment_totalbytes SECONDS
990 Updates this customer's single or primary account (see L<FS::svc_acct>) by
991 the specified number of totalbytes. If there is an error, returns the error,
992 otherwise returns false.
996 sub increment_totalbytes {
997 _increment_column( shift, 'totalbytes', @_);
1000 =item increment_seconds SECONDS
1002 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1003 the specified number of seconds. If there is an error, returns the error,
1004 otherwise returns false.
1008 sub increment_seconds {
1009 _increment_column( shift, 'seconds', @_);
1012 =item _increment_column AMOUNT
1014 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1015 the specified number of seconds or bytes. If there is an error, returns
1016 the error, otherwise returns false.
1020 sub _increment_column {
1021 my( $self, $column, $amount ) = @_;
1022 warn "$me increment_column called: $column, $amount\n"
1025 return '' unless $amount;
1027 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1028 $self->ncancelled_pkgs;
1030 if ( ! @cust_pkg ) {
1031 return 'No packages with primary or single services found'.
1032 ' to apply pre-paid time';
1033 } elsif ( scalar(@cust_pkg) > 1 ) {
1034 #maybe have a way to specify the package/account?
1035 return 'Multiple packages found to apply pre-paid time';
1038 my $cust_pkg = $cust_pkg[0];
1039 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1043 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1045 if ( ! @cust_svc ) {
1046 return 'No account found to apply pre-paid time';
1047 } elsif ( scalar(@cust_svc) > 1 ) {
1048 return 'Multiple accounts found to apply pre-paid time';
1051 my $svc_acct = $cust_svc[0]->svc_x;
1052 warn " found service svcnum ". $svc_acct->pkgnum.
1053 ' ('. $svc_acct->email. ")\n"
1056 $column = "increment_$column";
1057 $svc_acct->$column($amount);
1061 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1063 Inserts a prepayment in the specified amount for this customer. An optional
1064 second argument can specify the prepayment identifier for tracking purposes.
1065 If there is an error, returns the error, otherwise returns false.
1069 sub insert_cust_pay_prepay {
1070 shift->insert_cust_pay('PREP', @_);
1073 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1075 Inserts a cash payment in the specified amount for this customer. An optional
1076 second argument can specify the payment identifier for tracking purposes.
1077 If there is an error, returns the error, otherwise returns false.
1081 sub insert_cust_pay_cash {
1082 shift->insert_cust_pay('CASH', @_);
1085 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1087 Inserts a Western Union payment in the specified amount for this customer. An
1088 optional second argument can specify the prepayment identifier for tracking
1089 purposes. If there is an error, returns the error, otherwise returns false.
1093 sub insert_cust_pay_west {
1094 shift->insert_cust_pay('WEST', @_);
1097 sub insert_cust_pay {
1098 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1099 my $payinfo = scalar(@_) ? shift : '';
1101 my $cust_pay = new FS::cust_pay {
1102 'custnum' => $self->custnum,
1103 'paid' => sprintf('%.2f', $amount),
1104 #'_date' => #date the prepaid card was purchased???
1106 'payinfo' => $payinfo,
1112 =item delete [ OPTION => VALUE ... ]
1114 This deletes the customer. If there is an error, returns the error, otherwise
1117 This will completely remove all traces of the customer record. This is not
1118 what you want when a customer cancels service; for that, cancel all of the
1119 customer's packages (see L</cancel>).
1121 If the customer has any uncancelled packages, you need to pass a new (valid)
1122 customer number for those packages to be transferred to, as the "new_customer"
1123 option. Cancelled packages will be deleted. Did I mention that this is NOT
1124 what you want when a customer cancels service and that you really should be
1125 looking at L<FS::cust_pkg/cancel>?
1127 You can't delete a customer with invoices (see L<FS::cust_bill>),
1128 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1129 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1130 set the "delete_financials" option to a true value.
1135 my( $self, %opt ) = @_;
1137 local $SIG{HUP} = 'IGNORE';
1138 local $SIG{INT} = 'IGNORE';
1139 local $SIG{QUIT} = 'IGNORE';
1140 local $SIG{TERM} = 'IGNORE';
1141 local $SIG{TSTP} = 'IGNORE';
1142 local $SIG{PIPE} = 'IGNORE';
1144 my $oldAutoCommit = $FS::UID::AutoCommit;
1145 local $FS::UID::AutoCommit = 0;
1148 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1149 $dbh->rollback if $oldAutoCommit;
1150 return "Can't delete a master agent customer";
1153 #use FS::access_user
1154 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1155 $dbh->rollback if $oldAutoCommit;
1156 return "Can't delete a master employee customer";
1159 tie my %financial_tables, 'Tie::IxHash',
1160 'cust_bill' => 'invoices',
1161 'cust_statement' => 'statements',
1162 'cust_credit' => 'credits',
1163 'cust_pay' => 'payments',
1164 'cust_refund' => 'refunds',
1167 foreach my $table ( keys %financial_tables ) {
1169 my @records = $self->$table();
1171 if ( @records && ! $opt{'delete_financials'} ) {
1172 $dbh->rollback if $oldAutoCommit;
1173 return "Can't delete a customer with ". $financial_tables{$table};
1176 foreach my $record ( @records ) {
1177 my $error = $record->delete;
1179 $dbh->rollback if $oldAutoCommit;
1180 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1186 my @cust_pkg = $self->ncancelled_pkgs;
1188 my $new_custnum = $opt{'new_custnum'};
1189 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1190 $dbh->rollback if $oldAutoCommit;
1191 return "Invalid new customer number: $new_custnum";
1193 foreach my $cust_pkg ( @cust_pkg ) {
1194 my %hash = $cust_pkg->hash;
1195 $hash{'custnum'} = $new_custnum;
1196 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1197 my $error = $new_cust_pkg->replace($cust_pkg,
1198 options => { $cust_pkg->options },
1201 $dbh->rollback if $oldAutoCommit;
1206 my @cancelled_cust_pkg = $self->all_pkgs;
1207 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1208 my $error = $cust_pkg->delete;
1210 $dbh->rollback if $oldAutoCommit;
1215 #cust_tax_adjustment in financials?
1216 #cust_pay_pending? ouch
1217 foreach my $table (qw(
1218 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1219 cust_payby cust_location cust_main_note cust_tax_adjustment
1220 cust_pay_void cust_pay_batch queue cust_tax_exempt
1222 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1223 my $error = $record->delete;
1225 $dbh->rollback if $oldAutoCommit;
1231 my $sth = $dbh->prepare(
1232 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1234 my $errstr = $dbh->errstr;
1235 $dbh->rollback if $oldAutoCommit;
1238 $sth->execute($self->custnum) or do {
1239 my $errstr = $sth->errstr;
1240 $dbh->rollback if $oldAutoCommit;
1246 my $ticket_dbh = '';
1247 if ($conf->config('ticket_system') eq 'RT_Internal') {
1249 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1250 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1251 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1252 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1255 if ( $ticket_dbh ) {
1257 my $ticket_sth = $ticket_dbh->prepare(
1258 'DELETE FROM Links WHERE Target = ?'
1260 my $errstr = $ticket_dbh->errstr;
1261 $dbh->rollback if $oldAutoCommit;
1264 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1266 my $errstr = $ticket_sth->errstr;
1267 $dbh->rollback if $oldAutoCommit;
1271 #check and see if the customer is the only link on the ticket, and
1272 #if so, set the ticket to deleted status in RT?
1273 #maybe someday, for now this will at least fix tickets not displaying
1277 #delete the customer record
1279 my $error = $self->SUPER::delete;
1281 $dbh->rollback if $oldAutoCommit;
1285 # cust_main exports!
1287 #my $export_args = $options{'export_args'} || [];
1290 map qsearch( 'part_export', {exportnum=>$_} ),
1291 $conf->config('cust_main-exports'); #, $agentnum
1293 foreach my $part_export ( @part_export ) {
1294 my $error = $part_export->export_delete( $self ); #, @$export_args);
1296 $dbh->rollback if $oldAutoCommit;
1297 return "exporting to ". $part_export->exporttype.
1298 " (transaction rolled back): $error";
1302 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1307 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1309 Replaces the OLD_RECORD with this one in the database. If there is an error,
1310 returns the error, otherwise returns false.
1312 To change the customer's address, set the pseudo-fields C<bill_location> and
1313 C<ship_location>. The address will still only change if at least one of the
1314 address fields differs from the existing values.
1316 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1317 set as the contact email address for a default contact with the same name as
1320 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1321 I<contact_params>, I<invoicing_list>.
1323 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1324 of tax names and exemption numbers. FS::cust_main_exemption records will be
1325 deleted and inserted as appropriate.
1327 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1328 groups (describing the customer's payment methods and contacts, respectively)
1329 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1330 and L<FS::contact> for the fields these can contain.
1332 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1333 should be used instead if possible.
1340 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1342 : $self->replace_old;
1346 warn "$me replace called\n"
1349 my $curuser = $FS::CurrentUser::CurrentUser;
1350 return "You are not permitted to create complimentary accounts."
1351 if $self->complimentary eq 'Y'
1352 && $self->complimentary ne $old->complimentary
1353 && ! $curuser->access_right('Complimentary customer');
1355 local($ignore_expired_card) = 1
1356 if $old->payby =~ /^(CARD|DCRD)$/
1357 && $self->payby =~ /^(CARD|DCRD)$/
1358 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1360 local($ignore_banned_card) = 1
1361 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1362 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1363 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1365 if ( $self->payby =~ /^(CARD|DCRD)$/
1366 && $old->payinfo ne $self->payinfo
1367 && $old->paymask ne $self->paymask )
1369 my $error = $self->check_payinfo_cardtype;
1370 return $error if $error;
1373 return "Invoicing locale is required"
1376 && $conf->exists('cust_main-require_locale');
1378 local $SIG{HUP} = 'IGNORE';
1379 local $SIG{INT} = 'IGNORE';
1380 local $SIG{QUIT} = 'IGNORE';
1381 local $SIG{TERM} = 'IGNORE';
1382 local $SIG{TSTP} = 'IGNORE';
1383 local $SIG{PIPE} = 'IGNORE';
1385 my $oldAutoCommit = $FS::UID::AutoCommit;
1386 local $FS::UID::AutoCommit = 0;
1389 for my $l (qw(bill_location ship_location)) {
1390 #my $old_loc = $old->$l;
1391 my $new_loc = $self->$l or next;
1393 # find the existing location if there is one
1394 $new_loc->set('custnum' => $self->custnum);
1395 my $error = $new_loc->find_or_insert;
1397 $dbh->rollback if $oldAutoCommit;
1400 $self->set($l.'num', $new_loc->locationnum);
1404 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1405 warn "cust_main::replace: using deprecated invoicing list argument";
1406 $invoicing_list = shift @param;
1409 my %options = @param;
1411 $invoicing_list ||= $options{invoicing_list};
1413 my @contacts = map { $_->contact } $self->cust_contact;
1414 # find a contact that matches the customer's name
1415 my ($implicit_contact) = grep { $_->first eq $old->get('first')
1416 and $_->last eq $old->get('last') }
1418 $implicit_contact ||= FS::contact->new({
1419 'custnum' => $self->custnum,
1420 'locationnum' => $self->get('bill_locationnum'),
1423 # for any of these that are already contact emails, link to the existing
1425 if ( $invoicing_list ) {
1428 # kind of like process_m2m on these, except:
1429 # - the other side is two tables in a join
1430 # - and we might have to create new contact_emails
1431 # - and possibly a new contact
1433 # Find existing invoice emails that aren't on the implicit contact.
1434 # Any of these that are not on the new invoicing list will be removed.
1435 my %old_email_cust_contact;
1436 foreach my $cust_contact ($self->cust_contact) {
1437 next if !$cust_contact->invoice_dest;
1438 next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1440 foreach my $contact_email ($cust_contact->contact->contact_email) {
1441 $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1445 foreach my $dest (@$invoicing_list) {
1447 if ($dest eq 'POST') {
1449 $self->set('postal_invoice', 'Y');
1451 } elsif ( exists($old_email_cust_contact{$dest}) ) {
1453 delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1457 # See if it belongs to some other contact; if so, link it.
1458 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1460 and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1461 my $cust_contact = qsearchs('cust_contact', {
1462 contactnum => $contact_email->contactnum,
1463 custnum => $self->custnum,
1464 }) || FS::cust_contact->new({
1465 contactnum => $contact_email->contactnum,
1466 custnum => $self->custnum,
1468 $cust_contact->set('invoice_dest', 'Y');
1469 my $error = $cust_contact->custcontactnum ?
1470 $cust_contact->replace : $cust_contact->insert;
1472 $dbh->rollback if $oldAutoCommit;
1473 return "$error (linking to email address $dest)";
1477 # This email address is not yet linked to any contact, so it will
1478 # be added to the implicit contact.
1479 $email .= ',' if length($email);
1485 foreach my $remove_dest (keys %old_email_cust_contact) {
1486 my $cust_contact = $old_email_cust_contact{$remove_dest};
1487 # These were not in the list of requested destinations, so take them off.
1488 $cust_contact->set('invoice_dest', '');
1489 my $error = $cust_contact->replace;
1491 $dbh->rollback if $oldAutoCommit;
1492 return "$error (unlinking email address $remove_dest)";
1496 # make sure it keeps up with the changed customer name, if any
1497 $implicit_contact->set('last', $self->get('last'));
1498 $implicit_contact->set('first', $self->get('first'));
1499 $implicit_contact->set('emailaddress', $email);
1500 $implicit_contact->set('invoice_dest', 'Y');
1501 $implicit_contact->set('custnum', $self->custnum);
1504 if ( $implicit_contact->contactnum ) {
1505 $error = $implicit_contact->replace;
1506 } elsif ( length($email) ) { # don't create a new contact if not needed
1507 $error = $implicit_contact->insert;
1511 $dbh->rollback if $oldAutoCommit;
1512 return "$error (adding email address $email)";
1517 # replace the customer record
1518 my $error = $self->SUPER::replace($old);
1521 $dbh->rollback if $oldAutoCommit;
1525 # now move packages to the new service location
1526 $self->set('ship_location', ''); #flush cache
1527 if ( $old->ship_locationnum and # should only be null during upgrade...
1528 $old->ship_locationnum != $self->ship_locationnum ) {
1529 $error = $old->ship_location->move_to($self->ship_location);
1531 $dbh->rollback if $oldAutoCommit;
1535 # don't move packages based on the billing location, but
1536 # disable it if it's no longer in use
1537 if ( $old->bill_locationnum and
1538 $old->bill_locationnum != $self->bill_locationnum ) {
1539 $error = $old->bill_location->disable_if_unused;
1541 $dbh->rollback if $oldAutoCommit;
1546 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1548 #this could be more efficient than deleting and re-inserting, if it matters
1549 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1550 my $error = $cust_tag->delete;
1552 $dbh->rollback if $oldAutoCommit;
1556 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1557 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1558 'custnum' => $self->custnum };
1559 my $error = $cust_tag->insert;
1561 $dbh->rollback if $oldAutoCommit;
1568 my $tax_exemption = delete $options{'tax_exemption'};
1569 if ( $tax_exemption ) {
1571 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1572 if ref($tax_exemption) eq 'ARRAY';
1574 my %cust_main_exemption =
1575 map { $_->taxname => $_ }
1576 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1578 foreach my $taxname ( keys %$tax_exemption ) {
1580 if ( $cust_main_exemption{$taxname} &&
1581 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1584 delete $cust_main_exemption{$taxname};
1588 my $cust_main_exemption = new FS::cust_main_exemption {
1589 'custnum' => $self->custnum,
1590 'taxname' => $taxname,
1591 'exempt_number' => $tax_exemption->{$taxname},
1593 my $error = $cust_main_exemption->insert;
1595 $dbh->rollback if $oldAutoCommit;
1596 return "inserting cust_main_exemption (transaction rolled back): $error";
1600 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1601 my $error = $cust_main_exemption->delete;
1603 $dbh->rollback if $oldAutoCommit;
1604 return "deleting cust_main_exemption (transaction rolled back): $error";
1610 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1612 my $error = $self->process_o2m(
1613 'table' => 'cust_payby',
1614 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1615 'params' => $cust_payby_params,
1616 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1619 $dbh->rollback if $oldAutoCommit;
1625 if ( my $contact_params = delete $options{'contact_params'} ) {
1627 # this can potentially replace contacts that were created by the
1628 # invoicing list argument, but the UI shouldn't allow both of them
1631 my $error = $self->process_o2m(
1632 'table' => 'contact',
1633 'fields' => FS::contact->cgi_contact_fields,
1634 'params' => $contact_params,
1637 $dbh->rollback if $oldAutoCommit;
1643 unless ( $import || $skip_fuzzyfiles ) {
1644 $error = $self->queue_fuzzyfiles_update;
1646 $dbh->rollback if $oldAutoCommit;
1647 return "updating fuzzy search cache: $error";
1651 # tax district update in cust_location
1653 # cust_main exports!
1655 my $export_args = $options{'export_args'} || [];
1658 map qsearch( 'part_export', {exportnum=>$_} ),
1659 $conf->config('cust_main-exports'); #, $agentnum
1661 foreach my $part_export ( @part_export ) {
1662 my $error = $part_export->export_replace( $self, $old, @$export_args);
1664 $dbh->rollback if $oldAutoCommit;
1665 return "exporting to ". $part_export->exporttype.
1666 " (transaction rolled back): $error";
1670 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1675 =item queue_fuzzyfiles_update
1677 Used by insert & replace to update the fuzzy search cache
1681 use FS::cust_main::Search;
1682 sub queue_fuzzyfiles_update {
1685 local $SIG{HUP} = 'IGNORE';
1686 local $SIG{INT} = 'IGNORE';
1687 local $SIG{QUIT} = 'IGNORE';
1688 local $SIG{TERM} = 'IGNORE';
1689 local $SIG{TSTP} = 'IGNORE';
1690 local $SIG{PIPE} = 'IGNORE';
1692 my $oldAutoCommit = $FS::UID::AutoCommit;
1693 local $FS::UID::AutoCommit = 0;
1696 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1697 my $queue = new FS::queue {
1698 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1700 my @args = "cust_main.$field", $self->get($field);
1701 my $error = $queue->insert( @args );
1703 $dbh->rollback if $oldAutoCommit;
1704 return "queueing job (transaction rolled back): $error";
1709 push @locations, $self->bill_location if $self->bill_locationnum;
1710 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1711 foreach my $location (@locations) {
1712 my $queue = new FS::queue {
1713 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1715 my @args = 'cust_location.address1', $location->address1;
1716 my $error = $queue->insert( @args );
1718 $dbh->rollback if $oldAutoCommit;
1719 return "queueing job (transaction rolled back): $error";
1723 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1730 Checks all fields to make sure this is a valid customer record. If there is
1731 an error, returns the error, otherwise returns false. Called by the insert
1732 and replace methods.
1739 warn "$me check BEFORE: \n". $self->_dump
1743 $self->ut_numbern('custnum')
1744 || $self->ut_number('agentnum')
1745 || $self->ut_textn('agent_custid')
1746 || $self->ut_number('refnum')
1747 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1748 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1749 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1750 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1751 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1752 || $self->ut_textn('custbatch')
1753 || $self->ut_name('last')
1754 || $self->ut_name('first')
1755 || $self->ut_snumbern('signupdate')
1756 || $self->ut_snumbern('birthdate')
1757 || $self->ut_namen('spouse_last')
1758 || $self->ut_namen('spouse_first')
1759 || $self->ut_snumbern('spouse_birthdate')
1760 || $self->ut_snumbern('anniversary_date')
1761 || $self->ut_textn('company')
1762 || $self->ut_textn('ship_company')
1763 || $self->ut_anything('comments')
1764 || $self->ut_numbern('referral_custnum')
1765 || $self->ut_textn('stateid')
1766 || $self->ut_textn('stateid_state')
1767 || $self->ut_textn('invoice_terms')
1768 || $self->ut_floatn('cdr_termination_percentage')
1769 || $self->ut_floatn('credit_limit')
1770 || $self->ut_numbern('billday')
1771 || $self->ut_numbern('prorate_day')
1772 || $self->ut_flag('edit_subject')
1773 || $self->ut_flag('calling_list_exempt')
1774 || $self->ut_flag('invoice_noemail')
1775 || $self->ut_flag('message_noemail')
1776 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1777 || $self->ut_currencyn('currency')
1778 || $self->ut_textn('po_number')
1779 || $self->ut_enum('complimentary', [ '', 'Y' ])
1780 || $self->ut_flag('invoice_ship_address')
1781 || $self->ut_flag('invoice_dest')
1784 foreach (qw(company ship_company)) {
1785 my $company = $self->get($_);
1786 $company =~ s/^\s+//;
1787 $company =~ s/\s+$//;
1788 $company =~ s/\s+/ /g;
1789 $self->set($_, $company);
1792 #barf. need message catalogs. i18n. etc.
1793 $error .= "Please select an advertising source."
1794 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1795 return $error if $error;
1797 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1798 or return "Unknown agent";
1800 if ( $self->currency ) {
1801 my $agent_currency = qsearchs( 'agent_currency', {
1802 'agentnum' => $agent->agentnum,
1803 'currency' => $self->currency,
1805 or return "Agent ". $agent->agent.
1806 " not permitted to offer ". $self->currency. " invoicing";
1809 return "Unknown refnum"
1810 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1812 return "Unknown referring custnum: ". $self->referral_custnum
1813 unless ! $self->referral_custnum
1814 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1816 if ( $self->ss eq '' ) {
1821 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1822 or return "Illegal social security number: ". $self->ss;
1823 $self->ss("$1-$2-$3");
1826 #turn off invoice_ship_address if ship & bill are the same
1827 if ($self->bill_locationnum eq $self->ship_locationnum) {
1828 $self->invoice_ship_address('');
1831 # cust_main_county verification now handled by cust_location check
1834 $self->ut_phonen('daytime', $self->country)
1835 || $self->ut_phonen('night', $self->country)
1836 || $self->ut_phonen('fax', $self->country)
1837 || $self->ut_phonen('mobile', $self->country)
1839 return $error if $error;
1841 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1843 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1846 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1848 : FS::Msgcat::_gettext('daytime');
1849 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1851 : FS::Msgcat::_gettext('night');
1853 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1855 : FS::Msgcat::_gettext('mobile');
1857 return "$daytime_label, $night_label or $mobile_label is required"
1861 return "Please select an invoicing locale"
1864 && $conf->exists('cust_main-require_locale');
1866 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1867 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1871 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
1873 warn "$me check AFTER: \n". $self->_dump
1876 $self->SUPER::check;
1879 sub check_payinfo_cardtype {
1882 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
1884 my $payinfo = $self->payinfo;
1885 $payinfo =~ s/\D//g;
1887 return '' if $payinfo =~ /^99\d{14}$/; #token
1889 my %bop_card_types = map { $_=>1 } values %{ card_types() };
1890 my $cardtype = cardtype($payinfo);
1892 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
1900 Additional checks for replace only.
1905 my ($new,$old) = @_;
1906 #preserve old value if global config is set
1907 if ($old && $conf->exists('invoice-ship_address')) {
1908 $new->invoice_ship_address($old->invoice_ship_address);
1915 Returns a list of fields which have ship_ duplicates.
1920 qw( last first company
1922 address1 address2 city county state zip country
1924 daytime night fax mobile
1928 =item has_ship_address
1930 Returns true if this customer record has a separate shipping address.
1934 sub has_ship_address {
1936 $self->bill_locationnum != $self->ship_locationnum;
1941 Returns a list of key/value pairs, with the following keys: address1,
1942 adddress2, city, county, state, zip, country, district, and geocode. The
1943 shipping address is used if present.
1949 $self->ship_location->location_hash;
1954 Returns all locations (see L<FS::cust_location>) for this customer.
1961 'table' => 'cust_location',
1962 'hashref' => { 'custnum' => $self->custnum,
1963 'prospectnum' => '',
1965 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
1971 Returns all contact associations (see L<FS::cust_contact>) for this customer.
1977 qsearch('cust_contact', { 'custnum' => $self->custnum } );
1980 =item cust_payby PAYBY
1982 Returns all payment methods (see L<FS::cust_payby>) for this customer.
1984 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
1985 Does not validate PAYBY.
1993 'table' => 'cust_payby',
1994 'hashref' => { 'custnum' => $self->custnum },
1995 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
1997 $search->{'extra_sql'} = ' AND payby IN ( '.
1998 join(',', map dbh->quote($_), @payby).
2005 =item has_cust_payby_auto
2007 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2011 sub has_cust_payby_auto {
2014 'table' => 'cust_payby',
2015 'hashref' => { 'custnum' => $self->custnum, },
2016 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2017 'order_by' => 'LIMIT 1',
2024 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2025 and L<FS::cust_pkg>) for this customer, except those on hold.
2027 Returns a list: an empty list on success or a list of errors.
2033 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2038 Unsuspends all suspended packages in the on-hold state (those without setup
2039 dates) for this customer.
2045 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2050 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2052 Returns a list: an empty list on success or a list of errors.
2058 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2061 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2063 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2064 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2065 of a list of pkgparts; the hashref has the following keys:
2069 =item pkgparts - listref of pkgparts
2071 =item (other options are passed to the suspend method)
2076 Returns a list: an empty list on success or a list of errors.
2080 sub suspend_if_pkgpart {
2082 my (@pkgparts, %opt);
2083 if (ref($_[0]) eq 'HASH'){
2084 @pkgparts = @{$_[0]{pkgparts}};
2089 grep { $_->suspend(%opt) }
2090 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2091 $self->unsuspended_pkgs;
2094 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2096 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2097 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2098 instead of a list of pkgparts; the hashref has the following keys:
2102 =item pkgparts - listref of pkgparts
2104 =item (other options are passed to the suspend method)
2108 Returns a list: an empty list on success or a list of errors.
2112 sub suspend_unless_pkgpart {
2114 my (@pkgparts, %opt);
2115 if (ref($_[0]) eq 'HASH'){
2116 @pkgparts = @{$_[0]{pkgparts}};
2121 grep { $_->suspend(%opt) }
2122 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2123 $self->unsuspended_pkgs;
2126 =item cancel [ OPTION => VALUE ... ]
2128 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2129 The cancellation time will be now.
2133 Always returns a list: an empty list on success or a list of errors.
2140 warn "$me cancel called on customer ". $self->custnum. " with options ".
2141 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2143 my @pkgs = $self->ncancelled_pkgs;
2145 $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2148 =item cancel_pkgs OPTIONS
2150 Cancels a specified list of packages. OPTIONS can include:
2154 =item cust_pkg - an arrayref of the packages. Required.
2156 =item time - the cancellation time, used to calculate final bills and
2157 unused-time credits if any. Will be passed through to the bill() and
2158 FS::cust_pkg::cancel() methods.
2160 =item quiet - can be set true to supress email cancellation notices.
2162 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
2164 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2165 for the individual packages, parallel to the C<cust_pkg> argument. The
2166 reason and reason_otaker arguments will be taken from those objects.
2168 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2170 =item nobill - can be set true to skip billing if it might otherwise be done.
2175 my( $self, %opt ) = @_;
2177 # we're going to cancel services, which is not reversible
2178 die "cancel_pkgs cannot be run inside a transaction"
2179 if $FS::UID::AutoCommit == 0;
2181 local $FS::UID::AutoCommit = 0;
2183 return ( 'access denied' )
2184 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2186 if ( $opt{'ban'} ) {
2188 foreach my $cust_payby ( $self->cust_payby ) {
2190 #well, if they didn't get decrypted on search, then we don't have to
2191 # try again... queue a job for the server that does have decryption
2192 # capability if we're in a paranoid multi-server implementation?
2193 return ( "Can't (yet) ban encrypted credit cards" )
2194 if $cust_payby->is_encrypted($cust_payby->payinfo);
2196 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2197 my $error = $ban->insert;
2207 my @pkgs = @{ delete $opt{'cust_pkg'} };
2208 my $cancel_time = $opt{'time'} || time;
2210 # bill all packages first, so we don't lose usage, service counts for
2211 # bulk billing, etc.
2212 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2214 my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2216 'time' => $cancel_time );
2218 warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2220 return ( "Error billing during cancellation: $error" );
2225 $FS::UID::AutoCommit = 1;
2227 # now cancel all services, the same way we would for individual packages.
2228 # if any of them fail, cancel the rest anyway.
2229 my @cust_svc = map { $_->cust_svc } @pkgs;
2230 my @sorted_cust_svc =
2232 sort { $a->[1] <=> $b->[1] }
2233 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2235 warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2238 foreach my $cust_svc (@sorted_cust_svc) {
2239 my $part_svc = $cust_svc->part_svc;
2240 next if ( defined($part_svc) and $part_svc->preserve );
2241 my $error = $cust_svc->cancel; # immediate cancel, no date option
2242 push @errors, $error if $error;
2248 warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2249 $self->custnum. "\n"
2253 if ($opt{'cust_pkg_reason'}) {
2254 @cprs = @{ delete $opt{'cust_pkg_reason'} };
2259 my $cpr = shift @cprs;
2260 $lopt{'reason'} = $cpr->reasonnum;
2261 $lopt{'reason_otaker'} = $cpr->otaker;
2263 my $error = $_->cancel(%lopt);
2264 push @errors, 'pkgnum '.$_->pkgnum.': '.$error if $error;
2270 sub _banned_pay_hashref {
2271 die 'cust_main->_banned_pay_hashref deprecated';
2283 'payby' => $payby2ban{$self->payby},
2284 'payinfo' => $self->payinfo,
2285 #don't ever *search* on reason! #'reason' =>
2291 Returns all notes (see L<FS::cust_main_note>) for this customer.
2296 my($self,$orderby_classnum) = (shift,shift);
2297 my $orderby = "sticky DESC, _date DESC";
2298 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2299 qsearch( 'cust_main_note',
2300 { 'custnum' => $self->custnum },
2302 "ORDER BY $orderby",
2308 Returns the agent (see L<FS::agent>) for this customer.
2312 Returns the agent name (see L<FS::agent>) for this customer.
2318 $self->agent->agent;
2323 Returns any tags associated with this customer, as FS::cust_tag objects,
2324 or an empty list if there are no tags.
2328 Returns any tags associated with this customer, as FS::part_tag objects,
2329 or an empty list if there are no tags.
2335 map $_->part_tag, $self->cust_tag;
2341 Returns the customer class, as an FS::cust_class object, or the empty string
2342 if there is no customer class.
2346 Returns the customer category name, or the empty string if there is no customer
2353 my $cust_class = $self->cust_class;
2355 ? $cust_class->categoryname
2361 Returns the customer class name, or the empty string if there is no customer
2368 my $cust_class = $self->cust_class;
2370 ? $cust_class->classname
2376 Returns the external tax status, as an FS::tax_status object, or the empty
2377 string if there is no tax status.
2383 if ( $self->taxstatusnum ) {
2384 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2392 Returns the tax status code if there is one.
2398 my $tax_status = $self->tax_status;
2400 ? $tax_status->taxstatus
2404 =item BILLING METHODS
2406 Documentation on billing methods has been moved to
2407 L<FS::cust_main::Billing>.
2409 =item REALTIME BILLING METHODS
2411 Documentation on realtime billing methods has been moved to
2412 L<FS::cust_main::Billing_Realtime>.
2416 Removes the I<paycvv> field from the database directly.
2418 If there is an error, returns the error, otherwise returns false.
2420 DEPRECATED. Use L</remove_cvv_from_cust_payby> instead.
2425 die 'cust_main->remove_cvv deprecated';
2427 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2428 or return dbh->errstr;
2429 $sth->execute($self->custnum)
2430 or return $sth->errstr;
2437 Returns the total owed for this customer on all invoices
2438 (see L<FS::cust_bill/owed>).
2444 $self->total_owed_date(2145859200); #12/31/2037
2447 =item total_owed_date TIME
2449 Returns the total owed for this customer on all invoices with date earlier than
2450 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2451 see L<Time::Local> and L<Date::Parse> for conversion functions.
2455 sub total_owed_date {
2459 my $custnum = $self->custnum;
2461 my $owed_sql = FS::cust_bill->owed_sql;
2464 SELECT SUM($owed_sql) FROM cust_bill
2465 WHERE custnum = $custnum
2469 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2473 =item total_owed_pkgnum PKGNUM
2475 Returns the total owed on all invoices for this customer's specific package
2476 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2480 sub total_owed_pkgnum {
2481 my( $self, $pkgnum ) = @_;
2482 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2485 =item total_owed_date_pkgnum TIME PKGNUM
2487 Returns the total owed for this customer's specific package when using
2488 experimental package balances on all invoices with date earlier than
2489 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2490 see L<Time::Local> and L<Date::Parse> for conversion functions.
2494 sub total_owed_date_pkgnum {
2495 my( $self, $time, $pkgnum ) = @_;
2498 foreach my $cust_bill (
2499 grep { $_->_date <= $time }
2500 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2502 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2504 sprintf( "%.2f", $total_bill );
2510 Returns the total amount of all payments.
2517 $total += $_->paid foreach $self->cust_pay;
2518 sprintf( "%.2f", $total );
2521 =item total_unapplied_credits
2523 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2524 customer. See L<FS::cust_credit/credited>.
2526 =item total_credited
2528 Old name for total_unapplied_credits. Don't use.
2532 sub total_credited {
2533 #carp "total_credited deprecated, use total_unapplied_credits";
2534 shift->total_unapplied_credits(@_);
2537 sub total_unapplied_credits {
2540 my $custnum = $self->custnum;
2542 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2545 SELECT SUM($unapplied_sql) FROM cust_credit
2546 WHERE custnum = $custnum
2549 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2553 =item total_unapplied_credits_pkgnum PKGNUM
2555 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2556 customer. See L<FS::cust_credit/credited>.
2560 sub total_unapplied_credits_pkgnum {
2561 my( $self, $pkgnum ) = @_;
2562 my $total_credit = 0;
2563 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2564 sprintf( "%.2f", $total_credit );
2568 =item total_unapplied_payments
2570 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2571 See L<FS::cust_pay/unapplied>.
2575 sub total_unapplied_payments {
2578 my $custnum = $self->custnum;
2580 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2583 SELECT SUM($unapplied_sql) FROM cust_pay
2584 WHERE custnum = $custnum
2587 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2591 =item total_unapplied_payments_pkgnum PKGNUM
2593 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2594 specific package when using experimental package balances. See
2595 L<FS::cust_pay/unapplied>.
2599 sub total_unapplied_payments_pkgnum {
2600 my( $self, $pkgnum ) = @_;
2601 my $total_unapplied = 0;
2602 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2603 sprintf( "%.2f", $total_unapplied );
2607 =item total_unapplied_refunds
2609 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2610 customer. See L<FS::cust_refund/unapplied>.
2614 sub total_unapplied_refunds {
2616 my $custnum = $self->custnum;
2618 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2621 SELECT SUM($unapplied_sql) FROM cust_refund
2622 WHERE custnum = $custnum
2625 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2631 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2632 total_unapplied_credits minus total_unapplied_payments).
2638 $self->balance_date_range;
2641 =item balance_date TIME
2643 Returns the balance for this customer, only considering invoices with date
2644 earlier than TIME (total_owed_date minus total_credited minus
2645 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2646 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2653 $self->balance_date_range(shift);
2656 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2658 Returns the balance for this customer, optionally considering invoices with
2659 date earlier than START_TIME, and not later than END_TIME
2660 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2662 Times are specified as SQL fragments or numeric
2663 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2664 L<Date::Parse> for conversion functions. The empty string can be passed
2665 to disable that time constraint completely.
2667 Accepts the same options as L<balance_date_sql>:
2671 =item unapplied_date
2673 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)
2677 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2678 time will be ignored. Note that START_TIME and END_TIME only limit the date
2679 range for invoices and I<unapplied> payments, credits, and refunds.
2685 sub balance_date_range {
2687 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2688 ') FROM cust_main WHERE custnum='. $self->custnum;
2689 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2692 =item balance_pkgnum PKGNUM
2694 Returns the balance for this customer's specific package when using
2695 experimental package balances (total_owed plus total_unrefunded, minus
2696 total_unapplied_credits minus total_unapplied_payments)
2700 sub balance_pkgnum {
2701 my( $self, $pkgnum ) = @_;
2704 $self->total_owed_pkgnum($pkgnum)
2705 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2706 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2707 - $self->total_unapplied_credits_pkgnum($pkgnum)
2708 - $self->total_unapplied_payments_pkgnum($pkgnum)
2714 Returns a hash of useful information for making a payment.
2724 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2725 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2726 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2730 For credit card transactions:
2742 For electronic check transactions:
2752 #XXX i need to be updated for 4.x+
2758 $return{balance} = $self->balance;
2760 $return{payname} = $self->payname
2761 || ( $self->first. ' '. $self->get('last') );
2763 $return{$_} = $self->bill_location->$_
2764 for qw(address1 address2 city state zip);
2766 $return{payby} = $self->payby;
2767 $return{stateid_state} = $self->stateid_state;
2769 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2770 $return{card_type} = cardtype($self->payinfo);
2771 $return{payinfo} = $self->paymask;
2773 @return{'month', 'year'} = $self->paydate_monthyear;
2777 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2778 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2779 $return{payinfo1} = $payinfo1;
2780 $return{payinfo2} = $payinfo2;
2781 $return{paytype} = $self->paytype;
2782 $return{paystate} = $self->paystate;
2786 #doubleclick protection
2788 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2796 Returns the next payment expiration date for this customer. If they have no
2797 payment methods that will expire, returns 0.
2803 # filter out the ones that individually return 0, but then return 0 if
2804 # there are no results
2805 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
2806 min( @epochs ) || 0;
2809 =item paydate_epoch_sql
2811 Returns an SQL expression to get the next payment expiration date for a
2812 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
2813 dates, so that it's safe to test for "will it expire before date X" for any
2818 sub paydate_epoch_sql {
2820 my $paydate = FS::cust_payby->paydate_epoch_sql;
2821 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
2825 my( $self, $taxname ) = @_;
2827 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2828 'taxname' => $taxname,
2833 =item cust_main_exemption
2835 =item invoicing_list
2837 Returns a list of email addresses (with svcnum entries expanded), and the word
2838 'POST' if the customer receives postal invoices.
2842 sub invoicing_list {
2843 my( $self, $arrayref ) = @_;
2846 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
2849 my @emails = $self->invoicing_list_emailonly;
2850 push @emails, 'POST' if $self->get('postal_invoice');
2855 =item check_invoicing_list ARRAYREF
2857 Checks these arguements as valid input for the invoicing_list method. If there
2858 is an error, returns the error, otherwise returns false.
2862 sub check_invoicing_list {
2863 my( $self, $arrayref ) = @_;
2865 foreach my $address ( @$arrayref ) {
2867 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
2868 return 'Can\'t add FAX invoice destination with a blank FAX number.';
2871 my $cust_main_invoice = new FS::cust_main_invoice ( {
2872 'custnum' => $self->custnum,
2875 my $error = $self->custnum
2876 ? $cust_main_invoice->check
2877 : $cust_main_invoice->checkdest
2879 return $error if $error;
2883 return "Email address required"
2884 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
2885 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
2892 Returns the email addresses of all accounts provisioned for this customer.
2899 foreach my $cust_pkg ( $self->all_pkgs ) {
2900 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
2902 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2903 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2905 $list{$_}=1 foreach map { $_->email } @svc_acct;
2910 =item invoicing_list_addpost
2912 Adds postal invoicing to this customer. If this customer is already configured
2913 to receive postal invoices, does nothing.
2917 sub invoicing_list_addpost {
2919 if ( $self->get('postal_invoice') eq '' ) {
2920 $self->set('postal_invoice', 'Y');
2921 my $error = $self->replace;
2922 warn $error if $error; # should fail harder, but this is traditional
2926 =item invoicing_list_emailonly
2928 Returns the list of email invoice recipients (invoicing_list without non-email
2929 destinations such as POST and FAX).
2933 sub invoicing_list_emailonly {
2935 warn "$me invoicing_list_emailonly called"
2937 return () if !$self->custnum; # not yet inserted
2938 return map { $_->emailaddress }
2940 table => 'cust_contact',
2941 select => 'emailaddress',
2942 addl_from => ' JOIN contact USING (contactnum) '.
2943 ' JOIN contact_email USING (contactnum)',
2944 hashref => { 'custnum' => $self->custnum, },
2945 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
2949 =item invoicing_list_emailonly_scalar
2951 Returns the list of email invoice recipients (invoicing_list without non-email
2952 destinations such as POST and FAX) as a comma-separated scalar.
2956 sub invoicing_list_emailonly_scalar {
2958 warn "$me invoicing_list_emailonly_scalar called"
2960 join(', ', $self->invoicing_list_emailonly);
2963 =item contact_list [ CLASSNUM, ... ]
2965 Returns a list of contacts (L<FS::contact> objects) for the customer. If
2966 a list of contact classnums is given, returns only contacts in those
2967 classes. If the pseudo-classnum 'invoice' is given, returns contacts that
2968 are marked as invoice destinations. If '0' is given, also returns contacts
2971 If no arguments are given, returns all contacts for the customer.
2979 select => 'contact.*, cust_contact.invoice_dest',
2980 addl_from => ' JOIN cust_contact USING (contactnum)',
2981 extra_sql => ' WHERE cust_contact.custnum = '.$self->custnum,
2987 if ( $_ eq 'invoice' ) {
2988 push @orwhere, 'cust_contact.invoice_dest = \'Y\'';
2989 } elsif ( $_ eq '0' ) {
2990 push @orwhere, 'cust_contact.classnum is null';
2991 } elsif ( /^\d+$/ ) {
2992 push @classnums, $_;
2994 die "bad classnum argument '$_'";
2999 push @orwhere, 'cust_contact.classnum IN ('.join(',', @classnums).')';
3002 $search->{extra_sql} .= ' AND (' .
3003 join(' OR ', map "( $_ )", @orwhere) .
3010 =item contact_list_email [ CLASSNUM, ... ]
3012 Same as L</contact_list>, but returns email destinations instead of contact
3017 sub contact_list_email {
3019 my @contacts = $self->contact_list(@_);
3021 foreach my $contact (@contacts) {
3022 foreach my $contact_email ($contact->contact_email) {
3024 $contact->firstlast . ' <' . $contact_email->emailaddress . '>';
3030 =item referral_custnum_cust_main
3032 Returns the customer who referred this customer (or the empty string, if
3033 this customer was not referred).
3035 Note the difference with referral_cust_main method: This method,
3036 referral_custnum_cust_main returns the single customer (if any) who referred
3037 this customer, while referral_cust_main returns an array of customers referred
3042 sub referral_custnum_cust_main {
3044 return '' unless $self->referral_custnum;
3045 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3048 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3050 Returns an array of customers referred by this customer (referral_custnum set
3051 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3052 customers referred by customers referred by this customer and so on, inclusive.
3053 The default behavior is DEPTH 1 (no recursion).
3055 Note the difference with referral_custnum_cust_main method: This method,
3056 referral_cust_main, returns an array of customers referred BY this customer,
3057 while referral_custnum_cust_main returns the single customer (if any) who
3058 referred this customer.
3062 sub referral_cust_main {
3064 my $depth = @_ ? shift : 1;
3065 my $exclude = @_ ? shift : {};
3068 map { $exclude->{$_->custnum}++; $_; }
3069 grep { ! $exclude->{ $_->custnum } }
3070 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3074 map { $_->referral_cust_main($depth-1, $exclude) }
3081 =item referral_cust_main_ncancelled
3083 Same as referral_cust_main, except only returns customers with uncancelled
3088 sub referral_cust_main_ncancelled {
3090 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3093 =item referral_cust_pkg [ DEPTH ]
3095 Like referral_cust_main, except returns a flat list of all unsuspended (and
3096 uncancelled) packages for each customer. The number of items in this list may
3097 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3101 sub referral_cust_pkg {
3103 my $depth = @_ ? shift : 1;
3105 map { $_->unsuspended_pkgs }
3106 grep { $_->unsuspended_pkgs }
3107 $self->referral_cust_main($depth);
3110 =item referring_cust_main
3112 Returns the single cust_main record for the customer who referred this customer
3113 (referral_custnum), or false.
3117 sub referring_cust_main {
3119 return '' unless $self->referral_custnum;
3120 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3123 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3125 Applies a credit to this customer. If there is an error, returns the error,
3126 otherwise returns false.
3128 REASON can be a text string, an FS::reason object, or a scalar reference to
3129 a reasonnum. If a text string, it will be automatically inserted as a new
3130 reason, and a 'reason_type' option must be passed to indicate the
3131 FS::reason_type for the new reason.
3133 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3134 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3135 I<commission_pkgnum>.
3137 Any other options are passed to FS::cust_credit::insert.
3142 my( $self, $amount, $reason, %options ) = @_;
3144 my $cust_credit = new FS::cust_credit {
3145 'custnum' => $self->custnum,
3146 'amount' => $amount,
3149 if ( ref($reason) ) {
3151 if ( ref($reason) eq 'SCALAR' ) {
3152 $cust_credit->reasonnum( $$reason );
3154 $cust_credit->reasonnum( $reason->reasonnum );
3158 $cust_credit->set('reason', $reason)
3161 $cust_credit->$_( delete $options{$_} )
3162 foreach grep exists($options{$_}),
3163 qw( addlinfo eventnum ),
3164 map "commission_$_", qw( agentnum salesnum pkgnum );
3166 $cust_credit->insert(%options);
3170 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3172 Creates a one-time charge for this customer. If there is an error, returns
3173 the error, otherwise returns false.
3175 New-style, with a hashref of options:
3177 my $error = $cust_main->charge(
3181 'start_date' => str2time('7/4/2009'),
3182 'pkg' => 'Description',
3183 'comment' => 'Comment',
3184 'additional' => [], #extra invoice detail
3185 'classnum' => 1, #pkg_class
3187 'setuptax' => '', # or 'Y' for tax exempt
3189 'locationnum'=> 1234, # optional
3192 'taxclass' => 'Tax class',
3195 'taxproduct' => 2, #part_pkg_taxproduct
3196 'override' => {}, #XXX describe
3198 #will be filled in with the new object
3199 'cust_pkg_ref' => \$cust_pkg,
3201 #generate an invoice immediately
3203 'invoice_terms' => '', #with these terms
3209 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3213 #super false laziness w/quotation::charge
3216 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3217 my ( $pkg, $comment, $additional );
3218 my ( $setuptax, $taxclass ); #internal taxes
3219 my ( $taxproduct, $override ); #vendor (CCH) taxes
3221 my $separate_bill = '';
3222 my $cust_pkg_ref = '';
3223 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3225 if ( ref( $_[0] ) ) {
3226 $amount = $_[0]->{amount};
3227 $setup_cost = $_[0]->{setup_cost};
3228 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3229 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3230 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3231 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3232 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3233 : '$'. sprintf("%.2f",$amount);
3234 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3235 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3236 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3237 $additional = $_[0]->{additional} || [];
3238 $taxproduct = $_[0]->{taxproductnum};
3239 $override = { '' => $_[0]->{tax_override} };
3240 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3241 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3242 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3243 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3244 $separate_bill = $_[0]->{separate_bill} || '';
3250 $pkg = @_ ? shift : 'One-time charge';
3251 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3253 $taxclass = @_ ? shift : '';
3257 local $SIG{HUP} = 'IGNORE';
3258 local $SIG{INT} = 'IGNORE';
3259 local $SIG{QUIT} = 'IGNORE';
3260 local $SIG{TERM} = 'IGNORE';
3261 local $SIG{TSTP} = 'IGNORE';
3262 local $SIG{PIPE} = 'IGNORE';
3264 my $oldAutoCommit = $FS::UID::AutoCommit;
3265 local $FS::UID::AutoCommit = 0;
3268 my $part_pkg = new FS::part_pkg ( {
3270 'comment' => $comment,
3274 'classnum' => ( $classnum ? $classnum : '' ),
3275 'setuptax' => $setuptax,
3276 'taxclass' => $taxclass,
3277 'taxproductnum' => $taxproduct,
3278 'setup_cost' => $setup_cost,
3281 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3282 ( 0 .. @$additional - 1 )
3284 'additional_count' => scalar(@$additional),
3285 'setup_fee' => $amount,
3288 my $error = $part_pkg->insert( options => \%options,
3289 tax_overrides => $override,
3292 $dbh->rollback if $oldAutoCommit;
3296 my $pkgpart = $part_pkg->pkgpart;
3297 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3298 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3299 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3300 $error = $type_pkgs->insert;
3302 $dbh->rollback if $oldAutoCommit;
3307 my $cust_pkg = new FS::cust_pkg ( {
3308 'custnum' => $self->custnum,
3309 'pkgpart' => $pkgpart,
3310 'quantity' => $quantity,
3311 'start_date' => $start_date,
3312 'no_auto' => $no_auto,
3313 'separate_bill' => $separate_bill,
3314 'locationnum'=> $locationnum,
3317 $error = $cust_pkg->insert;
3319 $dbh->rollback if $oldAutoCommit;
3321 } elsif ( $cust_pkg_ref ) {
3322 ${$cust_pkg_ref} = $cust_pkg;
3326 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3327 'pkg_list' => [ $cust_pkg ],
3330 $dbh->rollback if $oldAutoCommit;
3335 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3340 #=item charge_postal_fee
3342 #Applies a one time charge this customer. If there is an error,
3343 #returns the error, returns the cust_pkg charge object or false
3344 #if there was no charge.
3348 # This should be a customer event. For that to work requires that bill
3349 # also be a customer event.
3351 sub charge_postal_fee {
3354 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3355 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3357 my $cust_pkg = new FS::cust_pkg ( {
3358 'custnum' => $self->custnum,
3359 'pkgpart' => $pkgpart,
3363 my $error = $cust_pkg->insert;
3364 $error ? $error : $cust_pkg;
3367 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3369 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3371 Optionally, a list or hashref of additional arguments to the qsearch call can
3378 my $opt = ref($_[0]) ? shift : { @_ };
3380 #return $self->num_cust_bill unless wantarray || keys %$opt;
3382 $opt->{'table'} = 'cust_bill';
3383 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3384 $opt->{'hashref'}{'custnum'} = $self->custnum;
3385 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3387 map { $_ } #behavior of sort undefined in scalar context
3388 sort { $a->_date <=> $b->_date }
3392 =item open_cust_bill
3394 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3399 sub open_cust_bill {
3403 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3409 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3411 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3415 sub legacy_cust_bill {
3418 #return $self->num_legacy_cust_bill unless wantarray;
3420 map { $_ } #behavior of sort undefined in scalar context
3421 sort { $a->_date <=> $b->_date }
3422 qsearch({ 'table' => 'legacy_cust_bill',
3423 'hashref' => { 'custnum' => $self->custnum, },
3424 'order_by' => 'ORDER BY _date ASC',
3428 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3430 Returns all the statements (see L<FS::cust_statement>) for this customer.
3432 Optionally, a list or hashref of additional arguments to the qsearch call can
3437 =item cust_bill_void
3439 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3443 sub cust_bill_void {
3446 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3447 sort { $a->_date <=> $b->_date }
3448 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3451 sub cust_statement {
3453 my $opt = ref($_[0]) ? shift : { @_ };
3455 #return $self->num_cust_statement unless wantarray || keys %$opt;
3457 $opt->{'table'} = 'cust_statement';
3458 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3459 $opt->{'hashref'}{'custnum'} = $self->custnum;
3460 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3462 map { $_ } #behavior of sort undefined in scalar context
3463 sort { $a->_date <=> $b->_date }
3467 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3469 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3471 Optionally, a list or hashref of additional arguments to the qsearch call can
3472 be passed following the SVCDB.
3479 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3480 warn "$me svc_x requires a svcdb";
3483 my $opt = ref($_[0]) ? shift : { @_ };
3485 $opt->{'table'} = $svcdb;
3486 $opt->{'addl_from'} =
3487 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3488 ($opt->{'addl_from'} || '');
3490 my $custnum = $self->custnum;
3491 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3492 my $where = "cust_pkg.custnum = $custnum";
3494 my $extra_sql = $opt->{'extra_sql'} || '';
3495 if ( keys %{ $opt->{'hashref'} } ) {
3496 $extra_sql = " AND $where $extra_sql";
3499 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3500 $extra_sql = "WHERE $where AND $1";
3503 $extra_sql = "WHERE $where $extra_sql";
3506 $opt->{'extra_sql'} = $extra_sql;
3511 # required for use as an eventtable;
3514 $self->svc_x('svc_acct', @_);
3519 Returns all the credits (see L<FS::cust_credit>) for this customer.
3526 #return $self->num_cust_credit unless wantarray;
3528 map { $_ } #behavior of sort undefined in scalar context
3529 sort { $a->_date <=> $b->_date }
3530 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3533 =item cust_credit_pkgnum
3535 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3536 package when using experimental package balances.
3540 sub cust_credit_pkgnum {
3541 my( $self, $pkgnum ) = @_;
3542 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3543 sort { $a->_date <=> $b->_date }
3544 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3545 'pkgnum' => $pkgnum,
3550 =item cust_credit_void
3552 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3556 sub cust_credit_void {
3559 sort { $a->_date <=> $b->_date }
3560 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3565 Returns all the payments (see L<FS::cust_pay>) for this customer.
3571 my $opt = ref($_[0]) ? shift : { @_ };
3573 return $self->num_cust_pay unless wantarray || keys %$opt;
3575 $opt->{'table'} = 'cust_pay';
3576 $opt->{'hashref'}{'custnum'} = $self->custnum;
3578 map { $_ } #behavior of sort undefined in scalar context
3579 sort { $a->_date <=> $b->_date }
3586 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3587 called automatically when the cust_pay method is used in a scalar context.
3593 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3594 my $sth = dbh->prepare($sql) or die dbh->errstr;
3595 $sth->execute($self->custnum) or die $sth->errstr;
3596 $sth->fetchrow_arrayref->[0];
3599 =item unapplied_cust_pay
3601 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3605 sub unapplied_cust_pay {
3609 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3615 =item cust_pay_pkgnum
3617 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3618 package when using experimental package balances.
3622 sub cust_pay_pkgnum {
3623 my( $self, $pkgnum ) = @_;
3624 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3625 sort { $a->_date <=> $b->_date }
3626 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3627 'pkgnum' => $pkgnum,
3634 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3640 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3641 sort { $a->_date <=> $b->_date }
3642 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3645 =item cust_pay_pending
3647 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3648 (without status "done").
3652 sub cust_pay_pending {
3654 return $self->num_cust_pay_pending unless wantarray;
3655 sort { $a->_date <=> $b->_date }
3656 qsearch( 'cust_pay_pending', {
3657 'custnum' => $self->custnum,
3658 'status' => { op=>'!=', value=>'done' },
3663 =item cust_pay_pending_attempt
3665 Returns all payment attempts / declined payments for this customer, as pending
3666 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3667 a corresponding payment (see L<FS::cust_pay>).
3671 sub cust_pay_pending_attempt {
3673 return $self->num_cust_pay_pending_attempt unless wantarray;
3674 sort { $a->_date <=> $b->_date }
3675 qsearch( 'cust_pay_pending', {
3676 'custnum' => $self->custnum,
3683 =item num_cust_pay_pending
3685 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3686 customer (without status "done"). Also called automatically when the
3687 cust_pay_pending method is used in a scalar context.
3691 sub num_cust_pay_pending {
3694 " SELECT COUNT(*) FROM cust_pay_pending ".
3695 " WHERE custnum = ? AND status != 'done' ",
3700 =item num_cust_pay_pending_attempt
3702 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3703 customer, with status "done" but without a corresp. Also called automatically when the
3704 cust_pay_pending method is used in a scalar context.
3708 sub num_cust_pay_pending_attempt {
3711 " SELECT COUNT(*) FROM cust_pay_pending ".
3712 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3719 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3725 map { $_ } #return $self->num_cust_refund unless wantarray;
3726 sort { $a->_date <=> $b->_date }
3727 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3730 =item display_custnum
3732 Returns the displayed customer number for this customer: agent_custid if
3733 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3737 sub display_custnum {
3740 return $self->agent_custid
3741 if $default_agent_custid && $self->agent_custid;
3743 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3747 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
3748 } elsif ( $custnum_display_length ) {
3749 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
3751 return $self->custnum;
3757 Returns a name string for this customer, either "Company (Last, First)" or
3764 my $name = $self->contact;
3765 $name = $self->company. " ($name)" if $self->company;
3769 =item service_contact
3771 Returns the L<FS::contact> object for this customer that has the 'Service'
3772 contact class, or undef if there is no such contact. Deprecated; don't use
3777 sub service_contact {
3779 if ( !exists($self->{service_contact}) ) {
3780 my $classnum = $self->scalar_sql(
3781 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3782 ) || 0; #if it's zero, qsearchs will return nothing
3783 my $cust_contact = qsearchs('cust_contact', {
3784 'classnum' => $classnum,
3785 'custnum' => $self->custnum,
3787 $self->{service_contact} = $cust_contact->contact if $cust_contact;
3789 $self->{service_contact};
3794 Returns a name string for this (service/shipping) contact, either
3795 "Company (Last, First)" or "Last, First".
3802 my $name = $self->ship_contact;
3803 $name = $self->company. " ($name)" if $self->company;
3809 Returns a name string for this customer, either "Company" or "First Last".
3815 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3818 =item ship_name_short
3820 Returns a name string for this (service/shipping) contact, either "Company"
3825 sub ship_name_short {
3827 $self->service_contact
3828 ? $self->ship_contact_firstlast
3834 Returns this customer's full (billing) contact name only, "Last, First"
3840 $self->get('last'). ', '. $self->first;
3845 Returns this customer's full (shipping) contact name only, "Last, First"
3851 my $contact = $self->service_contact || $self;
3852 $contact->get('last') . ', ' . $contact->get('first');
3855 =item contact_firstlast
3857 Returns this customers full (billing) contact name only, "First Last".
3861 sub contact_firstlast {
3863 $self->first. ' '. $self->get('last');
3866 =item ship_contact_firstlast
3868 Returns this customer's full (shipping) contact name only, "First Last".
3872 sub ship_contact_firstlast {
3874 my $contact = $self->service_contact || $self;
3875 $contact->get('first') . ' '. $contact->get('last');
3878 sub bill_country_full {
3880 $self->bill_location->country_full;
3883 sub ship_country_full {
3885 $self->ship_location->country_full;
3888 =item county_state_county [ PREFIX ]
3890 Returns a string consisting of just the county, state and country.
3894 sub county_state_country {
3897 if ( @_ && $_[0] && $self->has_ship_address ) {
3898 $locationnum = $self->ship_locationnum;
3900 $locationnum = $self->bill_locationnum;
3902 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
3903 $cust_location->county_state_country;
3906 =item geocode DATA_VENDOR
3908 Returns a value for the customer location as encoded by DATA_VENDOR.
3909 Currently this only makes sense for "CCH" as DATA_VENDOR.
3917 Returns a status string for this customer, currently:
3923 No packages have ever been ordered. Displayed as "No packages".
3927 Recurring packages all are new (not yet billed).
3931 One or more recurring packages is active.
3935 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
3939 All non-cancelled recurring packages are suspended.
3943 All recurring packages are cancelled.
3947 Behavior of inactive vs. cancelled edge cases can be adjusted with the
3948 cust_main-status_module configuration option.
3952 sub status { shift->cust_status(@_); }
3956 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
3957 for my $status ( FS::cust_main->statuses() ) {
3958 my $method = $status.'_sql';
3959 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3960 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3961 $sth->execute( ($self->custnum) x $numnum )
3962 or die "Error executing 'SELECT $sql': ". $sth->errstr;
3963 if ( $sth->fetchrow_arrayref->[0] ) {
3964 $self->hashref->{cust_status} = $status;
3970 =item is_status_delay_cancel
3972 Returns true if customer status is 'suspended'
3973 and all suspended cust_pkg return true for
3974 cust_pkg->is_status_delay_cancel.
3976 This is not a real status, this only meant for hacking display
3977 values, because otherwise treating the customer as suspended is
3978 really the whole point of the delay_cancel option.
3982 sub is_status_delay_cancel {
3984 return 0 unless $self->status eq 'suspended';
3985 foreach my $cust_pkg ($self->ncancelled_pkgs) {
3986 return 0 unless $cust_pkg->is_status_delay_cancel;
3991 =item ucfirst_cust_status
3993 =item ucfirst_status
3995 Deprecated, use the cust_status_label method instead.
3997 Returns the status with the first character capitalized.
4001 sub ucfirst_status {
4002 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4003 local($ucfirst_nowarn) = 1;
4004 shift->ucfirst_cust_status(@_);
4007 sub ucfirst_cust_status {
4008 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4010 ucfirst($self->cust_status);
4013 =item cust_status_label
4017 Returns the display label for this status.
4021 sub status_label { shift->cust_status_label(@_); }
4023 sub cust_status_label {
4025 __PACKAGE__->statuslabels->{$self->cust_status};
4030 Returns a hex triplet color string for this customer's status.
4034 sub statuscolor { shift->cust_statuscolor(@_); }
4036 sub cust_statuscolor {
4038 __PACKAGE__->statuscolors->{$self->cust_status};
4041 =item tickets [ STATUS ]
4043 Returns an array of hashes representing the customer's RT tickets.
4045 An optional status (or arrayref or hashref of statuses) may be specified.
4051 my $status = ( @_ && $_[0] ) ? shift : '';
4053 my $num = $conf->config('cust_main-max_tickets') || 10;
4056 if ( $conf->config('ticket_system') ) {
4057 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4059 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4068 foreach my $priority (
4069 $conf->config('ticket_system-custom_priority_field-values'), ''
4071 last if scalar(@tickets) >= $num;
4073 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4074 $num - scalar(@tickets),
4085 =item appointments [ STATUS ]
4087 Returns an array of hashes representing the customer's RT tickets which
4094 my $status = ( @_ && $_[0] ) ? shift : '';
4096 return () unless $conf->config('ticket_system');
4098 my $queueid = $conf->config('ticket_system-appointment-queueid');
4100 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4109 # Return services representing svc_accts in customer support packages
4110 sub support_services {
4112 my %packages = map { $_ => 1 } $conf->config('support_packages');
4114 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4115 grep { $_->part_svc->svcdb eq 'svc_acct' }
4116 map { $_->cust_svc }
4117 grep { exists $packages{ $_->pkgpart } }
4118 $self->ncancelled_pkgs;
4122 # Return a list of latitude/longitude for one of the services (if any)
4123 sub service_coordinates {
4127 grep { $_->latitude && $_->longitude }
4129 map { $_->cust_svc }
4130 $self->ncancelled_pkgs;
4132 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4137 Returns a masked version of the named field
4142 my ($self,$field) = @_;
4146 'x'x(length($self->getfield($field))-4).
4147 substr($self->getfield($field), (length($self->getfield($field))-4));
4151 =item payment_history
4153 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4154 cust_credit and cust_refund objects. Each hashref has the following fields:
4156 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4158 I<date> - value of _date field, unix timestamp
4160 I<date_pretty> - user-friendly date
4162 I<description> - user-friendly description of item
4164 I<amount> - impact of item on user's balance
4165 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4166 Not to be confused with the native 'amount' field in cust_credit, see below.
4168 I<amount_pretty> - includes money char
4170 I<balance> - customer balance, chronologically as of this item
4172 I<balance_pretty> - includes money char
4174 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4176 I<paid> - amount paid for cust_pay records, undef for other types
4178 I<credit> - amount credited for cust_credit records, undef for other types.
4179 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4181 I<refund> - amount refunded for cust_refund records, undef for other types
4183 The four table-specific keys always have positive values, whether they reflect charges or payments.
4185 The following options may be passed to this method:
4187 I<line_items> - if true, returns charges ('Line item') rather than invoices
4189 I<start_date> - unix timestamp, only include records on or after.
4190 If specified, an item of type 'Previous' will also be included.
4191 It does not have table-specific fields.
4193 I<end_date> - unix timestamp, only include records before
4195 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4197 I<conf> - optional already-loaded FS::Conf object.
4201 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4202 # and also for sending customer statements, which should both be kept customer-friendly.
4203 # If you add anything that shouldn't be passed on through the API or exposed
4204 # to customers, add a new option to include it, don't include it by default
4205 sub payment_history {
4207 my $opt = ref($_[0]) ? $_[0] : { @_ };
4209 my $conf = $$opt{'conf'} || new FS::Conf;
4210 my $money_char = $conf->config("money_char") || '$',
4212 #first load entire history,
4213 #need previous to calculate previous balance
4214 #loading after end_date shouldn't hurt too much?
4216 if ( $$opt{'line_items'} ) {
4218 foreach my $cust_bill ( $self->cust_bill ) {
4221 'type' => 'Line item',
4222 'description' => $_->desc( $self->locale ).
4223 ( $_->sdate && $_->edate
4224 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4225 ' To '. time2str('%d-%b-%Y', $_->edate)
4228 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4229 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4230 'date' => $cust_bill->_date,
4231 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4233 foreach $cust_bill->cust_bill_pkg;
4240 'type' => 'Invoice',
4241 'description' => 'Invoice #'. $_->display_invnum,
4242 'amount' => sprintf('%.2f', $_->charged ),
4243 'charged' => sprintf('%.2f', $_->charged ),
4244 'date' => $_->_date,
4245 'date_pretty' => $self->time2str_local('short', $_->_date ),
4247 foreach $self->cust_bill;
4252 'type' => 'Payment',
4253 'description' => 'Payment', #XXX type
4254 'amount' => sprintf('%.2f', 0 - $_->paid ),
4255 'paid' => sprintf('%.2f', $_->paid ),
4256 'date' => $_->_date,
4257 'date_pretty' => $self->time2str_local('short', $_->_date ),
4259 foreach $self->cust_pay;
4263 'description' => 'Credit', #more info?
4264 'amount' => sprintf('%.2f', 0 -$_->amount ),
4265 'credit' => sprintf('%.2f', $_->amount ),
4266 'date' => $_->_date,
4267 'date_pretty' => $self->time2str_local('short', $_->_date ),
4269 foreach $self->cust_credit;
4273 'description' => 'Refund', #more info? type, like payment?
4274 'amount' => $_->refund,
4275 'refund' => $_->refund,
4276 'date' => $_->_date,
4277 'date_pretty' => $self->time2str_local('short', $_->_date ),
4279 foreach $self->cust_refund;
4281 #put it all in chronological order
4282 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4284 #calculate balance, filter items outside date range
4288 foreach my $item (@history) {
4289 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4290 $balance += $$item{'amount'};
4291 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4292 $previous += $$item{'amount'};
4295 $$item{'balance'} = sprintf("%.2f",$balance);
4296 foreach my $key ( qw(amount balance) ) {
4297 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4302 # start with previous balance, if there was one
4305 'type' => 'Previous',
4306 'description' => 'Previous balance',
4307 'amount' => sprintf("%.2f",$previous),
4308 'balance' => sprintf("%.2f",$previous),
4309 'date' => $$opt{'start_date'},
4310 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4312 #false laziness with above
4313 foreach my $key ( qw(amount balance) ) {
4314 $$item{$key.'_pretty'} = $$item{$key};
4315 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4317 unshift(@out,$item);
4320 @out = reverse @history if $$opt{'reverse_sort'};
4325 =item save_cust_payby
4327 Saves a new cust_payby for this customer, replacing an existing entry only
4328 in select circumstances. Does not validate input.
4330 If auto is specified, marks this as the customer's primary method, or the
4331 specified weight. Existing payment methods have their weight incremented as
4334 If bill_location is specified with auto, also sets location in cust_main.
4336 Will not insert complete duplicates of existing records, or records in which the
4337 only difference from an existing record is to turn off automatic payment (will
4338 return without error.) Will replace existing records in which the only difference
4339 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4340 Fields marked as preserved are optional, and existing values will not be overwritten with
4341 blanks when replacing.
4343 Accepts the following named parameters:
4353 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4357 optional, set higher than 1 for secondary, etc.
4365 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4373 optional, will be preserved when replacing
4381 CARD only, required, FS::cust_location object
4383 =item paystart_month
4385 CARD only, optional, will be preserved when replacing
4389 CARD only, optional, will be preserved when replacing
4393 CARD only, optional, will be preserved when replacing
4397 CARD only, only used if conf cvv-save is set appropriately
4411 #The code for this option is in place, but it's not currently used
4415 # existing cust_payby object to be replaced (must match custnum)
4417 # stateid/stateid_state/ss are not currently supported in cust_payby,
4418 # might not even work properly in 4.x, but will need to work here if ever added
4420 sub save_cust_payby {
4424 my $old = $opt{'replace'};
4425 my $new = new FS::cust_payby { $old ? $old->hash : () };
4426 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4427 $new->set( 'custnum' => $self->custnum );
4429 my $payby = $opt{'payment_payby'};
4430 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4432 # don't allow turning off auto when replacing
4433 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4435 my @check_existing; # payby relevant to this payment_payby
4437 # set payby based on auto
4438 if ( $payby eq 'CARD' ) {
4439 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4440 @check_existing = qw( CARD DCRD );
4441 } elsif ( $payby eq 'CHEK' ) {
4442 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4443 @check_existing = qw( CHEK DCHK );
4446 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4449 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4450 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4451 $new->set( 'payname' => $opt{'payname'} );
4452 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4454 my $conf = new FS::Conf;
4456 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4457 if ( $payby eq 'CARD' &&
4458 ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4459 || $conf->exists('business-onlinepayment-verification')
4462 $new->set( 'paycvv' => $opt{'paycvv'} );
4464 $new->set( 'paycvv' => '');
4467 local $SIG{HUP} = 'IGNORE';
4468 local $SIG{INT} = 'IGNORE';
4469 local $SIG{QUIT} = 'IGNORE';
4470 local $SIG{TERM} = 'IGNORE';
4471 local $SIG{TSTP} = 'IGNORE';
4472 local $SIG{PIPE} = 'IGNORE';
4474 my $oldAutoCommit = $FS::UID::AutoCommit;
4475 local $FS::UID::AutoCommit = 0;
4478 # set fields specific to payment_payby
4479 if ( $payby eq 'CARD' ) {
4480 if ($opt{'bill_location'}) {
4481 $opt{'bill_location'}->set('custnum' => $self->custnum);
4482 my $error = $opt{'bill_location'}->find_or_insert;
4484 $dbh->rollback if $oldAutoCommit;
4487 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4489 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4490 $new->set( $field => $opt{$field} );
4493 foreach my $field ( qw(paytype paystate) ) {
4494 $new->set( $field => $opt{$field} );
4498 # other cust_payby to compare this to
4499 my @existing = $self->cust_payby(@check_existing);
4501 # fields that can overwrite blanks with values, but not values with blanks
4502 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4504 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4506 # generally, we don't want to overwrite existing cust_payby with this,
4507 # but we can replace if we're only marking it auto or adding a preserved field
4508 # and we can avoid saving a total duplicate or merely turning off auto
4510 foreach my $cust_payby (@existing) {
4511 # check fields that absolutely should not change
4512 foreach my $field ($new->fields) {
4513 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4514 next if grep(/^$field$/, @preserve );
4515 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4517 # now check fields that can replace if one value is blank
4519 foreach my $field (@preserve) {
4521 ( $new->get($field) and !$cust_payby->get($field) ) or
4522 ( $cust_payby->get($field) and !$new->get($field) )
4524 # prevention of overwriting values with blanks happens farther below
4526 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4530 unless ( $replace ) {
4531 # nearly identical, now check weight
4532 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4533 # ignore identical cust_payby, and ignore attempts to turn off auto
4534 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4535 $skip_cust_payby = 1;
4538 # otherwise, only change is to mark this as primary
4540 # if we got this far, we're definitely replacing
4547 $new->set( 'custpaybynum' => $old->custpaybynum );
4548 # don't turn off automatic payment (but allow it to be turned on)
4549 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4551 $new->set( 'payby' => $old->payby );
4552 $new->set( 'weight' => 1 );
4554 # make sure we're not overwriting values with blanks
4555 foreach my $field (@preserve) {
4556 if ( $old->get($field) and !$new->get($field) ) {
4557 $new->set( $field => $old->get($field) );
4562 # only overwrite cust_main bill_location if auto
4563 if ($opt{'auto'} && $opt{'bill_location'}) {
4564 $self->set('bill_location' => $opt{'bill_location'});
4565 my $error = $self->replace;
4567 $dbh->rollback if $oldAutoCommit;
4572 # done with everything except reweighting and saving cust_payby
4573 # still need to commit changes to cust_main and cust_location
4574 if ($skip_cust_payby) {
4575 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4579 # re-weight existing primary cust_pay for this payby
4581 foreach my $cust_payby (@existing) {
4582 # relies on cust_payby return order
4583 last unless $cust_payby->payby !~ /^D/;
4584 last if $cust_payby->weight > 1;
4585 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4586 next if $cust_payby->weight < ($opt{'weight'} || 1);
4587 $cust_payby->weight( $cust_payby->weight + 1 );
4588 my $error = $cust_payby->replace;
4590 $dbh->rollback if $oldAutoCommit;
4591 return "Error reweighting cust_payby: $error";
4596 # finally, save cust_payby
4597 my $error = $old ? $new->replace($old) : $new->insert;
4599 $dbh->rollback if $oldAutoCommit;
4603 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4608 =item remove_cvv_from_cust_payby PAYINFO
4610 Removes paycvv from associated cust_payby with matching PAYINFO.
4614 sub remove_cvv_from_cust_payby {
4615 my ($self,$payinfo) = @_;
4617 my $oldAutoCommit = $FS::UID::AutoCommit;
4618 local $FS::UID::AutoCommit = 0;
4621 foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
4622 next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
4623 $cust_payby->paycvv('');
4624 my $error = $cust_payby->replace;
4626 $dbh->rollback if $oldAutoCommit;
4631 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4637 =head1 CLASS METHODS
4643 Class method that returns the list of possible status strings for customers
4644 (see L<the status method|/status>). For example:
4646 @statuses = FS::cust_main->statuses();
4652 keys %{ $self->statuscolors };
4655 =item cust_status_sql
4657 Returns an SQL fragment to determine the status of a cust_main record, as a
4662 sub cust_status_sql {
4664 for my $status ( FS::cust_main->statuses() ) {
4665 my $method = $status.'_sql';
4666 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4675 Returns an SQL expression identifying prospective cust_main records (customers
4676 with no packages ever ordered)
4680 use vars qw($select_count_pkgs);
4681 $select_count_pkgs =
4682 "SELECT COUNT(*) FROM cust_pkg
4683 WHERE cust_pkg.custnum = cust_main.custnum";
4685 sub select_count_pkgs_sql {
4690 " 0 = ( $select_count_pkgs ) ";
4695 Returns an SQL expression identifying ordered cust_main records (customers with
4696 no active packages, but recurring packages not yet setup or one time charges
4702 FS::cust_main->none_active_sql.
4703 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4708 Returns an SQL expression identifying active cust_main records (customers with
4709 active recurring packages).
4714 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4717 =item none_active_sql
4719 Returns an SQL expression identifying cust_main records with no active
4720 recurring packages. This includes customers of status prospect, ordered,
4721 inactive, and suspended.
4725 sub none_active_sql {
4726 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4731 Returns an SQL expression identifying inactive cust_main records (customers with
4732 no active recurring packages, but otherwise unsuspended/uncancelled).
4737 FS::cust_main->none_active_sql.
4738 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4744 Returns an SQL expression identifying suspended cust_main records.
4749 sub suspended_sql { susp_sql(@_); }
4751 FS::cust_main->none_active_sql.
4752 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4758 Returns an SQL expression identifying cancelled cust_main records.
4762 sub cancel_sql { shift->cancelled_sql(@_); }
4765 =item uncancelled_sql
4767 Returns an SQL expression identifying un-cancelled cust_main records.
4771 sub uncancelled_sql { uncancel_sql(@_); }
4772 sub uncancel_sql { "
4773 ( 0 < ( $select_count_pkgs
4774 AND ( cust_pkg.cancel IS NULL
4775 OR cust_pkg.cancel = 0
4778 OR 0 = ( $select_count_pkgs )
4784 Returns an SQL fragment to retreive the balance.
4789 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4790 WHERE cust_bill.custnum = cust_main.custnum )
4791 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4792 WHERE cust_pay.custnum = cust_main.custnum )
4793 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4794 WHERE cust_credit.custnum = cust_main.custnum )
4795 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4796 WHERE cust_refund.custnum = cust_main.custnum )
4799 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4801 Returns an SQL fragment to retreive the balance for this customer, optionally
4802 considering invoices with date earlier than START_TIME, and not
4803 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4804 total_unapplied_payments).
4806 Times are specified as SQL fragments or numeric
4807 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4808 L<Date::Parse> for conversion functions. The empty string can be passed
4809 to disable that time constraint completely.
4811 Available options are:
4815 =item unapplied_date
4817 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)
4822 set to true to remove all customer comparison clauses, for totals
4827 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4832 JOIN clause (typically used with the total option)
4836 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4837 time will be ignored. Note that START_TIME and END_TIME only limit the date
4838 range for invoices and I<unapplied> payments, credits, and refunds.
4844 sub balance_date_sql {
4845 my( $class, $start, $end, %opt ) = @_;
4847 my $cutoff = $opt{'cutoff'};
4849 my $owed = FS::cust_bill->owed_sql($cutoff);
4850 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4851 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4852 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4854 my $j = $opt{'join'} || '';
4856 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4857 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4858 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4859 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4861 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4862 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4863 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4864 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4869 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4871 Returns an SQL fragment to retreive the total unapplied payments for this
4872 customer, only considering payments with date earlier than START_TIME, and
4873 optionally not later than END_TIME.
4875 Times are specified as SQL fragments or numeric
4876 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4877 L<Date::Parse> for conversion functions. The empty string can be passed
4878 to disable that time constraint completely.
4880 Available options are:
4884 sub unapplied_payments_date_sql {
4885 my( $class, $start, $end, %opt ) = @_;
4887 my $cutoff = $opt{'cutoff'};
4889 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4891 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4892 'unapplied_date'=>1 );
4894 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4897 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4899 Helper method for balance_date_sql; name (and usage) subject to change
4900 (suggestions welcome).
4902 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4903 cust_refund, cust_credit or cust_pay).
4905 If TABLE is "cust_bill" or the unapplied_date option is true, only
4906 considers records with date earlier than START_TIME, and optionally not
4907 later than END_TIME .
4911 sub _money_table_where {
4912 my( $class, $table, $start, $end, %opt ) = @_;
4915 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4916 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4917 push @where, "$table._date <= $start" if defined($start) && length($start);
4918 push @where, "$table._date > $end" if defined($end) && length($end);
4920 push @where, @{$opt{'where'}} if $opt{'where'};
4921 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4927 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4928 use FS::cust_main::Search;
4931 FS::cust_main::Search->search(@_);
4940 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4942 Generates a templated notification to the customer (see L<Text::Template>).
4944 OPTIONS is a hash and may include
4946 I<extra_fields> - a hashref of name/value pairs which will be substituted
4947 into the template. These values may override values mentioned below
4948 and those from the customer record.
4950 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
4952 The following variables are available in the template instead of or in addition
4953 to the fields of the customer record.
4955 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4959 # a lot like cust_bill::print_latex
4960 sub generate_letter {
4961 my ($self, $template, %options) = @_;
4963 warn "Template $template does not exist" && return
4964 unless $conf->exists($template) || $options{'template_text'};
4966 my $template_source = $options{'template_text'}
4967 ? [ $options{'template_text'} ]
4968 : [ map "$_\n", $conf->config($template) ];
4970 my $letter_template = new Text::Template
4972 SOURCE => $template_source,
4973 DELIMITERS => [ '[@--', '--@]' ],
4975 or die "can't create new Text::Template object: Text::Template::ERROR";
4977 $letter_template->compile()
4978 or die "can't compile template: Text::Template::ERROR";
4980 my %letter_data = map { $_ => $self->$_ } $self->fields;
4982 for (keys %{$options{extra_fields}}){
4983 $letter_data{$_} = $options{extra_fields}->{$_};
4986 unless(exists($letter_data{returnaddress})){
4987 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4988 $self->agent_template)
4990 if ( length($retadd) ) {
4991 $letter_data{returnaddress} = $retadd;
4992 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4993 $letter_data{returnaddress} =
4994 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4998 ( $conf->config('company_name', $self->agentnum),
4999 $conf->config('company_address', $self->agentnum),
5003 $letter_data{returnaddress} = '~';
5007 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5009 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5011 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5013 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5017 ) or die "can't open temp file: $!\n";
5018 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5019 or die "can't write temp file: $!\n";
5021 $letter_data{'logo_file'} = $lh->filename;
5023 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5027 ) or die "can't open temp file: $!\n";
5029 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5031 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5032 return ($1, $letter_data{'logo_file'});
5036 =item print_ps TEMPLATE
5038 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5044 my($file, $lfile) = $self->generate_letter(@_);
5045 my $ps = FS::Misc::generate_ps($file);
5046 unlink($file.'.tex');
5052 =item print TEMPLATE
5054 Prints the filled in template.
5056 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5060 sub queueable_print {
5063 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5064 or die "invalid customer number: " . $opt{custnum};
5066 #do not backport this change to 3.x
5067 # my $error = $self->print( { 'template' => $opt{template} } );
5068 my $error = $self->print( $opt{'template'} );
5069 die $error if $error;
5073 my ($self, $template) = (shift, shift);
5075 [ $self->print_ps($template) ],
5076 'agentnum' => $self->agentnum,
5080 #these three subs should just go away once agent stuff is all config overrides
5082 sub agent_template {
5084 $self->_agent_plandata('agent_templatename');
5087 sub agent_invoice_from {
5089 $self->_agent_plandata('agent_invoice_from');
5092 sub _agent_plandata {
5093 my( $self, $option ) = @_;
5095 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5096 #agent-specific Conf
5098 use FS::part_event::Condition;
5100 my $agentnum = $self->agentnum;
5102 my $regexp = regexp_sql();
5104 my $part_event_option =
5106 'select' => 'part_event_option.*',
5107 'table' => 'part_event_option',
5109 LEFT JOIN part_event USING ( eventpart )
5110 LEFT JOIN part_event_option AS peo_agentnum
5111 ON ( part_event.eventpart = peo_agentnum.eventpart
5112 AND peo_agentnum.optionname = 'agentnum'
5113 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5115 LEFT JOIN part_event_condition
5116 ON ( part_event.eventpart = part_event_condition.eventpart
5117 AND part_event_condition.conditionname = 'cust_bill_age'
5119 LEFT JOIN part_event_condition_option
5120 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5121 AND part_event_condition_option.optionname = 'age'
5124 #'hashref' => { 'optionname' => $option },
5125 #'hashref' => { 'part_event_option.optionname' => $option },
5127 " WHERE part_event_option.optionname = ". dbh->quote($option).
5128 " AND action = 'cust_bill_send_agent' ".
5129 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5130 " AND peo_agentnum.optionname = 'agentnum' ".
5131 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5133 CASE WHEN part_event_condition_option.optionname IS NULL
5135 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5137 , part_event.weight".
5141 unless ( $part_event_option ) {
5142 return $self->agent->invoice_template || ''
5143 if $option eq 'agent_templatename';
5147 $part_event_option->optionvalue;
5151 sub process_o2m_qsearch {
5154 return qsearch($table, @_) unless $table eq 'contact';
5156 my $hashref = shift;
5157 my %hash = %$hashref;
5158 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5159 or die 'guru meditation #4343';
5161 qsearch({ 'table' => 'contact',
5162 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5163 'hashref' => \%hash,
5164 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5165 " cust_contact.custnum = $custnum "
5169 sub process_o2m_qsearchs {
5172 return qsearchs($table, @_) unless $table eq 'contact';
5174 my $hashref = shift;
5175 my %hash = %$hashref;
5176 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5177 or die 'guru meditation #2121';
5179 qsearchs({ 'table' => 'contact',
5180 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5181 'hashref' => \%hash,
5182 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5183 " cust_contact.custnum = $custnum "
5187 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5189 Subroutine (not a method), designed to be called from the queue.
5191 Takes a list of options and values.
5193 Pulls up the customer record via the custnum option and calls bill_and_collect.
5198 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5200 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5201 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5203 #without this errors don't get rolled back
5204 $args{'fatal'} = 1; # runs from job queue, will be caught
5206 $cust_main->bill_and_collect( %args );
5209 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5211 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5212 C<collect> part. This is used in batch tax calculation, where invoice
5213 generation and collection events have to be completely separated.
5217 sub queued_collect {
5219 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5221 $cust_main->collect(%args);
5224 sub process_bill_and_collect {
5227 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5228 or die "custnum '$param->{custnum}' not found!\n";
5229 $param->{'job'} = $job;
5230 $param->{'fatal'} = 1; # runs from job queue, will be caught
5231 $param->{'retry'} = 1;
5233 $cust_main->bill_and_collect( %$param );
5236 #starting to take quite a while for big dbs
5237 # (JRNL: journaled so it only happens once per database)
5238 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5239 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5240 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5241 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5242 # JRNL leading/trailing spaces in first, last, company
5243 # JRNL migrate to cust_payby
5244 # - otaker upgrade? journal and call it good? (double check to make sure
5245 # we're not still setting otaker here)
5247 #only going to get worse with new location stuff...
5249 sub _upgrade_data { #class method
5250 my ($class, %opts) = @_;
5252 my @statements = ();
5254 #this seems to be the only expensive one.. why does it take so long?
5255 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5257 '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';
5258 FS::upgrade_journal->set_done('cust_main__signupdate');
5262 foreach my $sql ( @statements ) {
5263 my $sth = dbh->prepare($sql) or die dbh->errstr;
5264 $sth->execute or die $sth->errstr;
5265 #warn ( (time - $t). " seconds\n" );
5269 local($ignore_expired_card) = 1;
5270 local($ignore_banned_card) = 1;
5271 local($skip_fuzzyfiles) = 1;
5272 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5274 FS::cust_main::Location->_upgrade_data(%opts);
5276 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5278 foreach my $cust_main ( qsearch({
5279 'table' => 'cust_main',
5281 'extra_sql' => 'WHERE '.
5283 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5284 qw( first last company )
5287 my $error = $cust_main->replace;
5288 die $error if $error;
5291 FS::upgrade_journal->set_done('cust_main__trimspaces');
5295 $class->_upgrade_otaker(%opts);
5305 The delete method should possibly take an FS::cust_main object reference
5306 instead of a scalar customer number.
5308 Bill and collect options should probably be passed as references instead of a
5311 There should probably be a configuration file with a list of allowed credit
5314 No multiple currency support (probably a larger project than just this module).
5316 Birthdates rely on negative epoch values.
5318 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5322 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5323 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5324 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.