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;
561 warn " setting contacts\n"
564 $invoicing_list ||= $options{'invoicing_list'};
565 if ( $invoicing_list ) {
567 $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
570 foreach my $dest (@$invoicing_list ) {
571 if ($dest eq 'POST') {
572 $self->set('postal_invoice', 'Y');
575 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
576 if ( $contact_email ) {
577 my $cust_contact = FS::cust_contact->new({
578 contactnum => $contact_email->contactnum,
579 custnum => $self->custnum,
581 $cust_contact->set('invoice_dest', 'Y');
582 my $error = $cust_contact->contactnum ?
583 $cust_contact->replace : $cust_contact->insert;
585 $dbh->rollback if $oldAutoCommit;
586 return "$error (linking to email address $dest)";
590 # this email address is not yet linked to any contact
591 $email .= ',' if length($email);
597 my $contact = FS::contact->new({
598 'custnum' => $self->get('custnum'),
599 'last' => $self->get('last'),
600 'first' => $self->get('first'),
601 'emailaddress' => $email,
602 'invoice_dest' => 'Y', # yes, you can set this via the contact
604 my $error = $contact->insert;
606 $dbh->rollback if $oldAutoCommit;
612 if ( my $contact = delete $options{'contact'} ) {
614 foreach my $c ( @$contact ) {
615 $c->custnum($self->custnum);
616 my $error = $c->insert;
618 $dbh->rollback if $oldAutoCommit;
624 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
626 my $error = $self->process_o2m( 'table' => 'contact',
627 'fields' => FS::contact->cgi_contact_fields,
628 'params' => $contact_params,
631 $dbh->rollback if $oldAutoCommit;
636 warn " setting cust_payby\n"
639 if ( $options{cust_payby} ) {
641 foreach my $cust_payby ( @{ $options{cust_payby} } ) {
642 $cust_payby->custnum($self->custnum);
643 my $error = $cust_payby->insert;
645 $dbh->rollback if $oldAutoCommit;
650 } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
652 my $error = $self->process_o2m(
653 'table' => 'cust_payby',
654 'fields' => FS::cust_payby->cgi_cust_payby_fields,
655 'params' => $cust_payby_params,
656 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
659 $dbh->rollback if $oldAutoCommit;
665 warn " setting cust_main_exemption\n"
668 my $tax_exemption = delete $options{'tax_exemption'};
669 if ( $tax_exemption ) {
671 $tax_exemption = { map { $_ => '' } @$tax_exemption }
672 if ref($tax_exemption) eq 'ARRAY';
674 foreach my $taxname ( keys %$tax_exemption ) {
675 my $cust_main_exemption = new FS::cust_main_exemption {
676 'custnum' => $self->custnum,
677 'taxname' => $taxname,
678 'exempt_number' => $tax_exemption->{$taxname},
680 my $error = $cust_main_exemption->insert;
682 $dbh->rollback if $oldAutoCommit;
683 return "inserting cust_main_exemption (transaction rolled back): $error";
688 warn " ordering packages\n"
691 $error = $self->order_pkgs( $cust_pkgs,
693 'seconds_ref' => \$seconds,
694 'upbytes_ref' => \$upbytes,
695 'downbytes_ref' => \$downbytes,
696 'totalbytes_ref' => \$totalbytes,
699 $dbh->rollback if $oldAutoCommit;
704 $dbh->rollback if $oldAutoCommit;
705 return "No svc_acct record to apply pre-paid time";
707 if ( $upbytes || $downbytes || $totalbytes ) {
708 $dbh->rollback if $oldAutoCommit;
709 return "No svc_acct record to apply pre-paid data";
713 warn " inserting initial $payby payment of $amount\n"
715 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
717 $dbh->rollback if $oldAutoCommit;
718 return "inserting payment (transaction rolled back): $error";
722 unless ( $import || $skip_fuzzyfiles ) {
723 warn " queueing fuzzyfiles update\n"
725 $error = $self->queue_fuzzyfiles_update;
727 $dbh->rollback if $oldAutoCommit;
728 return "updating fuzzy search cache: $error";
732 # FS::geocode_Mixin::after_insert or something?
733 if ( $conf->config('tax_district_method') and !$import ) {
734 # if anything non-empty, try to look it up
735 my $queue = new FS::queue {
736 'job' => 'FS::geocode_Mixin::process_district_update',
737 'custnum' => $self->custnum,
739 my $error = $queue->insert( ref($self), $self->custnum );
741 $dbh->rollback if $oldAutoCommit;
742 return "queueing tax district update: $error";
747 warn " exporting\n" if $DEBUG > 1;
749 my $export_args = $options{'export_args'} || [];
752 map qsearch( 'part_export', {exportnum=>$_} ),
753 $conf->config('cust_main-exports'); #, $agentnum
755 foreach my $part_export ( @part_export ) {
756 my $error = $part_export->export_insert($self, @$export_args);
758 $dbh->rollback if $oldAutoCommit;
759 return "exporting to ". $part_export->exporttype.
760 " (transaction rolled back): $error";
764 #foreach my $depend_jobnum ( @$depend_jobnums ) {
765 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
767 # foreach my $jobnum ( @jobnums ) {
768 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
769 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
771 # my $error = $queue->depend_insert($depend_jobnum);
773 # $dbh->rollback if $oldAutoCommit;
774 # return "error queuing job dependancy: $error";
781 #if ( exists $options{'jobnums'} ) {
782 # push @{ $options{'jobnums'} }, @jobnums;
785 warn " insert complete; committing transaction\n"
788 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
793 use File::CounterFile;
794 sub auto_agent_custid {
797 my $format = $conf->config('cust_main-auto_agent_custid');
799 if ( $format eq '1YMMXXXXXXXX' ) {
801 my $counter = new File::CounterFile 'cust_main.agent_custid';
804 my $ym = 100000000000 + time2str('%y%m00000000', time);
805 if ( $ym > $counter->value ) {
806 $counter->{'value'} = $agent_custid = $ym;
807 $counter->{'updated'} = 1;
809 $agent_custid = $counter->inc;
815 die "Unknown cust_main-auto_agent_custid format: $format";
818 $self->agent_custid($agent_custid);
822 =item PACKAGE METHODS
824 Documentation on customer package methods has been moved to
825 L<FS::cust_main::Packages>.
827 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
829 Recharges this (existing) customer with the specified prepaid card (see
830 L<FS::prepay_credit>), specified either by I<identifier> or as an
831 FS::prepay_credit object. If there is an error, returns the error, otherwise
834 Optionally, five scalar references can be passed as well. They will have their
835 values filled in with the amount, number of seconds, and number of upload,
836 download, and total bytes applied by this prepaid card.
840 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
841 #the only place that uses these args
842 sub recharge_prepay {
843 my( $self, $prepay_credit, $amountref, $secondsref,
844 $upbytesref, $downbytesref, $totalbytesref ) = @_;
846 local $SIG{HUP} = 'IGNORE';
847 local $SIG{INT} = 'IGNORE';
848 local $SIG{QUIT} = 'IGNORE';
849 local $SIG{TERM} = 'IGNORE';
850 local $SIG{TSTP} = 'IGNORE';
851 local $SIG{PIPE} = 'IGNORE';
853 my $oldAutoCommit = $FS::UID::AutoCommit;
854 local $FS::UID::AutoCommit = 0;
857 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
859 my $error = $self->get_prepay( $prepay_credit,
860 'amount_ref' => \$amount,
861 'seconds_ref' => \$seconds,
862 'upbytes_ref' => \$upbytes,
863 'downbytes_ref' => \$downbytes,
864 'totalbytes_ref' => \$totalbytes,
866 || $self->increment_seconds($seconds)
867 || $self->increment_upbytes($upbytes)
868 || $self->increment_downbytes($downbytes)
869 || $self->increment_totalbytes($totalbytes)
870 || $self->insert_cust_pay_prepay( $amount,
872 ? $prepay_credit->identifier
877 $dbh->rollback if $oldAutoCommit;
881 if ( defined($amountref) ) { $$amountref = $amount; }
882 if ( defined($secondsref) ) { $$secondsref = $seconds; }
883 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
884 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
885 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
887 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
892 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
894 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
895 specified either by I<identifier> or as an FS::prepay_credit object.
897 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
898 incremented by the values of the prepaid card.
900 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
901 check or set this customer's I<agentnum>.
903 If there is an error, returns the error, otherwise returns false.
909 my( $self, $prepay_credit, %opt ) = @_;
911 local $SIG{HUP} = 'IGNORE';
912 local $SIG{INT} = 'IGNORE';
913 local $SIG{QUIT} = 'IGNORE';
914 local $SIG{TERM} = 'IGNORE';
915 local $SIG{TSTP} = 'IGNORE';
916 local $SIG{PIPE} = 'IGNORE';
918 my $oldAutoCommit = $FS::UID::AutoCommit;
919 local $FS::UID::AutoCommit = 0;
922 unless ( ref($prepay_credit) ) {
924 my $identifier = $prepay_credit;
926 $prepay_credit = qsearchs(
928 { 'identifier' => $identifier },
933 unless ( $prepay_credit ) {
934 $dbh->rollback if $oldAutoCommit;
935 return "Invalid prepaid card: ". $identifier;
940 if ( $prepay_credit->agentnum ) {
941 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
942 $dbh->rollback if $oldAutoCommit;
943 return "prepaid card not valid for agent ". $self->agentnum;
945 $self->agentnum($prepay_credit->agentnum);
948 my $error = $prepay_credit->delete;
950 $dbh->rollback if $oldAutoCommit;
951 return "removing prepay_credit (transaction rolled back): $error";
954 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
955 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
957 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
962 =item increment_upbytes SECONDS
964 Updates this customer's single or primary account (see L<FS::svc_acct>) by
965 the specified number of upbytes. If there is an error, returns the error,
966 otherwise returns false.
970 sub increment_upbytes {
971 _increment_column( shift, 'upbytes', @_);
974 =item increment_downbytes SECONDS
976 Updates this customer's single or primary account (see L<FS::svc_acct>) by
977 the specified number of downbytes. If there is an error, returns the error,
978 otherwise returns false.
982 sub increment_downbytes {
983 _increment_column( shift, 'downbytes', @_);
986 =item increment_totalbytes SECONDS
988 Updates this customer's single or primary account (see L<FS::svc_acct>) by
989 the specified number of totalbytes. If there is an error, returns the error,
990 otherwise returns false.
994 sub increment_totalbytes {
995 _increment_column( shift, 'totalbytes', @_);
998 =item increment_seconds SECONDS
1000 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1001 the specified number of seconds. If there is an error, returns the error,
1002 otherwise returns false.
1006 sub increment_seconds {
1007 _increment_column( shift, 'seconds', @_);
1010 =item _increment_column AMOUNT
1012 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1013 the specified number of seconds or bytes. If there is an error, returns
1014 the error, otherwise returns false.
1018 sub _increment_column {
1019 my( $self, $column, $amount ) = @_;
1020 warn "$me increment_column called: $column, $amount\n"
1023 return '' unless $amount;
1025 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1026 $self->ncancelled_pkgs;
1028 if ( ! @cust_pkg ) {
1029 return 'No packages with primary or single services found'.
1030 ' to apply pre-paid time';
1031 } elsif ( scalar(@cust_pkg) > 1 ) {
1032 #maybe have a way to specify the package/account?
1033 return 'Multiple packages found to apply pre-paid time';
1036 my $cust_pkg = $cust_pkg[0];
1037 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1041 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1043 if ( ! @cust_svc ) {
1044 return 'No account found to apply pre-paid time';
1045 } elsif ( scalar(@cust_svc) > 1 ) {
1046 return 'Multiple accounts found to apply pre-paid time';
1049 my $svc_acct = $cust_svc[0]->svc_x;
1050 warn " found service svcnum ". $svc_acct->pkgnum.
1051 ' ('. $svc_acct->email. ")\n"
1054 $column = "increment_$column";
1055 $svc_acct->$column($amount);
1059 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1061 Inserts a prepayment in the specified amount for this customer. An optional
1062 second argument can specify the prepayment identifier for tracking purposes.
1063 If there is an error, returns the error, otherwise returns false.
1067 sub insert_cust_pay_prepay {
1068 shift->insert_cust_pay('PREP', @_);
1071 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1073 Inserts a cash payment in the specified amount for this customer. An optional
1074 second argument can specify the payment identifier for tracking purposes.
1075 If there is an error, returns the error, otherwise returns false.
1079 sub insert_cust_pay_cash {
1080 shift->insert_cust_pay('CASH', @_);
1083 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1085 Inserts a Western Union payment in the specified amount for this customer. An
1086 optional second argument can specify the prepayment identifier for tracking
1087 purposes. If there is an error, returns the error, otherwise returns false.
1091 sub insert_cust_pay_west {
1092 shift->insert_cust_pay('WEST', @_);
1095 sub insert_cust_pay {
1096 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1097 my $payinfo = scalar(@_) ? shift : '';
1099 my $cust_pay = new FS::cust_pay {
1100 'custnum' => $self->custnum,
1101 'paid' => sprintf('%.2f', $amount),
1102 #'_date' => #date the prepaid card was purchased???
1104 'payinfo' => $payinfo,
1110 =item delete [ OPTION => VALUE ... ]
1112 This deletes the customer. If there is an error, returns the error, otherwise
1115 This will completely remove all traces of the customer record. This is not
1116 what you want when a customer cancels service; for that, cancel all of the
1117 customer's packages (see L</cancel>).
1119 If the customer has any uncancelled packages, you need to pass a new (valid)
1120 customer number for those packages to be transferred to, as the "new_customer"
1121 option. Cancelled packages will be deleted. Did I mention that this is NOT
1122 what you want when a customer cancels service and that you really should be
1123 looking at L<FS::cust_pkg/cancel>?
1125 You can't delete a customer with invoices (see L<FS::cust_bill>),
1126 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1127 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1128 set the "delete_financials" option to a true value.
1133 my( $self, %opt ) = @_;
1135 local $SIG{HUP} = 'IGNORE';
1136 local $SIG{INT} = 'IGNORE';
1137 local $SIG{QUIT} = 'IGNORE';
1138 local $SIG{TERM} = 'IGNORE';
1139 local $SIG{TSTP} = 'IGNORE';
1140 local $SIG{PIPE} = 'IGNORE';
1142 my $oldAutoCommit = $FS::UID::AutoCommit;
1143 local $FS::UID::AutoCommit = 0;
1146 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1147 $dbh->rollback if $oldAutoCommit;
1148 return "Can't delete a master agent customer";
1151 #use FS::access_user
1152 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1153 $dbh->rollback if $oldAutoCommit;
1154 return "Can't delete a master employee customer";
1157 tie my %financial_tables, 'Tie::IxHash',
1158 'cust_bill' => 'invoices',
1159 'cust_statement' => 'statements',
1160 'cust_credit' => 'credits',
1161 'cust_pay' => 'payments',
1162 'cust_refund' => 'refunds',
1165 foreach my $table ( keys %financial_tables ) {
1167 my @records = $self->$table();
1169 if ( @records && ! $opt{'delete_financials'} ) {
1170 $dbh->rollback if $oldAutoCommit;
1171 return "Can't delete a customer with ". $financial_tables{$table};
1174 foreach my $record ( @records ) {
1175 my $error = $record->delete;
1177 $dbh->rollback if $oldAutoCommit;
1178 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1184 my @cust_pkg = $self->ncancelled_pkgs;
1186 my $new_custnum = $opt{'new_custnum'};
1187 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1188 $dbh->rollback if $oldAutoCommit;
1189 return "Invalid new customer number: $new_custnum";
1191 foreach my $cust_pkg ( @cust_pkg ) {
1192 my %hash = $cust_pkg->hash;
1193 $hash{'custnum'} = $new_custnum;
1194 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1195 my $error = $new_cust_pkg->replace($cust_pkg,
1196 options => { $cust_pkg->options },
1199 $dbh->rollback if $oldAutoCommit;
1204 my @cancelled_cust_pkg = $self->all_pkgs;
1205 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1206 my $error = $cust_pkg->delete;
1208 $dbh->rollback if $oldAutoCommit;
1213 #cust_tax_adjustment in financials?
1214 #cust_pay_pending? ouch
1215 foreach my $table (qw(
1216 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1217 cust_payby cust_location cust_main_note cust_tax_adjustment
1218 cust_pay_void cust_pay_batch queue cust_tax_exempt
1220 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1221 my $error = $record->delete;
1223 $dbh->rollback if $oldAutoCommit;
1229 my $sth = $dbh->prepare(
1230 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1232 my $errstr = $dbh->errstr;
1233 $dbh->rollback if $oldAutoCommit;
1236 $sth->execute($self->custnum) or do {
1237 my $errstr = $sth->errstr;
1238 $dbh->rollback if $oldAutoCommit;
1244 my $ticket_dbh = '';
1245 if ($conf->config('ticket_system') eq 'RT_Internal') {
1247 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1248 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1249 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1250 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1253 if ( $ticket_dbh ) {
1255 my $ticket_sth = $ticket_dbh->prepare(
1256 'DELETE FROM Links WHERE Target = ?'
1258 my $errstr = $ticket_dbh->errstr;
1259 $dbh->rollback if $oldAutoCommit;
1262 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1264 my $errstr = $ticket_sth->errstr;
1265 $dbh->rollback if $oldAutoCommit;
1269 #check and see if the customer is the only link on the ticket, and
1270 #if so, set the ticket to deleted status in RT?
1271 #maybe someday, for now this will at least fix tickets not displaying
1275 #delete the customer record
1277 my $error = $self->SUPER::delete;
1279 $dbh->rollback if $oldAutoCommit;
1283 # cust_main exports!
1285 #my $export_args = $options{'export_args'} || [];
1288 map qsearch( 'part_export', {exportnum=>$_} ),
1289 $conf->config('cust_main-exports'); #, $agentnum
1291 foreach my $part_export ( @part_export ) {
1292 my $error = $part_export->export_delete( $self ); #, @$export_args);
1294 $dbh->rollback if $oldAutoCommit;
1295 return "exporting to ". $part_export->exporttype.
1296 " (transaction rolled back): $error";
1300 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1305 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1307 Replaces the OLD_RECORD with this one in the database. If there is an error,
1308 returns the error, otherwise returns false.
1310 To change the customer's address, set the pseudo-fields C<bill_location> and
1311 C<ship_location>. The address will still only change if at least one of the
1312 address fields differs from the existing values.
1314 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1315 set as the contact email address for a default contact with the same name as
1318 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1319 I<contact_params>, I<invoicing_list>.
1321 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1322 of tax names and exemption numbers. FS::cust_main_exemption records will be
1323 deleted and inserted as appropriate.
1325 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1326 groups (describing the customer's payment methods and contacts, respectively)
1327 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1328 and L<FS::contact> for the fields these can contain.
1330 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1331 should be used instead if possible.
1338 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1340 : $self->replace_old;
1344 warn "$me replace called\n"
1347 my $curuser = $FS::CurrentUser::CurrentUser;
1348 return "You are not permitted to create complimentary accounts."
1349 if $self->complimentary eq 'Y'
1350 && $self->complimentary ne $old->complimentary
1351 && ! $curuser->access_right('Complimentary customer');
1353 local($ignore_expired_card) = 1
1354 if $old->payby =~ /^(CARD|DCRD)$/
1355 && $self->payby =~ /^(CARD|DCRD)$/
1356 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1358 local($ignore_banned_card) = 1
1359 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1360 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1361 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1363 if ( $self->payby =~ /^(CARD|DCRD)$/
1364 && $old->payinfo ne $self->payinfo
1365 && $old->paymask ne $self->paymask )
1367 my $error = $self->check_payinfo_cardtype;
1368 return $error if $error;
1371 return "Invoicing locale is required"
1374 && $conf->exists('cust_main-require_locale');
1376 local $SIG{HUP} = 'IGNORE';
1377 local $SIG{INT} = 'IGNORE';
1378 local $SIG{QUIT} = 'IGNORE';
1379 local $SIG{TERM} = 'IGNORE';
1380 local $SIG{TSTP} = 'IGNORE';
1381 local $SIG{PIPE} = 'IGNORE';
1383 my $oldAutoCommit = $FS::UID::AutoCommit;
1384 local $FS::UID::AutoCommit = 0;
1387 for my $l (qw(bill_location ship_location)) {
1388 #my $old_loc = $old->$l;
1389 my $new_loc = $self->$l or next;
1391 # find the existing location if there is one
1392 $new_loc->set('custnum' => $self->custnum);
1393 my $error = $new_loc->find_or_insert;
1395 $dbh->rollback if $oldAutoCommit;
1398 $self->set($l.'num', $new_loc->locationnum);
1402 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1403 warn "cust_main::replace: using deprecated invoicing list argument";
1404 $invoicing_list = shift @param;
1407 my %options = @param;
1409 $invoicing_list ||= $options{invoicing_list};
1411 my @contacts = map { $_->contact } $self->cust_contact;
1412 # find a contact that matches the customer's name
1413 my ($implicit_contact) = grep { $_->first eq $old->get('first')
1414 and $_->last eq $old->get('last') }
1416 $implicit_contact ||= FS::contact->new({
1417 'custnum' => $self->custnum,
1418 'locationnum' => $self->get('bill_locationnum'),
1421 # for any of these that are already contact emails, link to the existing
1423 if ( $invoicing_list ) {
1426 # kind of like process_m2m on these, except:
1427 # - the other side is two tables in a join
1428 # - and we might have to create new contact_emails
1429 # - and possibly a new contact
1431 # Find existing invoice emails that aren't on the implicit contact.
1432 # Any of these that are not on the new invoicing list will be removed.
1433 my %old_email_cust_contact;
1434 foreach my $cust_contact ($self->cust_contact) {
1435 next if !$cust_contact->invoice_dest;
1436 next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1438 foreach my $contact_email ($cust_contact->contact->contact_email) {
1439 $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1443 foreach my $dest (@$invoicing_list) {
1445 if ($dest eq 'POST') {
1447 $self->set('postal_invoice', 'Y');
1449 } elsif ( exists($old_email_cust_contact{$dest}) ) {
1451 delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1455 # See if it belongs to some other contact; if so, link it.
1456 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1458 and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1459 my $cust_contact = qsearchs('cust_contact', {
1460 contactnum => $contact_email->contactnum,
1461 custnum => $self->custnum,
1462 }) || FS::cust_contact->new({
1463 contactnum => $contact_email->contactnum,
1464 custnum => $self->custnum,
1466 $cust_contact->set('invoice_dest', 'Y');
1467 my $error = $cust_contact->custcontactnum ?
1468 $cust_contact->replace : $cust_contact->insert;
1470 $dbh->rollback if $oldAutoCommit;
1471 return "$error (linking to email address $dest)";
1475 # This email address is not yet linked to any contact, so it will
1476 # be added to the implicit contact.
1477 $email .= ',' if length($email);
1483 foreach my $remove_dest (keys %old_email_cust_contact) {
1484 my $cust_contact = $old_email_cust_contact{$remove_dest};
1485 # These were not in the list of requested destinations, so take them off.
1486 $cust_contact->set('invoice_dest', '');
1487 my $error = $cust_contact->replace;
1489 $dbh->rollback if $oldAutoCommit;
1490 return "$error (unlinking email address $remove_dest)";
1494 # make sure it keeps up with the changed customer name, if any
1495 $implicit_contact->set('last', $self->get('last'));
1496 $implicit_contact->set('first', $self->get('first'));
1497 $implicit_contact->set('emailaddress', $email);
1498 $implicit_contact->set('invoice_dest', 'Y');
1499 $implicit_contact->set('custnum', $self->custnum);
1502 if ( $implicit_contact->contactnum ) {
1503 $error = $implicit_contact->replace;
1504 } elsif ( length($email) ) { # don't create a new contact if not needed
1505 $error = $implicit_contact->insert;
1509 $dbh->rollback if $oldAutoCommit;
1510 return "$error (adding email address $email)";
1515 # replace the customer record
1516 my $error = $self->SUPER::replace($old);
1519 $dbh->rollback if $oldAutoCommit;
1523 # now move packages to the new service location
1524 $self->set('ship_location', ''); #flush cache
1525 if ( $old->ship_locationnum and # should only be null during upgrade...
1526 $old->ship_locationnum != $self->ship_locationnum ) {
1527 $error = $old->ship_location->move_to($self->ship_location);
1529 $dbh->rollback if $oldAutoCommit;
1533 # don't move packages based on the billing location, but
1534 # disable it if it's no longer in use
1535 if ( $old->bill_locationnum and
1536 $old->bill_locationnum != $self->bill_locationnum ) {
1537 $error = $old->bill_location->disable_if_unused;
1539 $dbh->rollback if $oldAutoCommit;
1544 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1546 #this could be more efficient than deleting and re-inserting, if it matters
1547 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1548 my $error = $cust_tag->delete;
1550 $dbh->rollback if $oldAutoCommit;
1554 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1555 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1556 'custnum' => $self->custnum };
1557 my $error = $cust_tag->insert;
1559 $dbh->rollback if $oldAutoCommit;
1566 my $tax_exemption = delete $options{'tax_exemption'};
1567 if ( $tax_exemption ) {
1569 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1570 if ref($tax_exemption) eq 'ARRAY';
1572 my %cust_main_exemption =
1573 map { $_->taxname => $_ }
1574 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1576 foreach my $taxname ( keys %$tax_exemption ) {
1578 if ( $cust_main_exemption{$taxname} &&
1579 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1582 delete $cust_main_exemption{$taxname};
1586 my $cust_main_exemption = new FS::cust_main_exemption {
1587 'custnum' => $self->custnum,
1588 'taxname' => $taxname,
1589 'exempt_number' => $tax_exemption->{$taxname},
1591 my $error = $cust_main_exemption->insert;
1593 $dbh->rollback if $oldAutoCommit;
1594 return "inserting cust_main_exemption (transaction rolled back): $error";
1598 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1599 my $error = $cust_main_exemption->delete;
1601 $dbh->rollback if $oldAutoCommit;
1602 return "deleting cust_main_exemption (transaction rolled back): $error";
1608 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1610 my $error = $self->process_o2m(
1611 'table' => 'cust_payby',
1612 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1613 'params' => $cust_payby_params,
1614 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1617 $dbh->rollback if $oldAutoCommit;
1623 if ( my $contact_params = delete $options{'contact_params'} ) {
1625 # this can potentially replace contacts that were created by the
1626 # invoicing list argument, but the UI shouldn't allow both of them
1629 my $error = $self->process_o2m(
1630 'table' => 'contact',
1631 'fields' => FS::contact->cgi_contact_fields,
1632 'params' => $contact_params,
1635 $dbh->rollback if $oldAutoCommit;
1641 unless ( $import || $skip_fuzzyfiles ) {
1642 $error = $self->queue_fuzzyfiles_update;
1644 $dbh->rollback if $oldAutoCommit;
1645 return "updating fuzzy search cache: $error";
1649 # tax district update in cust_location
1651 # cust_main exports!
1653 my $export_args = $options{'export_args'} || [];
1656 map qsearch( 'part_export', {exportnum=>$_} ),
1657 $conf->config('cust_main-exports'); #, $agentnum
1659 foreach my $part_export ( @part_export ) {
1660 my $error = $part_export->export_replace( $self, $old, @$export_args);
1662 $dbh->rollback if $oldAutoCommit;
1663 return "exporting to ". $part_export->exporttype.
1664 " (transaction rolled back): $error";
1668 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1673 =item queue_fuzzyfiles_update
1675 Used by insert & replace to update the fuzzy search cache
1679 use FS::cust_main::Search;
1680 sub queue_fuzzyfiles_update {
1683 local $SIG{HUP} = 'IGNORE';
1684 local $SIG{INT} = 'IGNORE';
1685 local $SIG{QUIT} = 'IGNORE';
1686 local $SIG{TERM} = 'IGNORE';
1687 local $SIG{TSTP} = 'IGNORE';
1688 local $SIG{PIPE} = 'IGNORE';
1690 my $oldAutoCommit = $FS::UID::AutoCommit;
1691 local $FS::UID::AutoCommit = 0;
1694 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1695 my $queue = new FS::queue {
1696 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1698 my @args = "cust_main.$field", $self->get($field);
1699 my $error = $queue->insert( @args );
1701 $dbh->rollback if $oldAutoCommit;
1702 return "queueing job (transaction rolled back): $error";
1707 push @locations, $self->bill_location if $self->bill_locationnum;
1708 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1709 foreach my $location (@locations) {
1710 my $queue = new FS::queue {
1711 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1713 my @args = 'cust_location.address1', $location->address1;
1714 my $error = $queue->insert( @args );
1716 $dbh->rollback if $oldAutoCommit;
1717 return "queueing job (transaction rolled back): $error";
1721 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1728 Checks all fields to make sure this is a valid customer record. If there is
1729 an error, returns the error, otherwise returns false. Called by the insert
1730 and replace methods.
1737 warn "$me check BEFORE: \n". $self->_dump
1741 $self->ut_numbern('custnum')
1742 || $self->ut_number('agentnum')
1743 || $self->ut_textn('agent_custid')
1744 || $self->ut_number('refnum')
1745 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1746 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1747 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1748 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1749 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1750 || $self->ut_textn('custbatch')
1751 || $self->ut_name('last')
1752 || $self->ut_name('first')
1753 || $self->ut_snumbern('signupdate')
1754 || $self->ut_snumbern('birthdate')
1755 || $self->ut_namen('spouse_last')
1756 || $self->ut_namen('spouse_first')
1757 || $self->ut_snumbern('spouse_birthdate')
1758 || $self->ut_snumbern('anniversary_date')
1759 || $self->ut_textn('company')
1760 || $self->ut_textn('ship_company')
1761 || $self->ut_anything('comments')
1762 || $self->ut_numbern('referral_custnum')
1763 || $self->ut_textn('stateid')
1764 || $self->ut_textn('stateid_state')
1765 || $self->ut_textn('invoice_terms')
1766 || $self->ut_floatn('cdr_termination_percentage')
1767 || $self->ut_floatn('credit_limit')
1768 || $self->ut_numbern('billday')
1769 || $self->ut_numbern('prorate_day')
1770 || $self->ut_flag('edit_subject')
1771 || $self->ut_flag('calling_list_exempt')
1772 || $self->ut_flag('invoice_noemail')
1773 || $self->ut_flag('message_noemail')
1774 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1775 || $self->ut_currencyn('currency')
1776 || $self->ut_textn('po_number')
1777 || $self->ut_enum('complimentary', [ '', 'Y' ])
1778 || $self->ut_flag('invoice_ship_address')
1779 || $self->ut_flag('invoice_dest')
1782 foreach (qw(company ship_company)) {
1783 my $company = $self->get($_);
1784 $company =~ s/^\s+//;
1785 $company =~ s/\s+$//;
1786 $company =~ s/\s+/ /g;
1787 $self->set($_, $company);
1790 #barf. need message catalogs. i18n. etc.
1791 $error .= "Please select an advertising source."
1792 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1793 return $error if $error;
1795 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1796 or return "Unknown agent";
1798 if ( $self->currency ) {
1799 my $agent_currency = qsearchs( 'agent_currency', {
1800 'agentnum' => $agent->agentnum,
1801 'currency' => $self->currency,
1803 or return "Agent ". $agent->agent.
1804 " not permitted to offer ". $self->currency. " invoicing";
1807 return "Unknown refnum"
1808 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1810 return "Unknown referring custnum: ". $self->referral_custnum
1811 unless ! $self->referral_custnum
1812 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1814 if ( $self->ss eq '' ) {
1819 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1820 or return "Illegal social security number: ". $self->ss;
1821 $self->ss("$1-$2-$3");
1824 #turn off invoice_ship_address if ship & bill are the same
1825 if ($self->bill_locationnum eq $self->ship_locationnum) {
1826 $self->invoice_ship_address('');
1829 # cust_main_county verification now handled by cust_location check
1832 $self->ut_phonen('daytime', $self->country)
1833 || $self->ut_phonen('night', $self->country)
1834 || $self->ut_phonen('fax', $self->country)
1835 || $self->ut_phonen('mobile', $self->country)
1837 return $error if $error;
1839 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1841 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1844 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1846 : FS::Msgcat::_gettext('daytime');
1847 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1849 : FS::Msgcat::_gettext('night');
1851 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1853 : FS::Msgcat::_gettext('mobile');
1855 return "$daytime_label, $night_label or $mobile_label is required"
1859 return "Please select an invoicing locale"
1862 && $conf->exists('cust_main-require_locale');
1864 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1865 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1869 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
1871 warn "$me check AFTER: \n". $self->_dump
1874 $self->SUPER::check;
1877 sub check_payinfo_cardtype {
1880 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
1882 my $payinfo = $self->payinfo;
1883 $payinfo =~ s/\D//g;
1885 return '' if $payinfo =~ /^99\d{14}$/; #token
1887 my %bop_card_types = map { $_=>1 } values %{ card_types() };
1888 my $cardtype = cardtype($payinfo);
1890 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
1898 Additional checks for replace only.
1903 my ($new,$old) = @_;
1904 #preserve old value if global config is set
1905 if ($old && $conf->exists('invoice-ship_address')) {
1906 $new->invoice_ship_address($old->invoice_ship_address);
1913 Returns a list of fields which have ship_ duplicates.
1918 qw( last first company
1920 address1 address2 city county state zip country
1922 daytime night fax mobile
1926 =item has_ship_address
1928 Returns true if this customer record has a separate shipping address.
1932 sub has_ship_address {
1934 $self->bill_locationnum != $self->ship_locationnum;
1939 Returns a list of key/value pairs, with the following keys: address1,
1940 adddress2, city, county, state, zip, country, district, and geocode. The
1941 shipping address is used if present.
1947 $self->ship_location->location_hash;
1952 Returns all locations (see L<FS::cust_location>) for this customer.
1959 'table' => 'cust_location',
1960 'hashref' => { 'custnum' => $self->custnum,
1961 'prospectnum' => '',
1963 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
1969 Returns all contact associations (see L<FS::cust_contact>) for this customer.
1975 qsearch('cust_contact', { 'custnum' => $self->custnum } );
1978 =item cust_payby PAYBY
1980 Returns all payment methods (see L<FS::cust_payby>) for this customer.
1982 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
1983 Does not validate PAYBY.
1991 'table' => 'cust_payby',
1992 'hashref' => { 'custnum' => $self->custnum },
1993 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
1995 $search->{'extra_sql'} = ' AND payby IN ( '.
1996 join(',', map dbh->quote($_), @payby).
2003 =item has_cust_payby_auto
2005 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2009 sub has_cust_payby_auto {
2012 'table' => 'cust_payby',
2013 'hashref' => { 'custnum' => $self->custnum, },
2014 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2015 'order_by' => 'LIMIT 1',
2022 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2023 and L<FS::cust_pkg>) for this customer, except those on hold.
2025 Returns a list: an empty list on success or a list of errors.
2031 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2036 Unsuspends all suspended packages in the on-hold state (those without setup
2037 dates) for this customer.
2043 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2048 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2050 Returns a list: an empty list on success or a list of errors.
2056 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2059 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2061 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2062 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2063 of a list of pkgparts; the hashref has the following keys:
2067 =item pkgparts - listref of pkgparts
2069 =item (other options are passed to the suspend method)
2074 Returns a list: an empty list on success or a list of errors.
2078 sub suspend_if_pkgpart {
2080 my (@pkgparts, %opt);
2081 if (ref($_[0]) eq 'HASH'){
2082 @pkgparts = @{$_[0]{pkgparts}};
2087 grep { $_->suspend(%opt) }
2088 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2089 $self->unsuspended_pkgs;
2092 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2094 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2095 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2096 instead of a list of pkgparts; the hashref has the following keys:
2100 =item pkgparts - listref of pkgparts
2102 =item (other options are passed to the suspend method)
2106 Returns a list: an empty list on success or a list of errors.
2110 sub suspend_unless_pkgpart {
2112 my (@pkgparts, %opt);
2113 if (ref($_[0]) eq 'HASH'){
2114 @pkgparts = @{$_[0]{pkgparts}};
2119 grep { $_->suspend(%opt) }
2120 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2121 $self->unsuspended_pkgs;
2124 =item cancel [ OPTION => VALUE ... ]
2126 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2128 Available options are:
2132 =item quiet - can be set true to supress email cancellation notices.
2134 =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.
2136 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2138 =item nobill - can be set true to skip billing if it might otherwise be done.
2142 Always returns a list: an empty list on success or a list of errors.
2146 # nb that dates are not specified as valid options to this method
2149 my( $self, %opt ) = @_;
2151 warn "$me cancel called on customer ". $self->custnum. " with options ".
2152 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2155 return ( 'access denied' )
2156 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2158 if ( $opt{'ban'} ) {
2160 foreach my $cust_payby ( $self->cust_payby ) {
2162 #well, if they didn't get decrypted on search, then we don't have to
2163 # try again... queue a job for the server that does have decryption
2164 # capability if we're in a paranoid multi-server implementation?
2165 return ( "Can't (yet) ban encrypted credit cards" )
2166 if $cust_payby->is_encrypted($cust_payby->payinfo);
2168 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2169 my $error = $ban->insert;
2170 return ( $error ) if $error;
2176 my @pkgs = $self->ncancelled_pkgs;
2178 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2180 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2181 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2185 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2186 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2189 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2192 sub _banned_pay_hashref {
2193 die 'cust_main->_banned_pay_hashref deprecated';
2205 'payby' => $payby2ban{$self->payby},
2206 'payinfo' => $self->payinfo,
2207 #don't ever *search* on reason! #'reason' =>
2213 Returns all notes (see L<FS::cust_main_note>) for this customer.
2218 my($self,$orderby_classnum) = (shift,shift);
2219 my $orderby = "sticky DESC, _date DESC";
2220 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2221 qsearch( 'cust_main_note',
2222 { 'custnum' => $self->custnum },
2224 "ORDER BY $orderby",
2230 Returns the agent (see L<FS::agent>) for this customer.
2234 Returns the agent name (see L<FS::agent>) for this customer.
2240 $self->agent->agent;
2245 Returns any tags associated with this customer, as FS::cust_tag objects,
2246 or an empty list if there are no tags.
2250 Returns any tags associated with this customer, as FS::part_tag objects,
2251 or an empty list if there are no tags.
2257 map $_->part_tag, $self->cust_tag;
2263 Returns the customer class, as an FS::cust_class object, or the empty string
2264 if there is no customer class.
2268 Returns the customer category name, or the empty string if there is no customer
2275 my $cust_class = $self->cust_class;
2277 ? $cust_class->categoryname
2283 Returns the customer class name, or the empty string if there is no customer
2290 my $cust_class = $self->cust_class;
2292 ? $cust_class->classname
2298 Returns the external tax status, as an FS::tax_status object, or the empty
2299 string if there is no tax status.
2305 if ( $self->taxstatusnum ) {
2306 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2314 Returns the tax status code if there is one.
2320 my $tax_status = $self->tax_status;
2322 ? $tax_status->taxstatus
2326 =item BILLING METHODS
2328 Documentation on billing methods has been moved to
2329 L<FS::cust_main::Billing>.
2331 =item REALTIME BILLING METHODS
2333 Documentation on realtime billing methods has been moved to
2334 L<FS::cust_main::Billing_Realtime>.
2338 Removes the I<paycvv> field from the database directly.
2340 If there is an error, returns the error, otherwise returns false.
2342 DEPRECATED. Use L</remove_cvv_from_cust_payby> instead.
2347 die 'cust_main->remove_cvv deprecated';
2349 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2350 or return dbh->errstr;
2351 $sth->execute($self->custnum)
2352 or return $sth->errstr;
2359 Returns the total owed for this customer on all invoices
2360 (see L<FS::cust_bill/owed>).
2366 $self->total_owed_date(2145859200); #12/31/2037
2369 =item total_owed_date TIME
2371 Returns the total owed for this customer on all invoices with date earlier than
2372 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2373 see L<Time::Local> and L<Date::Parse> for conversion functions.
2377 sub total_owed_date {
2381 my $custnum = $self->custnum;
2383 my $owed_sql = FS::cust_bill->owed_sql;
2386 SELECT SUM($owed_sql) FROM cust_bill
2387 WHERE custnum = $custnum
2391 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2395 =item total_owed_pkgnum PKGNUM
2397 Returns the total owed on all invoices for this customer's specific package
2398 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2402 sub total_owed_pkgnum {
2403 my( $self, $pkgnum ) = @_;
2404 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2407 =item total_owed_date_pkgnum TIME PKGNUM
2409 Returns the total owed for this customer's specific package when using
2410 experimental package balances on all invoices with date earlier than
2411 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2412 see L<Time::Local> and L<Date::Parse> for conversion functions.
2416 sub total_owed_date_pkgnum {
2417 my( $self, $time, $pkgnum ) = @_;
2420 foreach my $cust_bill (
2421 grep { $_->_date <= $time }
2422 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2424 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2426 sprintf( "%.2f", $total_bill );
2432 Returns the total amount of all payments.
2439 $total += $_->paid foreach $self->cust_pay;
2440 sprintf( "%.2f", $total );
2443 =item total_unapplied_credits
2445 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2446 customer. See L<FS::cust_credit/credited>.
2448 =item total_credited
2450 Old name for total_unapplied_credits. Don't use.
2454 sub total_credited {
2455 #carp "total_credited deprecated, use total_unapplied_credits";
2456 shift->total_unapplied_credits(@_);
2459 sub total_unapplied_credits {
2462 my $custnum = $self->custnum;
2464 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2467 SELECT SUM($unapplied_sql) FROM cust_credit
2468 WHERE custnum = $custnum
2471 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2475 =item total_unapplied_credits_pkgnum PKGNUM
2477 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2478 customer. See L<FS::cust_credit/credited>.
2482 sub total_unapplied_credits_pkgnum {
2483 my( $self, $pkgnum ) = @_;
2484 my $total_credit = 0;
2485 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2486 sprintf( "%.2f", $total_credit );
2490 =item total_unapplied_payments
2492 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2493 See L<FS::cust_pay/unapplied>.
2497 sub total_unapplied_payments {
2500 my $custnum = $self->custnum;
2502 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2505 SELECT SUM($unapplied_sql) FROM cust_pay
2506 WHERE custnum = $custnum
2509 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2513 =item total_unapplied_payments_pkgnum PKGNUM
2515 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2516 specific package when using experimental package balances. See
2517 L<FS::cust_pay/unapplied>.
2521 sub total_unapplied_payments_pkgnum {
2522 my( $self, $pkgnum ) = @_;
2523 my $total_unapplied = 0;
2524 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2525 sprintf( "%.2f", $total_unapplied );
2529 =item total_unapplied_refunds
2531 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2532 customer. See L<FS::cust_refund/unapplied>.
2536 sub total_unapplied_refunds {
2538 my $custnum = $self->custnum;
2540 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2543 SELECT SUM($unapplied_sql) FROM cust_refund
2544 WHERE custnum = $custnum
2547 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2553 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2554 total_unapplied_credits minus total_unapplied_payments).
2560 $self->balance_date_range;
2563 =item balance_date TIME
2565 Returns the balance for this customer, only considering invoices with date
2566 earlier than TIME (total_owed_date minus total_credited minus
2567 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2568 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2575 $self->balance_date_range(shift);
2578 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2580 Returns the balance for this customer, optionally considering invoices with
2581 date earlier than START_TIME, and not later than END_TIME
2582 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2584 Times are specified as SQL fragments or numeric
2585 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2586 L<Date::Parse> for conversion functions. The empty string can be passed
2587 to disable that time constraint completely.
2589 Accepts the same options as L<balance_date_sql>:
2593 =item unapplied_date
2595 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)
2599 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2600 time will be ignored. Note that START_TIME and END_TIME only limit the date
2601 range for invoices and I<unapplied> payments, credits, and refunds.
2607 sub balance_date_range {
2609 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2610 ') FROM cust_main WHERE custnum='. $self->custnum;
2611 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2614 =item balance_pkgnum PKGNUM
2616 Returns the balance for this customer's specific package when using
2617 experimental package balances (total_owed plus total_unrefunded, minus
2618 total_unapplied_credits minus total_unapplied_payments)
2622 sub balance_pkgnum {
2623 my( $self, $pkgnum ) = @_;
2626 $self->total_owed_pkgnum($pkgnum)
2627 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2628 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2629 - $self->total_unapplied_credits_pkgnum($pkgnum)
2630 - $self->total_unapplied_payments_pkgnum($pkgnum)
2636 Returns a hash of useful information for making a payment.
2646 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2647 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2648 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2652 For credit card transactions:
2664 For electronic check transactions:
2674 #XXX i need to be updated for 4.x+
2680 $return{balance} = $self->balance;
2682 $return{payname} = $self->payname
2683 || ( $self->first. ' '. $self->get('last') );
2685 $return{$_} = $self->bill_location->$_
2686 for qw(address1 address2 city state zip);
2688 $return{payby} = $self->payby;
2689 $return{stateid_state} = $self->stateid_state;
2691 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2692 $return{card_type} = cardtype($self->payinfo);
2693 $return{payinfo} = $self->paymask;
2695 @return{'month', 'year'} = $self->paydate_monthyear;
2699 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2700 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2701 $return{payinfo1} = $payinfo1;
2702 $return{payinfo2} = $payinfo2;
2703 $return{paytype} = $self->paytype;
2704 $return{paystate} = $self->paystate;
2708 #doubleclick protection
2710 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2718 Returns the next payment expiration date for this customer. If they have no
2719 payment methods that will expire, returns 0.
2725 # filter out the ones that individually return 0, but then return 0 if
2726 # there are no results
2727 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
2728 min( @epochs ) || 0;
2731 =item paydate_epoch_sql
2733 Returns an SQL expression to get the next payment expiration date for a
2734 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
2735 dates, so that it's safe to test for "will it expire before date X" for any
2740 sub paydate_epoch_sql {
2742 my $paydate = FS::cust_payby->paydate_epoch_sql;
2743 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
2747 my( $self, $taxname ) = @_;
2749 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2750 'taxname' => $taxname,
2755 =item cust_main_exemption
2757 =item invoicing_list
2759 Returns a list of email addresses (with svcnum entries expanded), and the word
2760 'POST' if the customer receives postal invoices.
2764 sub invoicing_list {
2765 my( $self, $arrayref ) = @_;
2768 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
2771 my @emails = $self->invoicing_list_emailonly;
2772 push @emails, 'POST' if $self->get('postal_invoice');
2777 =item check_invoicing_list ARRAYREF
2779 Checks these arguements as valid input for the invoicing_list method. If there
2780 is an error, returns the error, otherwise returns false.
2784 sub check_invoicing_list {
2785 my( $self, $arrayref ) = @_;
2787 foreach my $address ( @$arrayref ) {
2789 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
2790 return 'Can\'t add FAX invoice destination with a blank FAX number.';
2793 my $cust_main_invoice = new FS::cust_main_invoice ( {
2794 'custnum' => $self->custnum,
2797 my $error = $self->custnum
2798 ? $cust_main_invoice->check
2799 : $cust_main_invoice->checkdest
2801 return $error if $error;
2805 return "Email address required"
2806 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
2807 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
2814 Returns the email addresses of all accounts provisioned for this customer.
2821 foreach my $cust_pkg ( $self->all_pkgs ) {
2822 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
2824 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2825 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2827 $list{$_}=1 foreach map { $_->email } @svc_acct;
2832 =item invoicing_list_addpost
2834 Adds postal invoicing to this customer. If this customer is already configured
2835 to receive postal invoices, does nothing.
2839 sub invoicing_list_addpost {
2841 if ( $self->get('postal_invoice') eq '' ) {
2842 $self->set('postal_invoice', 'Y');
2843 my $error = $self->replace;
2844 warn $error if $error; # should fail harder, but this is traditional
2848 =item invoicing_list_emailonly
2850 Returns the list of email invoice recipients (invoicing_list without non-email
2851 destinations such as POST and FAX).
2855 sub invoicing_list_emailonly {
2857 warn "$me invoicing_list_emailonly called"
2859 return () if !$self->custnum; # not yet inserted
2860 return map { $_->emailaddress }
2862 table => 'cust_contact',
2863 select => 'emailaddress',
2864 addl_from => ' JOIN contact USING (contactnum) '.
2865 ' JOIN contact_email USING (contactnum)',
2866 hashref => { 'custnum' => $self->custnum, },
2867 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
2871 =item invoicing_list_emailonly_scalar
2873 Returns the list of email invoice recipients (invoicing_list without non-email
2874 destinations such as POST and FAX) as a comma-separated scalar.
2878 sub invoicing_list_emailonly_scalar {
2880 warn "$me invoicing_list_emailonly_scalar called"
2882 join(', ', $self->invoicing_list_emailonly);
2885 =item contact_list [ CLASSNUM, ... ]
2887 Returns a list of contacts (L<FS::contact> objects) for the customer. If
2888 a list of contact classnums is given, returns only contacts in those
2889 classes. If the pseudo-classnum 'invoice' is given, returns contacts that
2890 are marked as invoice destinations. If '0' is given, also returns contacts
2893 If no arguments are given, returns all contacts for the customer.
2901 select => 'contact.*, cust_contact.invoice_dest',
2902 addl_from => ' JOIN cust_contact USING (contactnum)',
2903 extra_sql => ' WHERE cust_contact.custnum = '.$self->custnum,
2909 if ( $_ eq 'invoice' ) {
2910 push @orwhere, 'cust_contact.invoice_dest = \'Y\'';
2911 } elsif ( $_ eq '0' ) {
2912 push @orwhere, 'cust_contact.classnum is null';
2913 } elsif ( /^\d+$/ ) {
2914 push @classnums, $_;
2916 die "bad classnum argument '$_'";
2921 push @orwhere, 'cust_contact.classnum IN ('.join(',', @classnums).')';
2924 $search->{extra_sql} .= ' AND (' .
2925 join(' OR ', map "( $_ )", @orwhere) .
2932 =item contact_list_email [ CLASSNUM, ... ]
2934 Same as L</contact_list>, but returns email destinations instead of contact
2939 sub contact_list_email {
2941 my @contacts = $self->contact_list(@_);
2943 foreach my $contact (@contacts) {
2944 foreach my $contact_email ($contact->contact_email) {
2946 $contact->firstlast . ' <' . $contact_email->emailaddress . '>';
2952 =item referral_custnum_cust_main
2954 Returns the customer who referred this customer (or the empty string, if
2955 this customer was not referred).
2957 Note the difference with referral_cust_main method: This method,
2958 referral_custnum_cust_main returns the single customer (if any) who referred
2959 this customer, while referral_cust_main returns an array of customers referred
2964 sub referral_custnum_cust_main {
2966 return '' unless $self->referral_custnum;
2967 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
2970 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
2972 Returns an array of customers referred by this customer (referral_custnum set
2973 to this custnum). If DEPTH is given, recurses up to the given depth, returning
2974 customers referred by customers referred by this customer and so on, inclusive.
2975 The default behavior is DEPTH 1 (no recursion).
2977 Note the difference with referral_custnum_cust_main method: This method,
2978 referral_cust_main, returns an array of customers referred BY this customer,
2979 while referral_custnum_cust_main returns the single customer (if any) who
2980 referred this customer.
2984 sub referral_cust_main {
2986 my $depth = @_ ? shift : 1;
2987 my $exclude = @_ ? shift : {};
2990 map { $exclude->{$_->custnum}++; $_; }
2991 grep { ! $exclude->{ $_->custnum } }
2992 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
2996 map { $_->referral_cust_main($depth-1, $exclude) }
3003 =item referral_cust_main_ncancelled
3005 Same as referral_cust_main, except only returns customers with uncancelled
3010 sub referral_cust_main_ncancelled {
3012 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3015 =item referral_cust_pkg [ DEPTH ]
3017 Like referral_cust_main, except returns a flat list of all unsuspended (and
3018 uncancelled) packages for each customer. The number of items in this list may
3019 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3023 sub referral_cust_pkg {
3025 my $depth = @_ ? shift : 1;
3027 map { $_->unsuspended_pkgs }
3028 grep { $_->unsuspended_pkgs }
3029 $self->referral_cust_main($depth);
3032 =item referring_cust_main
3034 Returns the single cust_main record for the customer who referred this customer
3035 (referral_custnum), or false.
3039 sub referring_cust_main {
3041 return '' unless $self->referral_custnum;
3042 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3045 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3047 Applies a credit to this customer. If there is an error, returns the error,
3048 otherwise returns false.
3050 REASON can be a text string, an FS::reason object, or a scalar reference to
3051 a reasonnum. If a text string, it will be automatically inserted as a new
3052 reason, and a 'reason_type' option must be passed to indicate the
3053 FS::reason_type for the new reason.
3055 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3056 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3057 I<commission_pkgnum>.
3059 Any other options are passed to FS::cust_credit::insert.
3064 my( $self, $amount, $reason, %options ) = @_;
3066 my $cust_credit = new FS::cust_credit {
3067 'custnum' => $self->custnum,
3068 'amount' => $amount,
3071 if ( ref($reason) ) {
3073 if ( ref($reason) eq 'SCALAR' ) {
3074 $cust_credit->reasonnum( $$reason );
3076 $cust_credit->reasonnum( $reason->reasonnum );
3080 $cust_credit->set('reason', $reason)
3083 $cust_credit->$_( delete $options{$_} )
3084 foreach grep exists($options{$_}),
3085 qw( addlinfo eventnum ),
3086 map "commission_$_", qw( agentnum salesnum pkgnum );
3088 $cust_credit->insert(%options);
3092 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3094 Creates a one-time charge for this customer. If there is an error, returns
3095 the error, otherwise returns false.
3097 New-style, with a hashref of options:
3099 my $error = $cust_main->charge(
3103 'start_date' => str2time('7/4/2009'),
3104 'pkg' => 'Description',
3105 'comment' => 'Comment',
3106 'additional' => [], #extra invoice detail
3107 'classnum' => 1, #pkg_class
3109 'setuptax' => '', # or 'Y' for tax exempt
3111 'locationnum'=> 1234, # optional
3114 'taxclass' => 'Tax class',
3117 'taxproduct' => 2, #part_pkg_taxproduct
3118 'override' => {}, #XXX describe
3120 #will be filled in with the new object
3121 'cust_pkg_ref' => \$cust_pkg,
3123 #generate an invoice immediately
3125 'invoice_terms' => '', #with these terms
3131 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3135 #super false laziness w/quotation::charge
3138 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3139 my ( $pkg, $comment, $additional );
3140 my ( $setuptax, $taxclass ); #internal taxes
3141 my ( $taxproduct, $override ); #vendor (CCH) taxes
3143 my $separate_bill = '';
3144 my $cust_pkg_ref = '';
3145 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3147 if ( ref( $_[0] ) ) {
3148 $amount = $_[0]->{amount};
3149 $setup_cost = $_[0]->{setup_cost};
3150 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3151 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3152 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3153 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3154 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3155 : '$'. sprintf("%.2f",$amount);
3156 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3157 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3158 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3159 $additional = $_[0]->{additional} || [];
3160 $taxproduct = $_[0]->{taxproductnum};
3161 $override = { '' => $_[0]->{tax_override} };
3162 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3163 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3164 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3165 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3166 $separate_bill = $_[0]->{separate_bill} || '';
3172 $pkg = @_ ? shift : 'One-time charge';
3173 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3175 $taxclass = @_ ? shift : '';
3179 local $SIG{HUP} = 'IGNORE';
3180 local $SIG{INT} = 'IGNORE';
3181 local $SIG{QUIT} = 'IGNORE';
3182 local $SIG{TERM} = 'IGNORE';
3183 local $SIG{TSTP} = 'IGNORE';
3184 local $SIG{PIPE} = 'IGNORE';
3186 my $oldAutoCommit = $FS::UID::AutoCommit;
3187 local $FS::UID::AutoCommit = 0;
3190 my $part_pkg = new FS::part_pkg ( {
3192 'comment' => $comment,
3196 'classnum' => ( $classnum ? $classnum : '' ),
3197 'setuptax' => $setuptax,
3198 'taxclass' => $taxclass,
3199 'taxproductnum' => $taxproduct,
3200 'setup_cost' => $setup_cost,
3203 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3204 ( 0 .. @$additional - 1 )
3206 'additional_count' => scalar(@$additional),
3207 'setup_fee' => $amount,
3210 my $error = $part_pkg->insert( options => \%options,
3211 tax_overrides => $override,
3214 $dbh->rollback if $oldAutoCommit;
3218 my $pkgpart = $part_pkg->pkgpart;
3219 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3220 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3221 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3222 $error = $type_pkgs->insert;
3224 $dbh->rollback if $oldAutoCommit;
3229 my $cust_pkg = new FS::cust_pkg ( {
3230 'custnum' => $self->custnum,
3231 'pkgpart' => $pkgpart,
3232 'quantity' => $quantity,
3233 'start_date' => $start_date,
3234 'no_auto' => $no_auto,
3235 'separate_bill' => $separate_bill,
3236 'locationnum'=> $locationnum,
3239 $error = $cust_pkg->insert;
3241 $dbh->rollback if $oldAutoCommit;
3243 } elsif ( $cust_pkg_ref ) {
3244 ${$cust_pkg_ref} = $cust_pkg;
3248 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3249 'pkg_list' => [ $cust_pkg ],
3252 $dbh->rollback if $oldAutoCommit;
3257 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3262 #=item charge_postal_fee
3264 #Applies a one time charge this customer. If there is an error,
3265 #returns the error, returns the cust_pkg charge object or false
3266 #if there was no charge.
3270 # This should be a customer event. For that to work requires that bill
3271 # also be a customer event.
3273 sub charge_postal_fee {
3276 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3277 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3279 my $cust_pkg = new FS::cust_pkg ( {
3280 'custnum' => $self->custnum,
3281 'pkgpart' => $pkgpart,
3285 my $error = $cust_pkg->insert;
3286 $error ? $error : $cust_pkg;
3289 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3291 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3293 Optionally, a list or hashref of additional arguments to the qsearch call can
3300 my $opt = ref($_[0]) ? shift : { @_ };
3302 #return $self->num_cust_bill unless wantarray || keys %$opt;
3304 $opt->{'table'} = 'cust_bill';
3305 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3306 $opt->{'hashref'}{'custnum'} = $self->custnum;
3307 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3309 map { $_ } #behavior of sort undefined in scalar context
3310 sort { $a->_date <=> $b->_date }
3314 =item open_cust_bill
3316 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3321 sub open_cust_bill {
3325 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3331 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3333 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3337 sub legacy_cust_bill {
3340 #return $self->num_legacy_cust_bill unless wantarray;
3342 map { $_ } #behavior of sort undefined in scalar context
3343 sort { $a->_date <=> $b->_date }
3344 qsearch({ 'table' => 'legacy_cust_bill',
3345 'hashref' => { 'custnum' => $self->custnum, },
3346 'order_by' => 'ORDER BY _date ASC',
3350 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3352 Returns all the statements (see L<FS::cust_statement>) for this customer.
3354 Optionally, a list or hashref of additional arguments to the qsearch call can
3359 =item cust_bill_void
3361 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3365 sub cust_bill_void {
3368 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3369 sort { $a->_date <=> $b->_date }
3370 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3373 sub cust_statement {
3375 my $opt = ref($_[0]) ? shift : { @_ };
3377 #return $self->num_cust_statement unless wantarray || keys %$opt;
3379 $opt->{'table'} = 'cust_statement';
3380 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3381 $opt->{'hashref'}{'custnum'} = $self->custnum;
3382 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3384 map { $_ } #behavior of sort undefined in scalar context
3385 sort { $a->_date <=> $b->_date }
3389 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3391 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3393 Optionally, a list or hashref of additional arguments to the qsearch call can
3394 be passed following the SVCDB.
3401 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3402 warn "$me svc_x requires a svcdb";
3405 my $opt = ref($_[0]) ? shift : { @_ };
3407 $opt->{'table'} = $svcdb;
3408 $opt->{'addl_from'} =
3409 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3410 ($opt->{'addl_from'} || '');
3412 my $custnum = $self->custnum;
3413 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3414 my $where = "cust_pkg.custnum = $custnum";
3416 my $extra_sql = $opt->{'extra_sql'} || '';
3417 if ( keys %{ $opt->{'hashref'} } ) {
3418 $extra_sql = " AND $where $extra_sql";
3421 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3422 $extra_sql = "WHERE $where AND $1";
3425 $extra_sql = "WHERE $where $extra_sql";
3428 $opt->{'extra_sql'} = $extra_sql;
3433 # required for use as an eventtable;
3436 $self->svc_x('svc_acct', @_);
3441 Returns all the credits (see L<FS::cust_credit>) for this customer.
3448 #return $self->num_cust_credit unless wantarray;
3450 map { $_ } #behavior of sort undefined in scalar context
3451 sort { $a->_date <=> $b->_date }
3452 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3455 =item cust_credit_pkgnum
3457 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3458 package when using experimental package balances.
3462 sub cust_credit_pkgnum {
3463 my( $self, $pkgnum ) = @_;
3464 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3465 sort { $a->_date <=> $b->_date }
3466 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3467 'pkgnum' => $pkgnum,
3472 =item cust_credit_void
3474 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3478 sub cust_credit_void {
3481 sort { $a->_date <=> $b->_date }
3482 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3487 Returns all the payments (see L<FS::cust_pay>) for this customer.
3493 my $opt = ref($_[0]) ? shift : { @_ };
3495 return $self->num_cust_pay unless wantarray || keys %$opt;
3497 $opt->{'table'} = 'cust_pay';
3498 $opt->{'hashref'}{'custnum'} = $self->custnum;
3500 map { $_ } #behavior of sort undefined in scalar context
3501 sort { $a->_date <=> $b->_date }
3508 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3509 called automatically when the cust_pay method is used in a scalar context.
3515 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3516 my $sth = dbh->prepare($sql) or die dbh->errstr;
3517 $sth->execute($self->custnum) or die $sth->errstr;
3518 $sth->fetchrow_arrayref->[0];
3521 =item unapplied_cust_pay
3523 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3527 sub unapplied_cust_pay {
3531 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3537 =item cust_pay_pkgnum
3539 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3540 package when using experimental package balances.
3544 sub cust_pay_pkgnum {
3545 my( $self, $pkgnum ) = @_;
3546 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3547 sort { $a->_date <=> $b->_date }
3548 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3549 'pkgnum' => $pkgnum,
3556 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3562 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3563 sort { $a->_date <=> $b->_date }
3564 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3567 =item cust_pay_pending
3569 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3570 (without status "done").
3574 sub cust_pay_pending {
3576 return $self->num_cust_pay_pending unless wantarray;
3577 sort { $a->_date <=> $b->_date }
3578 qsearch( 'cust_pay_pending', {
3579 'custnum' => $self->custnum,
3580 'status' => { op=>'!=', value=>'done' },
3585 =item cust_pay_pending_attempt
3587 Returns all payment attempts / declined payments for this customer, as pending
3588 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3589 a corresponding payment (see L<FS::cust_pay>).
3593 sub cust_pay_pending_attempt {
3595 return $self->num_cust_pay_pending_attempt unless wantarray;
3596 sort { $a->_date <=> $b->_date }
3597 qsearch( 'cust_pay_pending', {
3598 'custnum' => $self->custnum,
3605 =item num_cust_pay_pending
3607 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3608 customer (without status "done"). Also called automatically when the
3609 cust_pay_pending method is used in a scalar context.
3613 sub num_cust_pay_pending {
3616 " SELECT COUNT(*) FROM cust_pay_pending ".
3617 " WHERE custnum = ? AND status != 'done' ",
3622 =item num_cust_pay_pending_attempt
3624 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3625 customer, with status "done" but without a corresp. Also called automatically when the
3626 cust_pay_pending method is used in a scalar context.
3630 sub num_cust_pay_pending_attempt {
3633 " SELECT COUNT(*) FROM cust_pay_pending ".
3634 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3641 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3647 map { $_ } #return $self->num_cust_refund unless wantarray;
3648 sort { $a->_date <=> $b->_date }
3649 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3652 =item display_custnum
3654 Returns the displayed customer number for this customer: agent_custid if
3655 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3659 sub display_custnum {
3662 return $self->agent_custid
3663 if $default_agent_custid && $self->agent_custid;
3665 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3669 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
3670 } elsif ( $custnum_display_length ) {
3671 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
3673 return $self->custnum;
3679 Returns a name string for this customer, either "Company (Last, First)" or
3686 my $name = $self->contact;
3687 $name = $self->company. " ($name)" if $self->company;
3691 =item service_contact
3693 Returns the L<FS::contact> object for this customer that has the 'Service'
3694 contact class, or undef if there is no such contact. Deprecated; don't use
3699 sub service_contact {
3701 if ( !exists($self->{service_contact}) ) {
3702 my $classnum = $self->scalar_sql(
3703 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3704 ) || 0; #if it's zero, qsearchs will return nothing
3705 my $cust_contact = qsearchs('cust_contact', {
3706 'classnum' => $classnum,
3707 'custnum' => $self->custnum,
3709 $self->{service_contact} = $cust_contact->contact if $cust_contact;
3711 $self->{service_contact};
3716 Returns a name string for this (service/shipping) contact, either
3717 "Company (Last, First)" or "Last, First".
3724 my $name = $self->ship_contact;
3725 $name = $self->company. " ($name)" if $self->company;
3731 Returns a name string for this customer, either "Company" or "First Last".
3737 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3740 =item ship_name_short
3742 Returns a name string for this (service/shipping) contact, either "Company"
3747 sub ship_name_short {
3749 $self->service_contact
3750 ? $self->ship_contact_firstlast
3756 Returns this customer's full (billing) contact name only, "Last, First"
3762 $self->get('last'). ', '. $self->first;
3767 Returns this customer's full (shipping) contact name only, "Last, First"
3773 my $contact = $self->service_contact || $self;
3774 $contact->get('last') . ', ' . $contact->get('first');
3777 =item contact_firstlast
3779 Returns this customers full (billing) contact name only, "First Last".
3783 sub contact_firstlast {
3785 $self->first. ' '. $self->get('last');
3788 =item ship_contact_firstlast
3790 Returns this customer's full (shipping) contact name only, "First Last".
3794 sub ship_contact_firstlast {
3796 my $contact = $self->service_contact || $self;
3797 $contact->get('first') . ' '. $contact->get('last');
3800 sub bill_country_full {
3802 $self->bill_location->country_full;
3805 sub ship_country_full {
3807 $self->ship_location->country_full;
3810 =item county_state_county [ PREFIX ]
3812 Returns a string consisting of just the county, state and country.
3816 sub county_state_country {
3819 if ( @_ && $_[0] && $self->has_ship_address ) {
3820 $locationnum = $self->ship_locationnum;
3822 $locationnum = $self->bill_locationnum;
3824 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
3825 $cust_location->county_state_country;
3828 =item geocode DATA_VENDOR
3830 Returns a value for the customer location as encoded by DATA_VENDOR.
3831 Currently this only makes sense for "CCH" as DATA_VENDOR.
3839 Returns a status string for this customer, currently:
3845 No packages have ever been ordered. Displayed as "No packages".
3849 Recurring packages all are new (not yet billed).
3853 One or more recurring packages is active.
3857 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
3861 All non-cancelled recurring packages are suspended.
3865 All recurring packages are cancelled.
3869 Behavior of inactive vs. cancelled edge cases can be adjusted with the
3870 cust_main-status_module configuration option.
3874 sub status { shift->cust_status(@_); }
3878 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
3879 for my $status ( FS::cust_main->statuses() ) {
3880 my $method = $status.'_sql';
3881 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3882 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3883 $sth->execute( ($self->custnum) x $numnum )
3884 or die "Error executing 'SELECT $sql': ". $sth->errstr;
3885 if ( $sth->fetchrow_arrayref->[0] ) {
3886 $self->hashref->{cust_status} = $status;
3892 =item is_status_delay_cancel
3894 Returns true if customer status is 'suspended'
3895 and all suspended cust_pkg return true for
3896 cust_pkg->is_status_delay_cancel.
3898 This is not a real status, this only meant for hacking display
3899 values, because otherwise treating the customer as suspended is
3900 really the whole point of the delay_cancel option.
3904 sub is_status_delay_cancel {
3906 return 0 unless $self->status eq 'suspended';
3907 foreach my $cust_pkg ($self->ncancelled_pkgs) {
3908 return 0 unless $cust_pkg->is_status_delay_cancel;
3913 =item ucfirst_cust_status
3915 =item ucfirst_status
3917 Deprecated, use the cust_status_label method instead.
3919 Returns the status with the first character capitalized.
3923 sub ucfirst_status {
3924 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
3925 local($ucfirst_nowarn) = 1;
3926 shift->ucfirst_cust_status(@_);
3929 sub ucfirst_cust_status {
3930 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
3932 ucfirst($self->cust_status);
3935 =item cust_status_label
3939 Returns the display label for this status.
3943 sub status_label { shift->cust_status_label(@_); }
3945 sub cust_status_label {
3947 __PACKAGE__->statuslabels->{$self->cust_status};
3952 Returns a hex triplet color string for this customer's status.
3956 sub statuscolor { shift->cust_statuscolor(@_); }
3958 sub cust_statuscolor {
3960 __PACKAGE__->statuscolors->{$self->cust_status};
3963 =item tickets [ STATUS ]
3965 Returns an array of hashes representing the customer's RT tickets.
3967 An optional status (or arrayref or hashref of statuses) may be specified.
3973 my $status = ( @_ && $_[0] ) ? shift : '';
3975 my $num = $conf->config('cust_main-max_tickets') || 10;
3978 if ( $conf->config('ticket_system') ) {
3979 unless ( $conf->config('ticket_system-custom_priority_field') ) {
3981 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
3990 foreach my $priority (
3991 $conf->config('ticket_system-custom_priority_field-values'), ''
3993 last if scalar(@tickets) >= $num;
3995 @{ FS::TicketSystem->customer_tickets( $self->custnum,
3996 $num - scalar(@tickets),
4007 =item appointments [ STATUS ]
4009 Returns an array of hashes representing the customer's RT tickets which
4016 my $status = ( @_ && $_[0] ) ? shift : '';
4018 return () unless $conf->config('ticket_system');
4020 my $queueid = $conf->config('ticket_system-appointment-queueid');
4022 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4031 # Return services representing svc_accts in customer support packages
4032 sub support_services {
4034 my %packages = map { $_ => 1 } $conf->config('support_packages');
4036 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4037 grep { $_->part_svc->svcdb eq 'svc_acct' }
4038 map { $_->cust_svc }
4039 grep { exists $packages{ $_->pkgpart } }
4040 $self->ncancelled_pkgs;
4044 # Return a list of latitude/longitude for one of the services (if any)
4045 sub service_coordinates {
4049 grep { $_->latitude && $_->longitude }
4051 map { $_->cust_svc }
4052 $self->ncancelled_pkgs;
4054 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4059 Returns a masked version of the named field
4064 my ($self,$field) = @_;
4068 'x'x(length($self->getfield($field))-4).
4069 substr($self->getfield($field), (length($self->getfield($field))-4));
4073 =item payment_history
4075 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4076 cust_credit and cust_refund objects. Each hashref has the following fields:
4078 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4080 I<date> - value of _date field, unix timestamp
4082 I<date_pretty> - user-friendly date
4084 I<description> - user-friendly description of item
4086 I<amount> - impact of item on user's balance
4087 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4088 Not to be confused with the native 'amount' field in cust_credit, see below.
4090 I<amount_pretty> - includes money char
4092 I<balance> - customer balance, chronologically as of this item
4094 I<balance_pretty> - includes money char
4096 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4098 I<paid> - amount paid for cust_pay records, undef for other types
4100 I<credit> - amount credited for cust_credit records, undef for other types.
4101 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4103 I<refund> - amount refunded for cust_refund records, undef for other types
4105 The four table-specific keys always have positive values, whether they reflect charges or payments.
4107 The following options may be passed to this method:
4109 I<line_items> - if true, returns charges ('Line item') rather than invoices
4111 I<start_date> - unix timestamp, only include records on or after.
4112 If specified, an item of type 'Previous' will also be included.
4113 It does not have table-specific fields.
4115 I<end_date> - unix timestamp, only include records before
4117 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4119 I<conf> - optional already-loaded FS::Conf object.
4123 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4124 # and also for sending customer statements, which should both be kept customer-friendly.
4125 # If you add anything that shouldn't be passed on through the API or exposed
4126 # to customers, add a new option to include it, don't include it by default
4127 sub payment_history {
4129 my $opt = ref($_[0]) ? $_[0] : { @_ };
4131 my $conf = $$opt{'conf'} || new FS::Conf;
4132 my $money_char = $conf->config("money_char") || '$',
4134 #first load entire history,
4135 #need previous to calculate previous balance
4136 #loading after end_date shouldn't hurt too much?
4138 if ( $$opt{'line_items'} ) {
4140 foreach my $cust_bill ( $self->cust_bill ) {
4143 'type' => 'Line item',
4144 'description' => $_->desc( $self->locale ).
4145 ( $_->sdate && $_->edate
4146 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4147 ' To '. time2str('%d-%b-%Y', $_->edate)
4150 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4151 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4152 'date' => $cust_bill->_date,
4153 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4155 foreach $cust_bill->cust_bill_pkg;
4162 'type' => 'Invoice',
4163 'description' => 'Invoice #'. $_->display_invnum,
4164 'amount' => sprintf('%.2f', $_->charged ),
4165 'charged' => sprintf('%.2f', $_->charged ),
4166 'date' => $_->_date,
4167 'date_pretty' => $self->time2str_local('short', $_->_date ),
4169 foreach $self->cust_bill;
4174 'type' => 'Payment',
4175 'description' => 'Payment', #XXX type
4176 'amount' => sprintf('%.2f', 0 - $_->paid ),
4177 'paid' => sprintf('%.2f', $_->paid ),
4178 'date' => $_->_date,
4179 'date_pretty' => $self->time2str_local('short', $_->_date ),
4181 foreach $self->cust_pay;
4185 'description' => 'Credit', #more info?
4186 'amount' => sprintf('%.2f', 0 -$_->amount ),
4187 'credit' => sprintf('%.2f', $_->amount ),
4188 'date' => $_->_date,
4189 'date_pretty' => $self->time2str_local('short', $_->_date ),
4191 foreach $self->cust_credit;
4195 'description' => 'Refund', #more info? type, like payment?
4196 'amount' => $_->refund,
4197 'refund' => $_->refund,
4198 'date' => $_->_date,
4199 'date_pretty' => $self->time2str_local('short', $_->_date ),
4201 foreach $self->cust_refund;
4203 #put it all in chronological order
4204 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4206 #calculate balance, filter items outside date range
4210 foreach my $item (@history) {
4211 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4212 $balance += $$item{'amount'};
4213 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4214 $previous += $$item{'amount'};
4217 $$item{'balance'} = sprintf("%.2f",$balance);
4218 foreach my $key ( qw(amount balance) ) {
4219 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4224 # start with previous balance, if there was one
4227 'type' => 'Previous',
4228 'description' => 'Previous balance',
4229 'amount' => sprintf("%.2f",$previous),
4230 'balance' => sprintf("%.2f",$previous),
4231 'date' => $$opt{'start_date'},
4232 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4234 #false laziness with above
4235 foreach my $key ( qw(amount balance) ) {
4236 $$item{$key.'_pretty'} = $$item{$key};
4237 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4239 unshift(@out,$item);
4242 @out = reverse @history if $$opt{'reverse_sort'};
4247 =item save_cust_payby
4249 Saves a new cust_payby for this customer, replacing an existing entry only
4250 in select circumstances. Does not validate input.
4252 If auto is specified, marks this as the customer's primary method, or the
4253 specified weight. Existing payment methods have their weight incremented as
4256 If bill_location is specified with auto, also sets location in cust_main.
4258 Will not insert complete duplicates of existing records, or records in which the
4259 only difference from an existing record is to turn off automatic payment (will
4260 return without error.) Will replace existing records in which the only difference
4261 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4262 Fields marked as preserved are optional, and existing values will not be overwritten with
4263 blanks when replacing.
4265 Accepts the following named parameters:
4275 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4279 optional, set higher than 1 for secondary, etc.
4287 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4295 optional, will be preserved when replacing
4303 CARD only, required, FS::cust_location object
4305 =item paystart_month
4307 CARD only, optional, will be preserved when replacing
4311 CARD only, optional, will be preserved when replacing
4315 CARD only, optional, will be preserved when replacing
4319 CARD only, only used if conf cvv-save is set appropriately
4333 #The code for this option is in place, but it's not currently used
4337 # existing cust_payby object to be replaced (must match custnum)
4339 # stateid/stateid_state/ss are not currently supported in cust_payby,
4340 # might not even work properly in 4.x, but will need to work here if ever added
4342 sub save_cust_payby {
4346 my $old = $opt{'replace'};
4347 my $new = new FS::cust_payby { $old ? $old->hash : () };
4348 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4349 $new->set( 'custnum' => $self->custnum );
4351 my $payby = $opt{'payment_payby'};
4352 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4354 # don't allow turning off auto when replacing
4355 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4357 my @check_existing; # payby relevant to this payment_payby
4359 # set payby based on auto
4360 if ( $payby eq 'CARD' ) {
4361 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4362 @check_existing = qw( CARD DCRD );
4363 } elsif ( $payby eq 'CHEK' ) {
4364 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4365 @check_existing = qw( CHEK DCHK );
4368 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4371 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4372 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4373 $new->set( 'payname' => $opt{'payname'} );
4374 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4376 my $conf = new FS::Conf;
4378 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4379 if ( $payby eq 'CARD' &&
4380 ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4381 || $conf->exists('business-onlinepayment-verification')
4384 $new->set( 'paycvv' => $opt{'paycvv'} );
4386 $new->set( 'paycvv' => '');
4389 local $SIG{HUP} = 'IGNORE';
4390 local $SIG{INT} = 'IGNORE';
4391 local $SIG{QUIT} = 'IGNORE';
4392 local $SIG{TERM} = 'IGNORE';
4393 local $SIG{TSTP} = 'IGNORE';
4394 local $SIG{PIPE} = 'IGNORE';
4396 my $oldAutoCommit = $FS::UID::AutoCommit;
4397 local $FS::UID::AutoCommit = 0;
4400 # set fields specific to payment_payby
4401 if ( $payby eq 'CARD' ) {
4402 if ($opt{'bill_location'}) {
4403 $opt{'bill_location'}->set('custnum' => $self->custnum);
4404 my $error = $opt{'bill_location'}->find_or_insert;
4406 $dbh->rollback if $oldAutoCommit;
4409 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4411 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4412 $new->set( $field => $opt{$field} );
4415 foreach my $field ( qw(paytype paystate) ) {
4416 $new->set( $field => $opt{$field} );
4420 # other cust_payby to compare this to
4421 my @existing = $self->cust_payby(@check_existing);
4423 # fields that can overwrite blanks with values, but not values with blanks
4424 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4426 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4428 # generally, we don't want to overwrite existing cust_payby with this,
4429 # but we can replace if we're only marking it auto or adding a preserved field
4430 # and we can avoid saving a total duplicate or merely turning off auto
4432 foreach my $cust_payby (@existing) {
4433 # check fields that absolutely should not change
4434 foreach my $field ($new->fields) {
4435 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4436 next if grep(/^$field$/, @preserve );
4437 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4439 # now check fields that can replace if one value is blank
4441 foreach my $field (@preserve) {
4443 ( $new->get($field) and !$cust_payby->get($field) ) or
4444 ( $cust_payby->get($field) and !$new->get($field) )
4446 # prevention of overwriting values with blanks happens farther below
4448 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4452 unless ( $replace ) {
4453 # nearly identical, now check weight
4454 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4455 # ignore identical cust_payby, and ignore attempts to turn off auto
4456 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4457 $skip_cust_payby = 1;
4460 # otherwise, only change is to mark this as primary
4462 # if we got this far, we're definitely replacing
4469 $new->set( 'custpaybynum' => $old->custpaybynum );
4470 # don't turn off automatic payment (but allow it to be turned on)
4471 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4473 $new->set( 'payby' => $old->payby );
4474 $new->set( 'weight' => 1 );
4476 # make sure we're not overwriting values with blanks
4477 foreach my $field (@preserve) {
4478 if ( $old->get($field) and !$new->get($field) ) {
4479 $new->set( $field => $old->get($field) );
4484 # only overwrite cust_main bill_location if auto
4485 if ($opt{'auto'} && $opt{'bill_location'}) {
4486 $self->set('bill_location' => $opt{'bill_location'});
4487 my $error = $self->replace;
4489 $dbh->rollback if $oldAutoCommit;
4494 # done with everything except reweighting and saving cust_payby
4495 # still need to commit changes to cust_main and cust_location
4496 if ($skip_cust_payby) {
4497 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4501 # re-weight existing primary cust_pay for this payby
4503 foreach my $cust_payby (@existing) {
4504 # relies on cust_payby return order
4505 last unless $cust_payby->payby !~ /^D/;
4506 last if $cust_payby->weight > 1;
4507 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4508 next if $cust_payby->weight < ($opt{'weight'} || 1);
4509 $cust_payby->weight( $cust_payby->weight + 1 );
4510 my $error = $cust_payby->replace;
4512 $dbh->rollback if $oldAutoCommit;
4513 return "Error reweighting cust_payby: $error";
4518 # finally, save cust_payby
4519 my $error = $old ? $new->replace($old) : $new->insert;
4521 $dbh->rollback if $oldAutoCommit;
4525 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4530 =item remove_cvv_from_cust_payby PAYINFO
4532 Removes paycvv from associated cust_payby with matching PAYINFO.
4536 sub remove_cvv_from_cust_payby {
4537 my ($self,$payinfo) = @_;
4539 my $oldAutoCommit = $FS::UID::AutoCommit;
4540 local $FS::UID::AutoCommit = 0;
4543 foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
4544 next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
4545 $cust_payby->paycvv('');
4546 my $error = $cust_payby->replace;
4548 $dbh->rollback if $oldAutoCommit;
4553 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4559 =head1 CLASS METHODS
4565 Class method that returns the list of possible status strings for customers
4566 (see L<the status method|/status>). For example:
4568 @statuses = FS::cust_main->statuses();
4574 keys %{ $self->statuscolors };
4577 =item cust_status_sql
4579 Returns an SQL fragment to determine the status of a cust_main record, as a
4584 sub cust_status_sql {
4586 for my $status ( FS::cust_main->statuses() ) {
4587 my $method = $status.'_sql';
4588 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4597 Returns an SQL expression identifying prospective cust_main records (customers
4598 with no packages ever ordered)
4602 use vars qw($select_count_pkgs);
4603 $select_count_pkgs =
4604 "SELECT COUNT(*) FROM cust_pkg
4605 WHERE cust_pkg.custnum = cust_main.custnum";
4607 sub select_count_pkgs_sql {
4612 " 0 = ( $select_count_pkgs ) ";
4617 Returns an SQL expression identifying ordered cust_main records (customers with
4618 no active packages, but recurring packages not yet setup or one time charges
4624 FS::cust_main->none_active_sql.
4625 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4630 Returns an SQL expression identifying active cust_main records (customers with
4631 active recurring packages).
4636 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4639 =item none_active_sql
4641 Returns an SQL expression identifying cust_main records with no active
4642 recurring packages. This includes customers of status prospect, ordered,
4643 inactive, and suspended.
4647 sub none_active_sql {
4648 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4653 Returns an SQL expression identifying inactive cust_main records (customers with
4654 no active recurring packages, but otherwise unsuspended/uncancelled).
4659 FS::cust_main->none_active_sql.
4660 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4666 Returns an SQL expression identifying suspended cust_main records.
4671 sub suspended_sql { susp_sql(@_); }
4673 FS::cust_main->none_active_sql.
4674 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4680 Returns an SQL expression identifying cancelled cust_main records.
4684 sub cancel_sql { shift->cancelled_sql(@_); }
4687 =item uncancelled_sql
4689 Returns an SQL expression identifying un-cancelled cust_main records.
4693 sub uncancelled_sql { uncancel_sql(@_); }
4694 sub uncancel_sql { "
4695 ( 0 < ( $select_count_pkgs
4696 AND ( cust_pkg.cancel IS NULL
4697 OR cust_pkg.cancel = 0
4700 OR 0 = ( $select_count_pkgs )
4706 Returns an SQL fragment to retreive the balance.
4711 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4712 WHERE cust_bill.custnum = cust_main.custnum )
4713 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4714 WHERE cust_pay.custnum = cust_main.custnum )
4715 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4716 WHERE cust_credit.custnum = cust_main.custnum )
4717 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4718 WHERE cust_refund.custnum = cust_main.custnum )
4721 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4723 Returns an SQL fragment to retreive the balance for this customer, optionally
4724 considering invoices with date earlier than START_TIME, and not
4725 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4726 total_unapplied_payments).
4728 Times are specified as SQL fragments or numeric
4729 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4730 L<Date::Parse> for conversion functions. The empty string can be passed
4731 to disable that time constraint completely.
4733 Available options are:
4737 =item unapplied_date
4739 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)
4744 set to true to remove all customer comparison clauses, for totals
4749 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4754 JOIN clause (typically used with the total option)
4758 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4759 time will be ignored. Note that START_TIME and END_TIME only limit the date
4760 range for invoices and I<unapplied> payments, credits, and refunds.
4766 sub balance_date_sql {
4767 my( $class, $start, $end, %opt ) = @_;
4769 my $cutoff = $opt{'cutoff'};
4771 my $owed = FS::cust_bill->owed_sql($cutoff);
4772 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4773 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4774 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4776 my $j = $opt{'join'} || '';
4778 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4779 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4780 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4781 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4783 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4784 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4785 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4786 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4791 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4793 Returns an SQL fragment to retreive the total unapplied payments for this
4794 customer, only considering payments with date earlier than START_TIME, and
4795 optionally not later than END_TIME.
4797 Times are specified as SQL fragments or numeric
4798 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4799 L<Date::Parse> for conversion functions. The empty string can be passed
4800 to disable that time constraint completely.
4802 Available options are:
4806 sub unapplied_payments_date_sql {
4807 my( $class, $start, $end, %opt ) = @_;
4809 my $cutoff = $opt{'cutoff'};
4811 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4813 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4814 'unapplied_date'=>1 );
4816 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4819 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4821 Helper method for balance_date_sql; name (and usage) subject to change
4822 (suggestions welcome).
4824 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4825 cust_refund, cust_credit or cust_pay).
4827 If TABLE is "cust_bill" or the unapplied_date option is true, only
4828 considers records with date earlier than START_TIME, and optionally not
4829 later than END_TIME .
4833 sub _money_table_where {
4834 my( $class, $table, $start, $end, %opt ) = @_;
4837 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4838 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4839 push @where, "$table._date <= $start" if defined($start) && length($start);
4840 push @where, "$table._date > $end" if defined($end) && length($end);
4842 push @where, @{$opt{'where'}} if $opt{'where'};
4843 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4849 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4850 use FS::cust_main::Search;
4853 FS::cust_main::Search->search(@_);
4862 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4864 Generates a templated notification to the customer (see L<Text::Template>).
4866 OPTIONS is a hash and may include
4868 I<extra_fields> - a hashref of name/value pairs which will be substituted
4869 into the template. These values may override values mentioned below
4870 and those from the customer record.
4872 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
4874 The following variables are available in the template instead of or in addition
4875 to the fields of the customer record.
4877 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4881 # a lot like cust_bill::print_latex
4882 sub generate_letter {
4883 my ($self, $template, %options) = @_;
4885 warn "Template $template does not exist" && return
4886 unless $conf->exists($template) || $options{'template_text'};
4888 my $template_source = $options{'template_text'}
4889 ? [ $options{'template_text'} ]
4890 : [ map "$_\n", $conf->config($template) ];
4892 my $letter_template = new Text::Template
4894 SOURCE => $template_source,
4895 DELIMITERS => [ '[@--', '--@]' ],
4897 or die "can't create new Text::Template object: Text::Template::ERROR";
4899 $letter_template->compile()
4900 or die "can't compile template: Text::Template::ERROR";
4902 my %letter_data = map { $_ => $self->$_ } $self->fields;
4904 for (keys %{$options{extra_fields}}){
4905 $letter_data{$_} = $options{extra_fields}->{$_};
4908 unless(exists($letter_data{returnaddress})){
4909 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4910 $self->agent_template)
4912 if ( length($retadd) ) {
4913 $letter_data{returnaddress} = $retadd;
4914 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4915 $letter_data{returnaddress} =
4916 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4920 ( $conf->config('company_name', $self->agentnum),
4921 $conf->config('company_address', $self->agentnum),
4925 $letter_data{returnaddress} = '~';
4929 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4931 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4933 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4935 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4939 ) or die "can't open temp file: $!\n";
4940 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4941 or die "can't write temp file: $!\n";
4943 $letter_data{'logo_file'} = $lh->filename;
4945 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4949 ) or die "can't open temp file: $!\n";
4951 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4953 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4954 return ($1, $letter_data{'logo_file'});
4958 =item print_ps TEMPLATE
4960 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4966 my($file, $lfile) = $self->generate_letter(@_);
4967 my $ps = FS::Misc::generate_ps($file);
4968 unlink($file.'.tex');
4974 =item print TEMPLATE
4976 Prints the filled in template.
4978 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4982 sub queueable_print {
4985 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4986 or die "invalid customer number: " . $opt{custnum};
4988 #do not backport this change to 3.x
4989 # my $error = $self->print( { 'template' => $opt{template} } );
4990 my $error = $self->print( $opt{'template'} );
4991 die $error if $error;
4995 my ($self, $template) = (shift, shift);
4997 [ $self->print_ps($template) ],
4998 'agentnum' => $self->agentnum,
5002 #these three subs should just go away once agent stuff is all config overrides
5004 sub agent_template {
5006 $self->_agent_plandata('agent_templatename');
5009 sub agent_invoice_from {
5011 $self->_agent_plandata('agent_invoice_from');
5014 sub _agent_plandata {
5015 my( $self, $option ) = @_;
5017 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5018 #agent-specific Conf
5020 use FS::part_event::Condition;
5022 my $agentnum = $self->agentnum;
5024 my $regexp = regexp_sql();
5026 my $part_event_option =
5028 'select' => 'part_event_option.*',
5029 'table' => 'part_event_option',
5031 LEFT JOIN part_event USING ( eventpart )
5032 LEFT JOIN part_event_option AS peo_agentnum
5033 ON ( part_event.eventpart = peo_agentnum.eventpart
5034 AND peo_agentnum.optionname = 'agentnum'
5035 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5037 LEFT JOIN part_event_condition
5038 ON ( part_event.eventpart = part_event_condition.eventpart
5039 AND part_event_condition.conditionname = 'cust_bill_age'
5041 LEFT JOIN part_event_condition_option
5042 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5043 AND part_event_condition_option.optionname = 'age'
5046 #'hashref' => { 'optionname' => $option },
5047 #'hashref' => { 'part_event_option.optionname' => $option },
5049 " WHERE part_event_option.optionname = ". dbh->quote($option).
5050 " AND action = 'cust_bill_send_agent' ".
5051 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5052 " AND peo_agentnum.optionname = 'agentnum' ".
5053 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5055 CASE WHEN part_event_condition_option.optionname IS NULL
5057 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5059 , part_event.weight".
5063 unless ( $part_event_option ) {
5064 return $self->agent->invoice_template || ''
5065 if $option eq 'agent_templatename';
5069 $part_event_option->optionvalue;
5073 sub process_o2m_qsearch {
5076 return qsearch($table, @_) unless $table eq 'contact';
5078 my $hashref = shift;
5079 my %hash = %$hashref;
5080 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5081 or die 'guru meditation #4343';
5083 qsearch({ 'table' => 'contact',
5084 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5085 'hashref' => \%hash,
5086 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5087 " cust_contact.custnum = $custnum "
5091 sub process_o2m_qsearchs {
5094 return qsearchs($table, @_) unless $table eq 'contact';
5096 my $hashref = shift;
5097 my %hash = %$hashref;
5098 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5099 or die 'guru meditation #2121';
5101 qsearchs({ 'table' => 'contact',
5102 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5103 'hashref' => \%hash,
5104 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5105 " cust_contact.custnum = $custnum "
5109 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5111 Subroutine (not a method), designed to be called from the queue.
5113 Takes a list of options and values.
5115 Pulls up the customer record via the custnum option and calls bill_and_collect.
5120 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5122 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5123 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5125 #without this errors don't get rolled back
5126 $args{'fatal'} = 1; # runs from job queue, will be caught
5128 $cust_main->bill_and_collect( %args );
5131 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5133 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5134 C<collect> part. This is used in batch tax calculation, where invoice
5135 generation and collection events have to be completely separated.
5139 sub queued_collect {
5141 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5143 $cust_main->collect(%args);
5146 sub process_bill_and_collect {
5149 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5150 or die "custnum '$param->{custnum}' not found!\n";
5151 $param->{'job'} = $job;
5152 $param->{'fatal'} = 1; # runs from job queue, will be caught
5153 $param->{'retry'} = 1;
5155 $cust_main->bill_and_collect( %$param );
5158 #starting to take quite a while for big dbs
5159 # (JRNL: journaled so it only happens once per database)
5160 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5161 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5162 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5163 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5164 # JRNL leading/trailing spaces in first, last, company
5165 # JRNL migrate to cust_payby
5166 # - otaker upgrade? journal and call it good? (double check to make sure
5167 # we're not still setting otaker here)
5169 #only going to get worse with new location stuff...
5171 sub _upgrade_data { #class method
5172 my ($class, %opts) = @_;
5174 my @statements = ();
5176 #this seems to be the only expensive one.. why does it take so long?
5177 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5179 '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';
5180 FS::upgrade_journal->set_done('cust_main__signupdate');
5184 foreach my $sql ( @statements ) {
5185 my $sth = dbh->prepare($sql) or die dbh->errstr;
5186 $sth->execute or die $sth->errstr;
5187 #warn ( (time - $t). " seconds\n" );
5191 local($ignore_expired_card) = 1;
5192 local($ignore_banned_card) = 1;
5193 local($skip_fuzzyfiles) = 1;
5194 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5196 FS::cust_main::Location->_upgrade_data(%opts);
5198 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5200 foreach my $cust_main ( qsearch({
5201 'table' => 'cust_main',
5203 'extra_sql' => 'WHERE '.
5205 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5206 qw( first last company )
5209 my $error = $cust_main->replace;
5210 die $error if $error;
5213 FS::upgrade_journal->set_done('cust_main__trimspaces');
5217 $class->_upgrade_otaker(%opts);
5227 The delete method should possibly take an FS::cust_main object reference
5228 instead of a scalar customer number.
5230 Bill and collect options should probably be passed as references instead of a
5233 There should probably be a configuration file with a list of allowed credit
5236 No multiple currency support (probably a larger project than just this module).
5238 Birthdates rely on negative epoch values.
5240 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5244 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5245 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5246 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.