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);
33 use FS::UID qw( dbh driver_name );
34 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
36 use FS::Misc qw( generate_ps do_print money_pretty card_types );
37 use FS::Msgcat qw(gettext);
44 use FS::cust_bill_void;
45 use FS::legacy_cust_bill;
47 use FS::cust_pay_pending;
48 use FS::cust_pay_void;
49 use FS::cust_pay_batch;
52 use FS::part_referral;
53 use FS::cust_main_county;
54 use FS::cust_location;
57 use FS::cust_main_exemption;
58 use FS::cust_tax_adjustment;
59 use FS::cust_tax_location;
60 use FS::agent_currency;
61 use FS::cust_main_invoice;
63 use FS::prepay_credit;
69 use FS::payment_gateway;
70 use FS::agent_payment_gateway;
72 use FS::cust_main_note;
73 use FS::cust_attachment;
76 use FS::upgrade_journal;
82 # 1 is mostly method/subroutine entry and options
83 # 2 traces progress of some operations
84 # 3 is even more information including possibly sensitive data
86 our $me = '[FS::cust_main]';
89 our $ignore_expired_card = 0;
90 our $ignore_banned_card = 0;
91 our $ignore_invalid_card = 0;
93 our $skip_fuzzyfiles = 0;
95 our $ucfirst_nowarn = 0;
97 #this info is in cust_payby as of 4.x
98 #this and the fields themselves can be removed in 5.x
99 our @encrypted_fields = ('payinfo', 'paycvv');
100 sub nohistory_fields { ('payinfo', 'paycvv'); }
103 our $default_agent_custid;
104 our $custnum_display_length;
105 #ask FS::UID to run this stuff for us later
106 #$FS::UID::callback{'FS::cust_main'} = sub {
107 install_callback FS::UID sub {
108 $conf = new FS::Conf;
109 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
110 $default_agent_custid = $conf->exists('cust_main-default_agent_custid');
111 $custnum_display_length = $conf->config('cust_main-custnum-display_length');
116 my ( $hashref, $cache ) = @_;
117 if ( exists $hashref->{'pkgnum'} ) {
118 #@{ $self->{'_pkgnum'} } = ();
119 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
120 $self->{'_pkgnum'} = $subcache;
121 #push @{ $self->{'_pkgnum'} },
122 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
128 FS::cust_main - Object methods for cust_main records
134 $record = new FS::cust_main \%hash;
135 $record = new FS::cust_main { 'column' => 'value' };
137 $error = $record->insert;
139 $error = $new_record->replace($old_record);
141 $error = $record->delete;
143 $error = $record->check;
145 @cust_pkg = $record->all_pkgs;
147 @cust_pkg = $record->ncancelled_pkgs;
149 @cust_pkg = $record->suspended_pkgs;
151 $error = $record->bill;
152 $error = $record->bill %options;
153 $error = $record->bill 'time' => $time;
155 $error = $record->collect;
156 $error = $record->collect %options;
157 $error = $record->collect 'invoice_time' => $time,
162 An FS::cust_main object represents a customer. FS::cust_main inherits from
163 FS::Record. The following fields are currently supported:
169 Primary key (assigned automatically for new customers)
173 Agent (see L<FS::agent>)
177 Advertising source (see L<FS::part_referral>)
189 Cocial security number (optional)
213 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
217 Payment Information (See L<FS::payinfo_Mixin> for data format)
221 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
225 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
229 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
233 Start date month (maestro/solo cards only)
237 Start date year (maestro/solo cards only)
241 Issue number (maestro/solo cards only)
245 Name on card or billing name
249 IP address from which payment information was received
253 Tax exempt, empty or `Y'
257 Order taker (see L<FS::access_user>)
263 =item referral_custnum
265 Referring customer number
269 Enable individual CDR spooling, empty or `Y'
273 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
277 Discourage individual CDR printing, empty or `Y'
281 Allow self-service editing of ticket subjects, empty or 'Y'
283 =item calling_list_exempt
285 Do not call, empty or 'Y'
287 =item invoice_ship_address
289 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
299 Creates a new customer. To add the customer to the database, see L<"insert">.
301 Note that this stores the hash reference, not a distinct copy of the hash it
302 points to. You can ask the object for a copy with the I<hash> method.
306 sub table { 'cust_main'; }
308 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
310 Adds this customer to the database. If there is an error, returns the error,
311 otherwise returns false.
313 Usually the customer's location will not yet exist in the database, and
314 the C<bill_location> and C<ship_location> pseudo-fields must be set to
315 uninserted L<FS::cust_location> objects. These will be inserted and linked
316 (in both directions) to the new customer record. If they're references
317 to the same object, they will become the same location.
319 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
320 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
321 are inserted atomicly, or the transaction is rolled back. Passing an empty
322 hash reference is equivalent to not supplying this parameter. There should be
323 a better explanation of this, but until then, here's an example:
326 tie %hash, 'Tie::RefHash'; #this part is important
328 $cust_pkg => [ $svc_acct ],
331 $cust_main->insert( \%hash );
333 INVOICING_LIST_ARYREF: No longer supported.
335 Currently available options are: I<depend_jobnum>, I<noexport>,
336 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
338 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
339 on the supplied jobnum (they will not run until the specific job completes).
340 This can be used to defer provisioning until some action completes (such
341 as running the customer's credit card successfully).
343 The I<noexport> option is deprecated. If I<noexport> is set true, no
344 provisioning jobs (exports) are scheduled. (You can schedule them later with
345 the B<reexport> method.)
347 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
348 of tax names and exemption numbers. FS::cust_main_exemption records will be
349 created and inserted.
351 If I<prospectnum> is set, moves contacts and locations from that prospect.
353 If I<contact> is set to an arrayref of FS::contact objects, those will be
356 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
357 unset), inserts those new contacts with this new customer. Handles CGI
358 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
360 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
361 new stored payment records with this new customer. Handles CGI parameters
362 for an "m2" multiple entry field as passed by edit/cust_main.cgi
368 my $cust_pkgs = @_ ? shift : {};
370 if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
371 warn "cust_main::insert using deprecated invoicing list argument";
372 $invoicing_list = shift;
375 warn "$me insert called with options ".
376 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
379 local $SIG{HUP} = 'IGNORE';
380 local $SIG{INT} = 'IGNORE';
381 local $SIG{QUIT} = 'IGNORE';
382 local $SIG{TERM} = 'IGNORE';
383 local $SIG{TSTP} = 'IGNORE';
384 local $SIG{PIPE} = 'IGNORE';
386 my $oldAutoCommit = $FS::UID::AutoCommit;
387 local $FS::UID::AutoCommit = 0;
390 my $prepay_identifier = '';
391 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
393 if ( $self->payby eq 'PREPAY' ) {
395 $self->payby(''); #'BILL');
396 $prepay_identifier = $self->payinfo;
399 warn " looking up prepaid card $prepay_identifier\n"
402 my $error = $self->get_prepay( $prepay_identifier,
403 'amount_ref' => \$amount,
404 'seconds_ref' => \$seconds,
405 'upbytes_ref' => \$upbytes,
406 'downbytes_ref' => \$downbytes,
407 'totalbytes_ref' => \$totalbytes,
410 $dbh->rollback if $oldAutoCommit;
411 #return "error applying prepaid card (transaction rolled back): $error";
415 $payby = 'PREP' if $amount;
417 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
420 $self->payby(''); #'BILL');
421 $amount = $self->paid;
426 foreach my $l (qw(bill_location ship_location)) {
428 my $loc = delete $self->hashref->{$l} or next;
430 if ( !$loc->locationnum ) {
431 # warn the location that we're going to insert it with no custnum
432 $loc->set(custnum_pending => 1);
433 warn " inserting $l\n"
435 my $error = $loc->insert;
437 $dbh->rollback if $oldAutoCommit;
438 my $label = $l eq 'ship_location' ? 'service' : 'billing';
439 return "$error (in $label location)";
442 } elsif ( $loc->prospectnum ) {
444 $loc->prospectnum('');
445 $loc->set(custnum_pending => 1);
446 my $error = $loc->replace;
448 $dbh->rollback if $oldAutoCommit;
449 my $label = $l eq 'ship_location' ? 'service' : 'billing';
450 return "$error (moving $label location)";
453 } elsif ( ($loc->custnum || 0) > 0 ) {
454 # then it somehow belongs to another customer--shouldn't happen
455 $dbh->rollback if $oldAutoCommit;
456 return "$l belongs to customer ".$loc->custnum;
458 # else it already belongs to this customer
459 # (happens when ship_location is identical to bill_location)
461 $self->set($l.'num', $loc->locationnum);
463 if ( $self->get($l.'num') eq '' ) {
464 $dbh->rollback if $oldAutoCommit;
469 warn " inserting $self\n"
472 $self->signupdate(time) unless $self->signupdate;
474 $self->auto_agent_custid()
475 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
477 my $error = $self->check_payinfo_cardtype
478 || $self->SUPER::insert;
480 $dbh->rollback if $oldAutoCommit;
481 #return "inserting cust_main record (transaction rolled back): $error";
485 # now set cust_location.custnum
486 foreach my $l (qw(bill_location ship_location)) {
487 warn " setting $l.custnum\n"
489 my $loc = $self->$l or next;
490 unless ( $loc->custnum ) {
491 $loc->set(custnum => $self->custnum);
492 $error ||= $loc->replace;
496 $dbh->rollback if $oldAutoCommit;
497 return "error setting $l custnum: $error";
501 warn " setting customer tags\n"
504 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
505 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
506 'custnum' => $self->custnum };
507 my $error = $cust_tag->insert;
509 $dbh->rollback if $oldAutoCommit;
514 my $prospectnum = delete $options{'prospectnum'};
515 if ( $prospectnum ) {
517 warn " moving contacts and locations from prospect $prospectnum\n"
521 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
522 unless ( $prospect_main ) {
523 $dbh->rollback if $oldAutoCommit;
524 return "Unknown prospectnum $prospectnum";
526 $prospect_main->custnum($self->custnum);
527 $prospect_main->disabled('Y');
528 my $error = $prospect_main->replace;
530 $dbh->rollback if $oldAutoCommit;
534 foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
535 my $cust_contact = new FS::cust_contact {
536 'custnum' => $self->custnum,
537 'invoice_dest' => 'Y', # invoice_dest currently not set for prospect contacts
538 map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
540 my $error = $cust_contact->insert
541 || $prospect_contact->delete;
543 $dbh->rollback if $oldAutoCommit;
548 my @cust_location = $prospect_main->cust_location;
549 my @qual = $prospect_main->qual;
551 foreach my $r ( @cust_location, @qual ) {
553 $r->custnum($self->custnum);
554 my $error = $r->replace;
556 $dbh->rollback if $oldAutoCommit;
560 # since we set invoice_dest on all migrated prospect contacts (for now),
561 # don't process invoicing_list.
562 delete $options{'invoicing_list'};
563 $invoicing_list = undef;
566 warn " setting contacts\n"
569 $invoicing_list ||= $options{'invoicing_list'};
570 if ( $invoicing_list ) {
572 $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
575 foreach my $dest (@$invoicing_list ) {
576 if ($dest eq 'POST') {
577 $self->set('postal_invoice', 'Y');
580 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
581 if ( $contact_email ) {
582 my $cust_contact = FS::cust_contact->new({
583 contactnum => $contact_email->contactnum,
584 custnum => $self->custnum,
586 $cust_contact->set('invoice_dest', 'Y');
587 my $error = $cust_contact->insert;
589 $dbh->rollback if $oldAutoCommit;
590 return "$error (linking to email address $dest)";
594 # this email address is not yet linked to any contact
595 $email .= ',' if length($email);
603 my $contact = FS::contact->new({
604 'custnum' => $self->get('custnum'),
605 'last' => $self->get('last'),
606 'first' => $self->get('first'),
607 'emailaddress' => $email,
608 'invoice_dest' => 'Y', # yes, you can set this via the contact
610 my $error = $contact->insert;
612 $dbh->rollback if $oldAutoCommit;
620 if ( my $contact = delete $options{'contact'} ) {
622 foreach my $c ( @$contact ) {
623 $c->custnum($self->custnum);
624 my $error = $c->insert;
626 $dbh->rollback if $oldAutoCommit;
632 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
634 my $error = $self->process_o2m( 'table' => 'contact',
635 'fields' => FS::contact->cgi_contact_fields,
636 'params' => $contact_params,
639 $dbh->rollback if $oldAutoCommit;
644 warn " setting cust_payby\n"
647 if ( $options{cust_payby} ) {
649 foreach my $cust_payby ( @{ $options{cust_payby} } ) {
650 $cust_payby->custnum($self->custnum);
651 my $error = $cust_payby->insert;
653 $dbh->rollback if $oldAutoCommit;
658 } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
660 my $error = $self->process_o2m(
661 'table' => 'cust_payby',
662 'fields' => FS::cust_payby->cgi_cust_payby_fields,
663 'params' => $cust_payby_params,
664 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
667 $dbh->rollback if $oldAutoCommit;
673 warn " setting cust_main_exemption\n"
676 my $tax_exemption = delete $options{'tax_exemption'};
677 if ( $tax_exemption ) {
679 $tax_exemption = { map { $_ => '' } @$tax_exemption }
680 if ref($tax_exemption) eq 'ARRAY';
682 foreach my $taxname ( keys %$tax_exemption ) {
683 my $cust_main_exemption = new FS::cust_main_exemption {
684 'custnum' => $self->custnum,
685 'taxname' => $taxname,
686 'exempt_number' => $tax_exemption->{$taxname},
688 my $error = $cust_main_exemption->insert;
690 $dbh->rollback if $oldAutoCommit;
691 return "inserting cust_main_exemption (transaction rolled back): $error";
696 warn " ordering packages\n"
699 $error = $self->order_pkgs( $cust_pkgs,
701 'seconds_ref' => \$seconds,
702 'upbytes_ref' => \$upbytes,
703 'downbytes_ref' => \$downbytes,
704 'totalbytes_ref' => \$totalbytes,
707 $dbh->rollback if $oldAutoCommit;
712 $dbh->rollback if $oldAutoCommit;
713 return "No svc_acct record to apply pre-paid time";
715 if ( $upbytes || $downbytes || $totalbytes ) {
716 $dbh->rollback if $oldAutoCommit;
717 return "No svc_acct record to apply pre-paid data";
721 warn " inserting initial $payby payment of $amount\n"
723 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
725 $dbh->rollback if $oldAutoCommit;
726 return "inserting payment (transaction rolled back): $error";
730 unless ( $import || $skip_fuzzyfiles ) {
731 warn " queueing fuzzyfiles update\n"
733 $error = $self->queue_fuzzyfiles_update;
735 $dbh->rollback if $oldAutoCommit;
736 return "updating fuzzy search cache: $error";
740 # FS::geocode_Mixin::after_insert or something?
741 if ( $conf->config('tax_district_method') and !$import ) {
742 # if anything non-empty, try to look it up
743 my $queue = new FS::queue {
744 'job' => 'FS::geocode_Mixin::process_district_update',
745 'custnum' => $self->custnum,
747 my $error = $queue->insert( ref($self), $self->custnum );
749 $dbh->rollback if $oldAutoCommit;
750 return "queueing tax district update: $error";
755 warn " exporting\n" if $DEBUG > 1;
757 my $export_args = $options{'export_args'} || [];
760 map qsearch( 'part_export', {exportnum=>$_} ),
761 $conf->config('cust_main-exports'); #, $agentnum
763 foreach my $part_export ( @part_export ) {
764 my $error = $part_export->export_insert($self, @$export_args);
766 $dbh->rollback if $oldAutoCommit;
767 return "exporting to ". $part_export->exporttype.
768 " (transaction rolled back): $error";
772 #foreach my $depend_jobnum ( @$depend_jobnums ) {
773 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
775 # foreach my $jobnum ( @jobnums ) {
776 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
777 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
779 # my $error = $queue->depend_insert($depend_jobnum);
781 # $dbh->rollback if $oldAutoCommit;
782 # return "error queuing job dependancy: $error";
789 #if ( exists $options{'jobnums'} ) {
790 # push @{ $options{'jobnums'} }, @jobnums;
793 warn " insert complete; committing transaction\n"
796 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
801 use File::CounterFile;
802 sub auto_agent_custid {
805 my $format = $conf->config('cust_main-auto_agent_custid');
807 if ( $format eq '1YMMXXXXXXXX' ) {
809 my $counter = new File::CounterFile 'cust_main.agent_custid';
812 my $ym = 100000000000 + time2str('%y%m00000000', time);
813 if ( $ym > $counter->value ) {
814 $counter->{'value'} = $agent_custid = $ym;
815 $counter->{'updated'} = 1;
817 $agent_custid = $counter->inc;
823 die "Unknown cust_main-auto_agent_custid format: $format";
826 $self->agent_custid($agent_custid);
830 =item PACKAGE METHODS
832 Documentation on customer package methods has been moved to
833 L<FS::cust_main::Packages>.
835 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
837 Recharges this (existing) customer with the specified prepaid card (see
838 L<FS::prepay_credit>), specified either by I<identifier> or as an
839 FS::prepay_credit object. If there is an error, returns the error, otherwise
842 Optionally, five scalar references can be passed as well. They will have their
843 values filled in with the amount, number of seconds, and number of upload,
844 download, and total bytes applied by this prepaid card.
848 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
849 #the only place that uses these args
850 sub recharge_prepay {
851 my( $self, $prepay_credit, $amountref, $secondsref,
852 $upbytesref, $downbytesref, $totalbytesref ) = @_;
854 local $SIG{HUP} = 'IGNORE';
855 local $SIG{INT} = 'IGNORE';
856 local $SIG{QUIT} = 'IGNORE';
857 local $SIG{TERM} = 'IGNORE';
858 local $SIG{TSTP} = 'IGNORE';
859 local $SIG{PIPE} = 'IGNORE';
861 my $oldAutoCommit = $FS::UID::AutoCommit;
862 local $FS::UID::AutoCommit = 0;
865 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
867 my $error = $self->get_prepay( $prepay_credit,
868 'amount_ref' => \$amount,
869 'seconds_ref' => \$seconds,
870 'upbytes_ref' => \$upbytes,
871 'downbytes_ref' => \$downbytes,
872 'totalbytes_ref' => \$totalbytes,
874 || $self->increment_seconds($seconds)
875 || $self->increment_upbytes($upbytes)
876 || $self->increment_downbytes($downbytes)
877 || $self->increment_totalbytes($totalbytes)
878 || $self->insert_cust_pay_prepay( $amount,
880 ? $prepay_credit->identifier
885 $dbh->rollback if $oldAutoCommit;
889 if ( defined($amountref) ) { $$amountref = $amount; }
890 if ( defined($secondsref) ) { $$secondsref = $seconds; }
891 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
892 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
893 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
895 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
900 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
902 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
903 specified either by I<identifier> or as an FS::prepay_credit object.
905 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
906 incremented by the values of the prepaid card.
908 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
909 check or set this customer's I<agentnum>.
911 If there is an error, returns the error, otherwise returns false.
917 my( $self, $prepay_credit, %opt ) = @_;
919 local $SIG{HUP} = 'IGNORE';
920 local $SIG{INT} = 'IGNORE';
921 local $SIG{QUIT} = 'IGNORE';
922 local $SIG{TERM} = 'IGNORE';
923 local $SIG{TSTP} = 'IGNORE';
924 local $SIG{PIPE} = 'IGNORE';
926 my $oldAutoCommit = $FS::UID::AutoCommit;
927 local $FS::UID::AutoCommit = 0;
930 unless ( ref($prepay_credit) ) {
932 my $identifier = $prepay_credit;
934 $prepay_credit = qsearchs(
936 { 'identifier' => $identifier },
941 unless ( $prepay_credit ) {
942 $dbh->rollback if $oldAutoCommit;
943 return "Invalid prepaid card: ". $identifier;
948 if ( $prepay_credit->agentnum ) {
949 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
950 $dbh->rollback if $oldAutoCommit;
951 return "prepaid card not valid for agent ". $self->agentnum;
953 $self->agentnum($prepay_credit->agentnum);
956 my $error = $prepay_credit->delete;
958 $dbh->rollback if $oldAutoCommit;
959 return "removing prepay_credit (transaction rolled back): $error";
962 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
963 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
965 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
970 =item increment_upbytes SECONDS
972 Updates this customer's single or primary account (see L<FS::svc_acct>) by
973 the specified number of upbytes. If there is an error, returns the error,
974 otherwise returns false.
978 sub increment_upbytes {
979 _increment_column( shift, 'upbytes', @_);
982 =item increment_downbytes SECONDS
984 Updates this customer's single or primary account (see L<FS::svc_acct>) by
985 the specified number of downbytes. If there is an error, returns the error,
986 otherwise returns false.
990 sub increment_downbytes {
991 _increment_column( shift, 'downbytes', @_);
994 =item increment_totalbytes SECONDS
996 Updates this customer's single or primary account (see L<FS::svc_acct>) by
997 the specified number of totalbytes. If there is an error, returns the error,
998 otherwise returns false.
1002 sub increment_totalbytes {
1003 _increment_column( shift, 'totalbytes', @_);
1006 =item increment_seconds SECONDS
1008 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1009 the specified number of seconds. If there is an error, returns the error,
1010 otherwise returns false.
1014 sub increment_seconds {
1015 _increment_column( shift, 'seconds', @_);
1018 =item _increment_column AMOUNT
1020 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1021 the specified number of seconds or bytes. If there is an error, returns
1022 the error, otherwise returns false.
1026 sub _increment_column {
1027 my( $self, $column, $amount ) = @_;
1028 warn "$me increment_column called: $column, $amount\n"
1031 return '' unless $amount;
1033 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1034 $self->ncancelled_pkgs;
1036 if ( ! @cust_pkg ) {
1037 return 'No packages with primary or single services found'.
1038 ' to apply pre-paid time';
1039 } elsif ( scalar(@cust_pkg) > 1 ) {
1040 #maybe have a way to specify the package/account?
1041 return 'Multiple packages found to apply pre-paid time';
1044 my $cust_pkg = $cust_pkg[0];
1045 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1049 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1051 if ( ! @cust_svc ) {
1052 return 'No account found to apply pre-paid time';
1053 } elsif ( scalar(@cust_svc) > 1 ) {
1054 return 'Multiple accounts found to apply pre-paid time';
1057 my $svc_acct = $cust_svc[0]->svc_x;
1058 warn " found service svcnum ". $svc_acct->pkgnum.
1059 ' ('. $svc_acct->email. ")\n"
1062 $column = "increment_$column";
1063 $svc_acct->$column($amount);
1067 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1069 Inserts a prepayment in the specified amount for this customer. An optional
1070 second argument can specify the prepayment identifier for tracking purposes.
1071 If there is an error, returns the error, otherwise returns false.
1075 sub insert_cust_pay_prepay {
1076 shift->insert_cust_pay('PREP', @_);
1079 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1081 Inserts a cash payment in the specified amount for this customer. An optional
1082 second argument can specify the payment identifier for tracking purposes.
1083 If there is an error, returns the error, otherwise returns false.
1087 sub insert_cust_pay_cash {
1088 shift->insert_cust_pay('CASH', @_);
1091 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1093 Inserts a Western Union payment in the specified amount for this customer. An
1094 optional second argument can specify the prepayment identifier for tracking
1095 purposes. If there is an error, returns the error, otherwise returns false.
1099 sub insert_cust_pay_west {
1100 shift->insert_cust_pay('WEST', @_);
1103 sub insert_cust_pay {
1104 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1105 my $payinfo = scalar(@_) ? shift : '';
1107 my $cust_pay = new FS::cust_pay {
1108 'custnum' => $self->custnum,
1109 'paid' => sprintf('%.2f', $amount),
1110 #'_date' => #date the prepaid card was purchased???
1112 'payinfo' => $payinfo,
1118 =item delete [ OPTION => VALUE ... ]
1120 This deletes the customer. If there is an error, returns the error, otherwise
1123 This will completely remove all traces of the customer record. This is not
1124 what you want when a customer cancels service; for that, cancel all of the
1125 customer's packages (see L</cancel>).
1127 If the customer has any uncancelled packages, you need to pass a new (valid)
1128 customer number for those packages to be transferred to, as the "new_customer"
1129 option. Cancelled packages will be deleted. Did I mention that this is NOT
1130 what you want when a customer cancels service and that you really should be
1131 looking at L<FS::cust_pkg/cancel>?
1133 You can't delete a customer with invoices (see L<FS::cust_bill>),
1134 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1135 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1136 set the "delete_financials" option to a true value.
1141 my( $self, %opt ) = @_;
1143 local $SIG{HUP} = 'IGNORE';
1144 local $SIG{INT} = 'IGNORE';
1145 local $SIG{QUIT} = 'IGNORE';
1146 local $SIG{TERM} = 'IGNORE';
1147 local $SIG{TSTP} = 'IGNORE';
1148 local $SIG{PIPE} = 'IGNORE';
1150 my $oldAutoCommit = $FS::UID::AutoCommit;
1151 local $FS::UID::AutoCommit = 0;
1154 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1155 $dbh->rollback if $oldAutoCommit;
1156 return "Can't delete a master agent customer";
1159 #use FS::access_user
1160 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1161 $dbh->rollback if $oldAutoCommit;
1162 return "Can't delete a master employee customer";
1165 tie my %financial_tables, 'Tie::IxHash',
1166 'cust_bill' => 'invoices',
1167 'cust_statement' => 'statements',
1168 'cust_credit' => 'credits',
1169 'cust_pay' => 'payments',
1170 'cust_refund' => 'refunds',
1173 foreach my $table ( keys %financial_tables ) {
1175 my @records = $self->$table();
1177 if ( @records && ! $opt{'delete_financials'} ) {
1178 $dbh->rollback if $oldAutoCommit;
1179 return "Can't delete a customer with ". $financial_tables{$table};
1182 foreach my $record ( @records ) {
1183 my $error = $record->delete;
1185 $dbh->rollback if $oldAutoCommit;
1186 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1192 my @cust_pkg = $self->ncancelled_pkgs;
1194 my $new_custnum = $opt{'new_custnum'};
1195 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1196 $dbh->rollback if $oldAutoCommit;
1197 return "Invalid new customer number: $new_custnum";
1199 foreach my $cust_pkg ( @cust_pkg ) {
1200 my %hash = $cust_pkg->hash;
1201 $hash{'custnum'} = $new_custnum;
1202 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1203 my $error = $new_cust_pkg->replace($cust_pkg,
1204 options => { $cust_pkg->options },
1207 $dbh->rollback if $oldAutoCommit;
1212 my @cancelled_cust_pkg = $self->all_pkgs;
1213 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1214 my $error = $cust_pkg->delete;
1216 $dbh->rollback if $oldAutoCommit;
1221 #cust_tax_adjustment in financials?
1222 #cust_pay_pending? ouch
1223 foreach my $table (qw(
1224 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1225 cust_payby cust_location cust_main_note cust_tax_adjustment
1226 cust_pay_void cust_pay_batch queue cust_tax_exempt
1228 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1229 my $error = $record->delete;
1231 $dbh->rollback if $oldAutoCommit;
1237 my $sth = $dbh->prepare(
1238 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1240 my $errstr = $dbh->errstr;
1241 $dbh->rollback if $oldAutoCommit;
1244 $sth->execute($self->custnum) or do {
1245 my $errstr = $sth->errstr;
1246 $dbh->rollback if $oldAutoCommit;
1252 my $ticket_dbh = '';
1253 if ($conf->config('ticket_system') eq 'RT_Internal') {
1255 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1256 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1257 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1258 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1261 if ( $ticket_dbh ) {
1263 my $ticket_sth = $ticket_dbh->prepare(
1264 'DELETE FROM Links WHERE Target = ?'
1266 my $errstr = $ticket_dbh->errstr;
1267 $dbh->rollback if $oldAutoCommit;
1270 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1272 my $errstr = $ticket_sth->errstr;
1273 $dbh->rollback if $oldAutoCommit;
1277 #check and see if the customer is the only link on the ticket, and
1278 #if so, set the ticket to deleted status in RT?
1279 #maybe someday, for now this will at least fix tickets not displaying
1283 #delete the customer record
1285 my $error = $self->SUPER::delete;
1287 $dbh->rollback if $oldAutoCommit;
1291 # cust_main exports!
1293 #my $export_args = $options{'export_args'} || [];
1296 map qsearch( 'part_export', {exportnum=>$_} ),
1297 $conf->config('cust_main-exports'); #, $agentnum
1299 foreach my $part_export ( @part_export ) {
1300 my $error = $part_export->export_delete( $self ); #, @$export_args);
1302 $dbh->rollback if $oldAutoCommit;
1303 return "exporting to ". $part_export->exporttype.
1304 " (transaction rolled back): $error";
1308 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1313 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1315 Replaces the OLD_RECORD with this one in the database. If there is an error,
1316 returns the error, otherwise returns false.
1318 To change the customer's address, set the pseudo-fields C<bill_location> and
1319 C<ship_location>. The address will still only change if at least one of the
1320 address fields differs from the existing values.
1322 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1323 set as the contact email address for a default contact with the same name as
1326 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1327 I<contact_params>, I<invoicing_list>.
1329 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1330 of tax names and exemption numbers. FS::cust_main_exemption records will be
1331 deleted and inserted as appropriate.
1333 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1334 groups (describing the customer's payment methods and contacts, respectively)
1335 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1336 and L<FS::contact> for the fields these can contain.
1338 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1339 should be used instead if possible.
1346 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1348 : $self->replace_old;
1352 warn "$me replace called\n"
1355 my $curuser = $FS::CurrentUser::CurrentUser;
1356 return "You are not permitted to create complimentary accounts."
1357 if $self->complimentary eq 'Y'
1358 && $self->complimentary ne $old->complimentary
1359 && ! $curuser->access_right('Complimentary customer');
1361 local($ignore_expired_card) = 1
1362 if $old->payby =~ /^(CARD|DCRD)$/
1363 && $self->payby =~ /^(CARD|DCRD)$/
1364 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1366 local($ignore_banned_card) = 1
1367 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1368 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1369 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1371 if ( $self->payby =~ /^(CARD|DCRD)$/
1372 && $old->payinfo ne $self->payinfo
1373 && $old->paymask ne $self->paymask )
1375 my $error = $self->check_payinfo_cardtype;
1376 return $error if $error;
1379 return "Invoicing locale is required"
1382 && $conf->exists('cust_main-require_locale');
1384 local $SIG{HUP} = 'IGNORE';
1385 local $SIG{INT} = 'IGNORE';
1386 local $SIG{QUIT} = 'IGNORE';
1387 local $SIG{TERM} = 'IGNORE';
1388 local $SIG{TSTP} = 'IGNORE';
1389 local $SIG{PIPE} = 'IGNORE';
1391 my $oldAutoCommit = $FS::UID::AutoCommit;
1392 local $FS::UID::AutoCommit = 0;
1395 for my $l (qw(bill_location ship_location)) {
1396 #my $old_loc = $old->$l;
1397 my $new_loc = $self->$l or next;
1399 # find the existing location if there is one
1400 $new_loc->set('custnum' => $self->custnum);
1401 my $error = $new_loc->find_or_insert;
1403 $dbh->rollback if $oldAutoCommit;
1406 $self->set($l.'num', $new_loc->locationnum);
1410 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1411 warn "cust_main::replace: using deprecated invoicing list argument";
1412 $invoicing_list = shift @param;
1415 my %options = @param;
1417 $invoicing_list ||= $options{invoicing_list};
1419 my @contacts = map { $_->contact } $self->cust_contact;
1420 # find a contact that matches the customer's name
1421 my ($implicit_contact) = grep { $_->first eq $old->get('first')
1422 and $_->last eq $old->get('last') }
1424 $implicit_contact ||= FS::contact->new({
1425 'custnum' => $self->custnum,
1426 'locationnum' => $self->get('bill_locationnum'),
1429 # for any of these that are already contact emails, link to the existing
1431 if ( $invoicing_list ) {
1434 # kind of like process_m2m on these, except:
1435 # - the other side is two tables in a join
1436 # - and we might have to create new contact_emails
1437 # - and possibly a new contact
1439 # Find existing invoice emails that aren't on the implicit contact.
1440 # Any of these that are not on the new invoicing list will be removed.
1441 my %old_email_cust_contact;
1442 foreach my $cust_contact ($self->cust_contact) {
1443 next if !$cust_contact->invoice_dest;
1444 next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1446 foreach my $contact_email ($cust_contact->contact->contact_email) {
1447 $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1451 foreach my $dest (@$invoicing_list) {
1453 if ($dest eq 'POST') {
1455 $self->set('postal_invoice', 'Y');
1457 } elsif ( exists($old_email_cust_contact{$dest}) ) {
1459 delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1463 # See if it belongs to some other contact; if so, link it.
1464 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1466 and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1467 my $cust_contact = qsearchs('cust_contact', {
1468 contactnum => $contact_email->contactnum,
1469 custnum => $self->custnum,
1470 }) || FS::cust_contact->new({
1471 contactnum => $contact_email->contactnum,
1472 custnum => $self->custnum,
1474 $cust_contact->set('invoice_dest', 'Y');
1475 my $error = $cust_contact->custcontactnum ?
1476 $cust_contact->replace : $cust_contact->insert;
1478 $dbh->rollback if $oldAutoCommit;
1479 return "$error (linking to email address $dest)";
1483 # This email address is not yet linked to any contact, so it will
1484 # be added to the implicit contact.
1485 $email .= ',' if length($email);
1491 foreach my $remove_dest (keys %old_email_cust_contact) {
1492 my $cust_contact = $old_email_cust_contact{$remove_dest};
1493 # These were not in the list of requested destinations, so take them off.
1494 $cust_contact->set('invoice_dest', '');
1495 my $error = $cust_contact->replace;
1497 $dbh->rollback if $oldAutoCommit;
1498 return "$error (unlinking email address $remove_dest)";
1502 # make sure it keeps up with the changed customer name, if any
1503 $implicit_contact->set('last', $self->get('last'));
1504 $implicit_contact->set('first', $self->get('first'));
1505 $implicit_contact->set('emailaddress', $email);
1506 $implicit_contact->set('invoice_dest', 'Y');
1507 $implicit_contact->set('custnum', $self->custnum);
1510 if ( $implicit_contact->contactnum ) {
1511 $error = $implicit_contact->replace;
1512 } elsif ( length($email) ) { # don't create a new contact if not needed
1513 $error = $implicit_contact->insert;
1517 $dbh->rollback if $oldAutoCommit;
1518 return "$error (adding email address $email)";
1523 # replace the customer record
1524 my $error = $self->SUPER::replace($old);
1527 $dbh->rollback if $oldAutoCommit;
1531 # now move packages to the new service location
1532 $self->set('ship_location', ''); #flush cache
1533 if ( $old->ship_locationnum and # should only be null during upgrade...
1534 $old->ship_locationnum != $self->ship_locationnum ) {
1535 $error = $old->ship_location->move_to($self->ship_location);
1537 $dbh->rollback if $oldAutoCommit;
1541 # don't move packages based on the billing location, but
1542 # disable it if it's no longer in use
1543 if ( $old->bill_locationnum and
1544 $old->bill_locationnum != $self->bill_locationnum ) {
1545 $error = $old->bill_location->disable_if_unused;
1547 $dbh->rollback if $oldAutoCommit;
1552 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1554 #this could be more efficient than deleting and re-inserting, if it matters
1555 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1556 my $error = $cust_tag->delete;
1558 $dbh->rollback if $oldAutoCommit;
1562 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1563 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1564 'custnum' => $self->custnum };
1565 my $error = $cust_tag->insert;
1567 $dbh->rollback if $oldAutoCommit;
1574 my $tax_exemption = delete $options{'tax_exemption'};
1575 if ( $tax_exemption ) {
1577 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1578 if ref($tax_exemption) eq 'ARRAY';
1580 my %cust_main_exemption =
1581 map { $_->taxname => $_ }
1582 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1584 foreach my $taxname ( keys %$tax_exemption ) {
1586 if ( $cust_main_exemption{$taxname} &&
1587 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1590 delete $cust_main_exemption{$taxname};
1594 my $cust_main_exemption = new FS::cust_main_exemption {
1595 'custnum' => $self->custnum,
1596 'taxname' => $taxname,
1597 'exempt_number' => $tax_exemption->{$taxname},
1599 my $error = $cust_main_exemption->insert;
1601 $dbh->rollback if $oldAutoCommit;
1602 return "inserting cust_main_exemption (transaction rolled back): $error";
1606 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1607 my $error = $cust_main_exemption->delete;
1609 $dbh->rollback if $oldAutoCommit;
1610 return "deleting cust_main_exemption (transaction rolled back): $error";
1616 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1618 my $error = $self->process_o2m(
1619 'table' => 'cust_payby',
1620 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1621 'params' => $cust_payby_params,
1622 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1625 $dbh->rollback if $oldAutoCommit;
1631 if ( my $contact_params = delete $options{'contact_params'} ) {
1633 # this can potentially replace contacts that were created by the
1634 # invoicing list argument, but the UI shouldn't allow both of them
1637 my $error = $self->process_o2m(
1638 'table' => 'contact',
1639 'fields' => FS::contact->cgi_contact_fields,
1640 'params' => $contact_params,
1643 $dbh->rollback if $oldAutoCommit;
1649 unless ( $import || $skip_fuzzyfiles ) {
1650 $error = $self->queue_fuzzyfiles_update;
1652 $dbh->rollback if $oldAutoCommit;
1653 return "updating fuzzy search cache: $error";
1657 # tax district update in cust_location
1659 # cust_main exports!
1661 my $export_args = $options{'export_args'} || [];
1664 map qsearch( 'part_export', {exportnum=>$_} ),
1665 $conf->config('cust_main-exports'); #, $agentnum
1667 foreach my $part_export ( @part_export ) {
1668 my $error = $part_export->export_replace( $self, $old, @$export_args);
1670 $dbh->rollback if $oldAutoCommit;
1671 return "exporting to ". $part_export->exporttype.
1672 " (transaction rolled back): $error";
1676 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1681 =item queue_fuzzyfiles_update
1683 Used by insert & replace to update the fuzzy search cache
1687 use FS::cust_main::Search;
1688 sub queue_fuzzyfiles_update {
1691 local $SIG{HUP} = 'IGNORE';
1692 local $SIG{INT} = 'IGNORE';
1693 local $SIG{QUIT} = 'IGNORE';
1694 local $SIG{TERM} = 'IGNORE';
1695 local $SIG{TSTP} = 'IGNORE';
1696 local $SIG{PIPE} = 'IGNORE';
1698 my $oldAutoCommit = $FS::UID::AutoCommit;
1699 local $FS::UID::AutoCommit = 0;
1702 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1703 my $queue = new FS::queue {
1704 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1706 my @args = "cust_main.$field", $self->get($field);
1707 my $error = $queue->insert( @args );
1709 $dbh->rollback if $oldAutoCommit;
1710 return "queueing job (transaction rolled back): $error";
1715 push @locations, $self->bill_location if $self->bill_locationnum;
1716 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1717 foreach my $location (@locations) {
1718 my $queue = new FS::queue {
1719 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1721 my @args = 'cust_location.address1', $location->address1;
1722 my $error = $queue->insert( @args );
1724 $dbh->rollback if $oldAutoCommit;
1725 return "queueing job (transaction rolled back): $error";
1729 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1736 Checks all fields to make sure this is a valid customer record. If there is
1737 an error, returns the error, otherwise returns false. Called by the insert
1738 and replace methods.
1745 warn "$me check BEFORE: \n". $self->_dump
1749 $self->ut_numbern('custnum')
1750 || $self->ut_number('agentnum')
1751 || $self->ut_textn('agent_custid')
1752 || $self->ut_number('refnum')
1753 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1754 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1755 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1756 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1757 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1758 || $self->ut_textn('custbatch')
1759 || $self->ut_name('last')
1760 || $self->ut_name('first')
1761 || $self->ut_snumbern('signupdate')
1762 || $self->ut_snumbern('birthdate')
1763 || $self->ut_namen('spouse_last')
1764 || $self->ut_namen('spouse_first')
1765 || $self->ut_snumbern('spouse_birthdate')
1766 || $self->ut_snumbern('anniversary_date')
1767 || $self->ut_textn('company')
1768 || $self->ut_textn('ship_company')
1769 || $self->ut_anything('comments')
1770 || $self->ut_numbern('referral_custnum')
1771 || $self->ut_textn('stateid')
1772 || $self->ut_textn('stateid_state')
1773 || $self->ut_textn('invoice_terms')
1774 || $self->ut_floatn('cdr_termination_percentage')
1775 || $self->ut_floatn('credit_limit')
1776 || $self->ut_numbern('billday')
1777 || $self->ut_numbern('prorate_day')
1778 || $self->ut_flag('edit_subject')
1779 || $self->ut_flag('calling_list_exempt')
1780 || $self->ut_flag('invoice_noemail')
1781 || $self->ut_flag('message_noemail')
1782 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1783 || $self->ut_currencyn('currency')
1784 || $self->ut_textn('po_number')
1785 || $self->ut_enum('complimentary', [ '', 'Y' ])
1786 || $self->ut_flag('invoice_ship_address')
1787 || $self->ut_flag('invoice_dest')
1790 foreach (qw(company ship_company)) {
1791 my $company = $self->get($_);
1792 $company =~ s/^\s+//;
1793 $company =~ s/\s+$//;
1794 $company =~ s/\s+/ /g;
1795 $self->set($_, $company);
1798 #barf. need message catalogs. i18n. etc.
1799 $error .= "Please select an advertising source."
1800 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1801 return $error if $error;
1803 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1804 or return "Unknown agent";
1806 if ( $self->currency ) {
1807 my $agent_currency = qsearchs( 'agent_currency', {
1808 'agentnum' => $agent->agentnum,
1809 'currency' => $self->currency,
1811 or return "Agent ". $agent->agent.
1812 " not permitted to offer ". $self->currency. " invoicing";
1815 return "Unknown refnum"
1816 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1818 return "Unknown referring custnum: ". $self->referral_custnum
1819 unless ! $self->referral_custnum
1820 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1822 if ( $self->ss eq '' ) {
1827 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1828 or return "Illegal social security number: ". $self->ss;
1829 $self->ss("$1-$2-$3");
1832 #turn off invoice_ship_address if ship & bill are the same
1833 if ($self->bill_locationnum eq $self->ship_locationnum) {
1834 $self->invoice_ship_address('');
1837 # cust_main_county verification now handled by cust_location check
1840 $self->ut_phonen('daytime', $self->country)
1841 || $self->ut_phonen('night', $self->country)
1842 || $self->ut_phonen('fax', $self->country)
1843 || $self->ut_phonen('mobile', $self->country)
1845 return $error if $error;
1847 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1849 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1852 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1854 : FS::Msgcat::_gettext('daytime');
1855 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1857 : FS::Msgcat::_gettext('night');
1859 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1861 : FS::Msgcat::_gettext('mobile');
1863 return "$daytime_label, $night_label or $mobile_label is required"
1867 return "Please select an invoicing locale"
1870 && $conf->exists('cust_main-require_locale');
1872 return "Please select a customer class"
1873 if ! $self->classnum
1874 && $conf->exists('cust_main-require_classnum');
1876 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1877 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1881 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
1883 warn "$me check AFTER: \n". $self->_dump
1886 $self->SUPER::check;
1889 sub check_payinfo_cardtype {
1892 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
1894 my $payinfo = $self->payinfo;
1895 $payinfo =~ s/\D//g;
1897 return '' if $payinfo =~ /^99\d{14}$/; #token
1899 my %bop_card_types = map { $_=>1 } values %{ card_types() };
1900 my $cardtype = cardtype($payinfo);
1902 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
1910 Additional checks for replace only.
1915 my ($new,$old) = @_;
1916 #preserve old value if global config is set
1917 if ($old && $conf->exists('invoice-ship_address')) {
1918 $new->invoice_ship_address($old->invoice_ship_address);
1925 Returns a list of fields which have ship_ duplicates.
1930 qw( last first company
1932 address1 address2 city county state zip country
1934 daytime night fax mobile
1938 =item has_ship_address
1940 Returns true if this customer record has a separate shipping address.
1944 sub has_ship_address {
1946 $self->bill_locationnum != $self->ship_locationnum;
1951 Returns a list of key/value pairs, with the following keys: address1,
1952 adddress2, city, county, state, zip, country, district, and geocode. The
1953 shipping address is used if present.
1959 $self->ship_location->location_hash;
1964 Returns all locations (see L<FS::cust_location>) for this customer.
1971 'table' => 'cust_location',
1972 'hashref' => { 'custnum' => $self->custnum,
1973 'prospectnum' => '',
1975 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
1981 Returns all contact associations (see L<FS::cust_contact>) for this customer.
1987 qsearch('cust_contact', { 'custnum' => $self->custnum } );
1990 =item cust_payby PAYBY
1992 Returns all payment methods (see L<FS::cust_payby>) for this customer.
1994 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
1995 Does not validate PAYBY.
2003 'table' => 'cust_payby',
2004 'hashref' => { 'custnum' => $self->custnum },
2005 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
2007 $search->{'extra_sql'} = ' AND payby IN ( '.
2008 join(',', map dbh->quote($_), @payby).
2015 =item has_cust_payby_auto
2017 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2021 sub has_cust_payby_auto {
2024 'table' => 'cust_payby',
2025 'hashref' => { 'custnum' => $self->custnum, },
2026 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2027 'order_by' => 'LIMIT 1',
2034 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2035 and L<FS::cust_pkg>) for this customer, except those on hold.
2037 Returns a list: an empty list on success or a list of errors.
2043 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2048 Unsuspends all suspended packages in the on-hold state (those without setup
2049 dates) for this customer.
2055 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2060 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2062 Returns a list: an empty list on success or a list of errors.
2068 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2071 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2073 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2074 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2075 of a list of pkgparts; the hashref has the following keys:
2079 =item pkgparts - listref of pkgparts
2081 =item (other options are passed to the suspend method)
2086 Returns a list: an empty list on success or a list of errors.
2090 sub suspend_if_pkgpart {
2092 my (@pkgparts, %opt);
2093 if (ref($_[0]) eq 'HASH'){
2094 @pkgparts = @{$_[0]{pkgparts}};
2099 grep { $_->suspend(%opt) }
2100 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2101 $self->unsuspended_pkgs;
2104 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2106 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2107 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2108 instead of a list of pkgparts; the hashref has the following keys:
2112 =item pkgparts - listref of pkgparts
2114 =item (other options are passed to the suspend method)
2118 Returns a list: an empty list on success or a list of errors.
2122 sub suspend_unless_pkgpart {
2124 my (@pkgparts, %opt);
2125 if (ref($_[0]) eq 'HASH'){
2126 @pkgparts = @{$_[0]{pkgparts}};
2131 grep { $_->suspend(%opt) }
2132 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2133 $self->unsuspended_pkgs;
2136 =item cancel [ OPTION => VALUE ... ]
2138 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2139 The cancellation time will be now.
2143 Always returns a list: an empty list on success or a list of errors.
2150 warn "$me cancel called on customer ". $self->custnum. " with options ".
2151 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2153 my @pkgs = $self->ncancelled_pkgs;
2155 $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2158 =item cancel_pkgs OPTIONS
2160 Cancels a specified list of packages. OPTIONS can include:
2164 =item cust_pkg - an arrayref of the packages. Required.
2166 =item time - the cancellation time, used to calculate final bills and
2167 unused-time credits if any. Will be passed through to the bill() and
2168 FS::cust_pkg::cancel() methods.
2170 =item quiet - can be set true to supress email cancellation notices.
2172 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a
2173 reasonnum of an existing reason, or passing a hashref will create a new reason.
2174 The hashref should have the following keys:
2175 typenum - Reason type (see L<FS::reason_type>)
2176 reason - Text of the new reason.
2178 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2179 for the individual packages, parallel to the C<cust_pkg> argument. The
2180 reason and reason_otaker arguments will be taken from those objects.
2182 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2184 =item nobill - can be set true to skip billing if it might otherwise be done.
2189 my( $self, %opt ) = @_;
2191 # we're going to cancel services, which is not reversible
2192 die "cancel_pkgs cannot be run inside a transaction"
2193 if $FS::UID::AutoCommit == 0;
2195 local $FS::UID::AutoCommit = 0;
2197 return ( 'access denied' )
2198 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2200 if ( $opt{'ban'} ) {
2202 foreach my $cust_payby ( $self->cust_payby ) {
2204 #well, if they didn't get decrypted on search, then we don't have to
2205 # try again... queue a job for the server that does have decryption
2206 # capability if we're in a paranoid multi-server implementation?
2207 return ( "Can't (yet) ban encrypted credit cards" )
2208 if $cust_payby->is_encrypted($cust_payby->payinfo);
2210 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2211 my $error = $ban->insert;
2221 my @pkgs = @{ delete $opt{'cust_pkg'} };
2222 my $cancel_time = $opt{'time'} || time;
2224 # bill all packages first, so we don't lose usage, service counts for
2225 # bulk billing, etc.
2226 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2228 my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2230 'time' => $cancel_time );
2232 warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2234 return ( "Error billing during cancellation: $error" );
2240 # try to cancel each service, the same way we would for individual packages,
2241 # but in cancel weight order.
2242 my @cust_svc = map { $_->cust_svc } @pkgs;
2243 my @sorted_cust_svc =
2245 sort { $a->[1] <=> $b->[1] }
2246 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2248 warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2251 foreach my $cust_svc (@sorted_cust_svc) {
2252 my $part_svc = $cust_svc->part_svc;
2253 next if ( defined($part_svc) and $part_svc->preserve );
2254 # immediate cancel, no date option
2255 # transactionize individually
2256 my $error = try { $cust_svc->cancel } catch { $_ };
2259 push @errors, $error;
2268 warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2269 $self->custnum. "\n"
2273 if ($opt{'cust_pkg_reason'}) {
2274 @cprs = @{ delete $opt{'cust_pkg_reason'} };
2280 my $cpr = shift @cprs;
2282 $lopt{'reason'} = $cpr->reasonnum;
2283 $lopt{'reason_otaker'} = $cpr->otaker;
2285 warn "no reason found when canceling package ".$_->pkgnum."\n";
2286 # we're not actually required to pass a reason to cust_pkg::cancel,
2287 # but if we're getting to this point, something has gone awry.
2288 $null_reason ||= FS::reason->new_or_existing(
2289 reason => 'unknown reason',
2290 type => 'Cancel Reason',
2293 $lopt{'reason'} = $null_reason->reasonnum;
2294 $lopt{'reason_otaker'} = $FS::CurrentUser::CurrentUser->username;
2297 my $error = $_->cancel(%lopt);
2300 push @errors, 'pkgnum '.$_->pkgnum.': '.$error;
2309 sub _banned_pay_hashref {
2310 die 'cust_main->_banned_pay_hashref deprecated';
2322 'payby' => $payby2ban{$self->payby},
2323 'payinfo' => $self->payinfo,
2324 #don't ever *search* on reason! #'reason' =>
2330 Returns all notes (see L<FS::cust_main_note>) for this customer.
2335 my($self,$orderby_classnum) = (shift,shift);
2336 my $orderby = "sticky DESC, _date DESC";
2337 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2338 qsearch( 'cust_main_note',
2339 { 'custnum' => $self->custnum },
2341 "ORDER BY $orderby",
2347 Returns the agent (see L<FS::agent>) for this customer.
2351 Returns the agent name (see L<FS::agent>) for this customer.
2357 $self->agent->agent;
2362 Returns any tags associated with this customer, as FS::cust_tag objects,
2363 or an empty list if there are no tags.
2367 Returns any tags associated with this customer, as FS::part_tag objects,
2368 or an empty list if there are no tags.
2374 map $_->part_tag, $self->cust_tag;
2380 Returns the customer class, as an FS::cust_class object, or the empty string
2381 if there is no customer class.
2385 Returns the customer category name, or the empty string if there is no customer
2392 my $cust_class = $self->cust_class;
2394 ? $cust_class->categoryname
2400 Returns the customer class name, or the empty string if there is no customer
2407 my $cust_class = $self->cust_class;
2409 ? $cust_class->classname
2415 Returns the external tax status, as an FS::tax_status object, or the empty
2416 string if there is no tax status.
2422 if ( $self->taxstatusnum ) {
2423 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2431 Returns the tax status code if there is one.
2437 my $tax_status = $self->tax_status;
2439 ? $tax_status->taxstatus
2443 =item BILLING METHODS
2445 Documentation on billing methods has been moved to
2446 L<FS::cust_main::Billing>.
2448 =item REALTIME BILLING METHODS
2450 Documentation on realtime billing methods has been moved to
2451 L<FS::cust_main::Billing_Realtime>.
2455 Removes the I<paycvv> field from the database directly.
2457 If there is an error, returns the error, otherwise returns false.
2459 DEPRECATED. Use L</remove_cvv_from_cust_payby> instead.
2464 die 'cust_main->remove_cvv deprecated';
2466 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2467 or return dbh->errstr;
2468 $sth->execute($self->custnum)
2469 or return $sth->errstr;
2476 Returns the total owed for this customer on all invoices
2477 (see L<FS::cust_bill/owed>).
2483 $self->total_owed_date(2145859200); #12/31/2037
2486 =item total_owed_date TIME
2488 Returns the total owed for this customer on all invoices with date earlier than
2489 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2490 see L<Time::Local> and L<Date::Parse> for conversion functions.
2494 sub total_owed_date {
2498 my $custnum = $self->custnum;
2500 my $owed_sql = FS::cust_bill->owed_sql;
2503 SELECT SUM($owed_sql) FROM cust_bill
2504 WHERE custnum = $custnum
2508 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2512 =item total_owed_pkgnum PKGNUM
2514 Returns the total owed on all invoices for this customer's specific package
2515 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2519 sub total_owed_pkgnum {
2520 my( $self, $pkgnum ) = @_;
2521 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2524 =item total_owed_date_pkgnum TIME PKGNUM
2526 Returns the total owed for this customer's specific package when using
2527 experimental package balances on all invoices with date earlier than
2528 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2529 see L<Time::Local> and L<Date::Parse> for conversion functions.
2533 sub total_owed_date_pkgnum {
2534 my( $self, $time, $pkgnum ) = @_;
2537 foreach my $cust_bill (
2538 grep { $_->_date <= $time }
2539 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2541 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2543 sprintf( "%.2f", $total_bill );
2549 Returns the total amount of all payments.
2556 $total += $_->paid foreach $self->cust_pay;
2557 sprintf( "%.2f", $total );
2560 =item total_unapplied_credits
2562 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2563 customer. See L<FS::cust_credit/credited>.
2565 =item total_credited
2567 Old name for total_unapplied_credits. Don't use.
2571 sub total_credited {
2572 #carp "total_credited deprecated, use total_unapplied_credits";
2573 shift->total_unapplied_credits(@_);
2576 sub total_unapplied_credits {
2579 my $custnum = $self->custnum;
2581 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2584 SELECT SUM($unapplied_sql) FROM cust_credit
2585 WHERE custnum = $custnum
2588 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2592 =item total_unapplied_credits_pkgnum PKGNUM
2594 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2595 customer. See L<FS::cust_credit/credited>.
2599 sub total_unapplied_credits_pkgnum {
2600 my( $self, $pkgnum ) = @_;
2601 my $total_credit = 0;
2602 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2603 sprintf( "%.2f", $total_credit );
2607 =item total_unapplied_payments
2609 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2610 See L<FS::cust_pay/unapplied>.
2614 sub total_unapplied_payments {
2617 my $custnum = $self->custnum;
2619 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2622 SELECT SUM($unapplied_sql) FROM cust_pay
2623 WHERE custnum = $custnum
2626 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2630 =item total_unapplied_payments_pkgnum PKGNUM
2632 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2633 specific package when using experimental package balances. See
2634 L<FS::cust_pay/unapplied>.
2638 sub total_unapplied_payments_pkgnum {
2639 my( $self, $pkgnum ) = @_;
2640 my $total_unapplied = 0;
2641 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2642 sprintf( "%.2f", $total_unapplied );
2646 =item total_unapplied_refunds
2648 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2649 customer. See L<FS::cust_refund/unapplied>.
2653 sub total_unapplied_refunds {
2655 my $custnum = $self->custnum;
2657 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2660 SELECT SUM($unapplied_sql) FROM cust_refund
2661 WHERE custnum = $custnum
2664 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2670 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2671 total_unapplied_credits minus total_unapplied_payments).
2677 $self->balance_date_range;
2680 =item balance_date TIME
2682 Returns the balance for this customer, only considering invoices with date
2683 earlier than TIME (total_owed_date minus total_credited minus
2684 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2685 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2692 $self->balance_date_range(shift);
2695 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2697 Returns the balance for this customer, optionally considering invoices with
2698 date earlier than START_TIME, and not later than END_TIME
2699 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2701 Times are specified as SQL fragments or numeric
2702 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2703 L<Date::Parse> for conversion functions. The empty string can be passed
2704 to disable that time constraint completely.
2706 Accepts the same options as L<balance_date_sql>:
2710 =item unapplied_date
2712 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)
2716 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2717 time will be ignored. Note that START_TIME and END_TIME only limit the date
2718 range for invoices and I<unapplied> payments, credits, and refunds.
2724 sub balance_date_range {
2726 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2727 ') FROM cust_main WHERE custnum='. $self->custnum;
2728 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2731 =item balance_pkgnum PKGNUM
2733 Returns the balance for this customer's specific package when using
2734 experimental package balances (total_owed plus total_unrefunded, minus
2735 total_unapplied_credits minus total_unapplied_payments)
2739 sub balance_pkgnum {
2740 my( $self, $pkgnum ) = @_;
2743 $self->total_owed_pkgnum($pkgnum)
2744 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2745 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2746 - $self->total_unapplied_credits_pkgnum($pkgnum)
2747 - $self->total_unapplied_payments_pkgnum($pkgnum)
2753 Returns a hash of useful information for making a payment.
2763 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2764 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2765 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2769 For credit card transactions:
2781 For electronic check transactions:
2791 #XXX i need to be updated for 4.x+
2797 $return{balance} = $self->balance;
2799 $return{payname} = $self->payname
2800 || ( $self->first. ' '. $self->get('last') );
2802 $return{$_} = $self->bill_location->$_
2803 for qw(address1 address2 city state zip);
2805 $return{payby} = $self->payby;
2806 $return{stateid_state} = $self->stateid_state;
2808 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2809 $return{card_type} = cardtype($self->payinfo);
2810 $return{payinfo} = $self->paymask;
2812 @return{'month', 'year'} = $self->paydate_monthyear;
2816 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2817 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2818 $return{payinfo1} = $payinfo1;
2819 $return{payinfo2} = $payinfo2;
2820 $return{paytype} = $self->paytype;
2821 $return{paystate} = $self->paystate;
2825 #doubleclick protection
2827 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2835 Returns the next payment expiration date for this customer. If they have no
2836 payment methods that will expire, returns 0.
2842 # filter out the ones that individually return 0, but then return 0 if
2843 # there are no results
2844 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
2845 min( @epochs ) || 0;
2848 =item paydate_epoch_sql
2850 Returns an SQL expression to get the next payment expiration date for a
2851 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
2852 dates, so that it's safe to test for "will it expire before date X" for any
2857 sub paydate_epoch_sql {
2859 my $paydate = FS::cust_payby->paydate_epoch_sql;
2860 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
2864 my( $self, $taxname ) = @_;
2866 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2867 'taxname' => $taxname,
2872 =item cust_main_exemption
2874 =item invoicing_list
2876 Returns a list of email addresses (with svcnum entries expanded), and the word
2877 'POST' if the customer receives postal invoices.
2881 sub invoicing_list {
2882 my( $self, $arrayref ) = @_;
2885 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
2888 my @emails = $self->invoicing_list_emailonly;
2889 push @emails, 'POST' if $self->get('postal_invoice');
2894 =item check_invoicing_list ARRAYREF
2896 Checks these arguements as valid input for the invoicing_list method. If there
2897 is an error, returns the error, otherwise returns false.
2901 sub check_invoicing_list {
2902 my( $self, $arrayref ) = @_;
2904 foreach my $address ( @$arrayref ) {
2906 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
2907 return 'Can\'t add FAX invoice destination with a blank FAX number.';
2910 my $cust_main_invoice = new FS::cust_main_invoice ( {
2911 'custnum' => $self->custnum,
2914 my $error = $self->custnum
2915 ? $cust_main_invoice->check
2916 : $cust_main_invoice->checkdest
2918 return $error if $error;
2922 return "Email address required"
2923 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
2924 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
2931 Returns the email addresses of all accounts provisioned for this customer.
2938 foreach my $cust_pkg ( $self->all_pkgs ) {
2939 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
2941 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2942 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2944 $list{$_}=1 foreach map { $_->email } @svc_acct;
2949 =item invoicing_list_addpost
2951 Adds postal invoicing to this customer. If this customer is already configured
2952 to receive postal invoices, does nothing.
2956 sub invoicing_list_addpost {
2958 if ( $self->get('postal_invoice') eq '' ) {
2959 $self->set('postal_invoice', 'Y');
2960 my $error = $self->replace;
2961 warn $error if $error; # should fail harder, but this is traditional
2965 =item invoicing_list_emailonly
2967 Returns the list of email invoice recipients (invoicing_list without non-email
2968 destinations such as POST and FAX).
2972 sub invoicing_list_emailonly {
2974 warn "$me invoicing_list_emailonly called"
2976 return () if !$self->custnum; # not yet inserted
2977 return map { $_->emailaddress }
2979 table => 'cust_contact',
2980 select => 'emailaddress',
2981 addl_from => ' JOIN contact USING (contactnum) '.
2982 ' JOIN contact_email USING (contactnum)',
2983 hashref => { 'custnum' => $self->custnum, },
2984 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
2988 =item invoicing_list_emailonly_scalar
2990 Returns the list of email invoice recipients (invoicing_list without non-email
2991 destinations such as POST and FAX) as a comma-separated scalar.
2995 sub invoicing_list_emailonly_scalar {
2997 warn "$me invoicing_list_emailonly_scalar called"
2999 join(', ', $self->invoicing_list_emailonly);
3002 =item contact_list [ CLASSNUM, ... ]
3004 Returns a list of contacts (L<FS::contact> objects) for the customer. If
3005 a list of contact classnums is given, returns only contacts in those
3006 classes. If the pseudo-classnum 'invoice' is given, returns contacts that
3007 are marked as invoice destinations. If '0' is given, also returns contacts
3010 If no arguments are given, returns all contacts for the customer.
3018 select => 'contact.*, cust_contact.invoice_dest',
3019 addl_from => ' JOIN cust_contact USING (contactnum)',
3020 extra_sql => ' WHERE cust_contact.custnum = '.$self->custnum,
3026 if ( $_ eq 'invoice' ) {
3027 push @orwhere, 'cust_contact.invoice_dest = \'Y\'';
3028 } elsif ( $_ eq '0' ) {
3029 push @orwhere, 'cust_contact.classnum is null';
3030 } elsif ( /^\d+$/ ) {
3031 push @classnums, $_;
3033 die "bad classnum argument '$_'";
3038 push @orwhere, 'cust_contact.classnum IN ('.join(',', @classnums).')';
3041 $search->{extra_sql} .= ' AND (' .
3042 join(' OR ', map "( $_ )", @orwhere) .
3049 =item contact_list_email [ CLASSNUM, ... ]
3051 Same as L</contact_list>, but returns email destinations instead of contact
3056 sub contact_list_email {
3058 my @contacts = $self->contact_list(@_);
3060 foreach my $contact (@contacts) {
3061 foreach my $contact_email ($contact->contact_email) {
3063 $contact->firstlast . ' <' . $contact_email->emailaddress . '>';
3069 =item referral_custnum_cust_main
3071 Returns the customer who referred this customer (or the empty string, if
3072 this customer was not referred).
3074 Note the difference with referral_cust_main method: This method,
3075 referral_custnum_cust_main returns the single customer (if any) who referred
3076 this customer, while referral_cust_main returns an array of customers referred
3081 sub referral_custnum_cust_main {
3083 return '' unless $self->referral_custnum;
3084 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3087 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3089 Returns an array of customers referred by this customer (referral_custnum set
3090 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3091 customers referred by customers referred by this customer and so on, inclusive.
3092 The default behavior is DEPTH 1 (no recursion).
3094 Note the difference with referral_custnum_cust_main method: This method,
3095 referral_cust_main, returns an array of customers referred BY this customer,
3096 while referral_custnum_cust_main returns the single customer (if any) who
3097 referred this customer.
3101 sub referral_cust_main {
3103 my $depth = @_ ? shift : 1;
3104 my $exclude = @_ ? shift : {};
3107 map { $exclude->{$_->custnum}++; $_; }
3108 grep { ! $exclude->{ $_->custnum } }
3109 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3113 map { $_->referral_cust_main($depth-1, $exclude) }
3120 =item referral_cust_main_ncancelled
3122 Same as referral_cust_main, except only returns customers with uncancelled
3127 sub referral_cust_main_ncancelled {
3129 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3132 =item referral_cust_pkg [ DEPTH ]
3134 Like referral_cust_main, except returns a flat list of all unsuspended (and
3135 uncancelled) packages for each customer. The number of items in this list may
3136 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3140 sub referral_cust_pkg {
3142 my $depth = @_ ? shift : 1;
3144 map { $_->unsuspended_pkgs }
3145 grep { $_->unsuspended_pkgs }
3146 $self->referral_cust_main($depth);
3149 =item referring_cust_main
3151 Returns the single cust_main record for the customer who referred this customer
3152 (referral_custnum), or false.
3156 sub referring_cust_main {
3158 return '' unless $self->referral_custnum;
3159 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3162 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3164 Applies a credit to this customer. If there is an error, returns the error,
3165 otherwise returns false.
3167 REASON can be a text string, an FS::reason object, or a scalar reference to
3168 a reasonnum. If a text string, it will be automatically inserted as a new
3169 reason, and a 'reason_type' option must be passed to indicate the
3170 FS::reason_type for the new reason.
3172 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3173 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3174 I<commission_pkgnum>.
3176 Any other options are passed to FS::cust_credit::insert.
3181 my( $self, $amount, $reason, %options ) = @_;
3183 my $cust_credit = new FS::cust_credit {
3184 'custnum' => $self->custnum,
3185 'amount' => $amount,
3188 if ( ref($reason) ) {
3190 if ( ref($reason) eq 'SCALAR' ) {
3191 $cust_credit->reasonnum( $$reason );
3193 $cust_credit->reasonnum( $reason->reasonnum );
3197 $cust_credit->set('reason', $reason)
3200 $cust_credit->$_( delete $options{$_} )
3201 foreach grep exists($options{$_}),
3202 qw( addlinfo eventnum ),
3203 map "commission_$_", qw( agentnum salesnum pkgnum );
3205 $cust_credit->insert(%options);
3209 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3211 Creates a one-time charge for this customer. If there is an error, returns
3212 the error, otherwise returns false.
3214 New-style, with a hashref of options:
3216 my $error = $cust_main->charge(
3220 'start_date' => str2time('7/4/2009'),
3221 'pkg' => 'Description',
3222 'comment' => 'Comment',
3223 'additional' => [], #extra invoice detail
3224 'classnum' => 1, #pkg_class
3226 'setuptax' => '', # or 'Y' for tax exempt
3228 'locationnum'=> 1234, # optional
3231 'taxclass' => 'Tax class',
3234 'taxproduct' => 2, #part_pkg_taxproduct
3235 'override' => {}, #XXX describe
3237 #will be filled in with the new object
3238 'cust_pkg_ref' => \$cust_pkg,
3240 #generate an invoice immediately
3242 'invoice_terms' => '', #with these terms
3248 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3252 #super false laziness w/quotation::charge
3255 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3256 my ( $pkg, $comment, $additional );
3257 my ( $setuptax, $taxclass ); #internal taxes
3258 my ( $taxproduct, $override ); #vendor (CCH) taxes
3260 my $separate_bill = '';
3261 my $cust_pkg_ref = '';
3262 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3264 if ( ref( $_[0] ) ) {
3265 $amount = $_[0]->{amount};
3266 $setup_cost = $_[0]->{setup_cost};
3267 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3268 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3269 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3270 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3271 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3272 : '$'. sprintf("%.2f",$amount);
3273 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3274 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3275 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3276 $additional = $_[0]->{additional} || [];
3277 $taxproduct = $_[0]->{taxproductnum};
3278 $override = { '' => $_[0]->{tax_override} };
3279 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3280 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3281 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3282 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3283 $separate_bill = $_[0]->{separate_bill} || '';
3289 $pkg = @_ ? shift : 'One-time charge';
3290 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3292 $taxclass = @_ ? shift : '';
3296 local $SIG{HUP} = 'IGNORE';
3297 local $SIG{INT} = 'IGNORE';
3298 local $SIG{QUIT} = 'IGNORE';
3299 local $SIG{TERM} = 'IGNORE';
3300 local $SIG{TSTP} = 'IGNORE';
3301 local $SIG{PIPE} = 'IGNORE';
3303 my $oldAutoCommit = $FS::UID::AutoCommit;
3304 local $FS::UID::AutoCommit = 0;
3307 my $part_pkg = new FS::part_pkg ( {
3309 'comment' => $comment,
3313 'classnum' => ( $classnum ? $classnum : '' ),
3314 'setuptax' => $setuptax,
3315 'taxclass' => $taxclass,
3316 'taxproductnum' => $taxproduct,
3317 'setup_cost' => $setup_cost,
3320 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3321 ( 0 .. @$additional - 1 )
3323 'additional_count' => scalar(@$additional),
3324 'setup_fee' => $amount,
3327 my $error = $part_pkg->insert( options => \%options,
3328 tax_overrides => $override,
3331 $dbh->rollback if $oldAutoCommit;
3335 my $pkgpart = $part_pkg->pkgpart;
3336 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3337 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3338 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3339 $error = $type_pkgs->insert;
3341 $dbh->rollback if $oldAutoCommit;
3346 my $cust_pkg = new FS::cust_pkg ( {
3347 'custnum' => $self->custnum,
3348 'pkgpart' => $pkgpart,
3349 'quantity' => $quantity,
3350 'start_date' => $start_date,
3351 'no_auto' => $no_auto,
3352 'separate_bill' => $separate_bill,
3353 'locationnum'=> $locationnum,
3356 $error = $cust_pkg->insert;
3358 $dbh->rollback if $oldAutoCommit;
3360 } elsif ( $cust_pkg_ref ) {
3361 ${$cust_pkg_ref} = $cust_pkg;
3365 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3366 'pkg_list' => [ $cust_pkg ],
3369 $dbh->rollback if $oldAutoCommit;
3374 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3379 #=item charge_postal_fee
3381 #Applies a one time charge this customer. If there is an error,
3382 #returns the error, returns the cust_pkg charge object or false
3383 #if there was no charge.
3387 # This should be a customer event. For that to work requires that bill
3388 # also be a customer event.
3390 sub charge_postal_fee {
3393 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3394 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3396 my $cust_pkg = new FS::cust_pkg ( {
3397 'custnum' => $self->custnum,
3398 'pkgpart' => $pkgpart,
3402 my $error = $cust_pkg->insert;
3403 $error ? $error : $cust_pkg;
3406 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3408 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3410 Optionally, a list or hashref of additional arguments to the qsearch call can
3417 my $opt = ref($_[0]) ? shift : { @_ };
3419 #return $self->num_cust_bill unless wantarray || keys %$opt;
3421 $opt->{'table'} = 'cust_bill';
3422 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3423 $opt->{'hashref'}{'custnum'} = $self->custnum;
3424 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3426 map { $_ } #behavior of sort undefined in scalar context
3427 sort { $a->_date <=> $b->_date }
3431 =item open_cust_bill
3433 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3438 sub open_cust_bill {
3442 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3448 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3450 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3454 sub legacy_cust_bill {
3457 #return $self->num_legacy_cust_bill unless wantarray;
3459 map { $_ } #behavior of sort undefined in scalar context
3460 sort { $a->_date <=> $b->_date }
3461 qsearch({ 'table' => 'legacy_cust_bill',
3462 'hashref' => { 'custnum' => $self->custnum, },
3463 'order_by' => 'ORDER BY _date ASC',
3467 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3469 Returns all the statements (see L<FS::cust_statement>) for this customer.
3471 Optionally, a list or hashref of additional arguments to the qsearch call can
3476 =item cust_bill_void
3478 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3482 sub cust_bill_void {
3485 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3486 sort { $a->_date <=> $b->_date }
3487 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3490 sub cust_statement {
3492 my $opt = ref($_[0]) ? shift : { @_ };
3494 #return $self->num_cust_statement unless wantarray || keys %$opt;
3496 $opt->{'table'} = 'cust_statement';
3497 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3498 $opt->{'hashref'}{'custnum'} = $self->custnum;
3499 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3501 map { $_ } #behavior of sort undefined in scalar context
3502 sort { $a->_date <=> $b->_date }
3506 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3508 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3510 Optionally, a list or hashref of additional arguments to the qsearch call can
3511 be passed following the SVCDB.
3518 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3519 warn "$me svc_x requires a svcdb";
3522 my $opt = ref($_[0]) ? shift : { @_ };
3524 $opt->{'table'} = $svcdb;
3525 $opt->{'addl_from'} =
3526 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3527 ($opt->{'addl_from'} || '');
3529 my $custnum = $self->custnum;
3530 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3531 my $where = "cust_pkg.custnum = $custnum";
3533 my $extra_sql = $opt->{'extra_sql'} || '';
3534 if ( keys %{ $opt->{'hashref'} } ) {
3535 $extra_sql = " AND $where $extra_sql";
3538 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3539 $extra_sql = "WHERE $where AND $1";
3542 $extra_sql = "WHERE $where $extra_sql";
3545 $opt->{'extra_sql'} = $extra_sql;
3550 # required for use as an eventtable;
3553 $self->svc_x('svc_acct', @_);
3558 Returns all the credits (see L<FS::cust_credit>) for this customer.
3565 #return $self->num_cust_credit unless wantarray;
3567 map { $_ } #behavior of sort undefined in scalar context
3568 sort { $a->_date <=> $b->_date }
3569 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3572 =item cust_credit_pkgnum
3574 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3575 package when using experimental package balances.
3579 sub cust_credit_pkgnum {
3580 my( $self, $pkgnum ) = @_;
3581 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3582 sort { $a->_date <=> $b->_date }
3583 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3584 'pkgnum' => $pkgnum,
3589 =item cust_credit_void
3591 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3595 sub cust_credit_void {
3598 sort { $a->_date <=> $b->_date }
3599 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3604 Returns all the payments (see L<FS::cust_pay>) for this customer.
3610 my $opt = ref($_[0]) ? shift : { @_ };
3612 return $self->num_cust_pay unless wantarray || keys %$opt;
3614 $opt->{'table'} = 'cust_pay';
3615 $opt->{'hashref'}{'custnum'} = $self->custnum;
3617 map { $_ } #behavior of sort undefined in scalar context
3618 sort { $a->_date <=> $b->_date }
3625 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3626 called automatically when the cust_pay method is used in a scalar context.
3632 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3633 my $sth = dbh->prepare($sql) or die dbh->errstr;
3634 $sth->execute($self->custnum) or die $sth->errstr;
3635 $sth->fetchrow_arrayref->[0];
3638 =item unapplied_cust_pay
3640 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3644 sub unapplied_cust_pay {
3648 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3654 =item cust_pay_pkgnum
3656 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3657 package when using experimental package balances.
3661 sub cust_pay_pkgnum {
3662 my( $self, $pkgnum ) = @_;
3663 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3664 sort { $a->_date <=> $b->_date }
3665 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3666 'pkgnum' => $pkgnum,
3673 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3679 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3680 sort { $a->_date <=> $b->_date }
3681 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3684 =item cust_pay_pending
3686 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3687 (without status "done").
3691 sub cust_pay_pending {
3693 return $self->num_cust_pay_pending unless wantarray;
3694 sort { $a->_date <=> $b->_date }
3695 qsearch( 'cust_pay_pending', {
3696 'custnum' => $self->custnum,
3697 'status' => { op=>'!=', value=>'done' },
3702 =item cust_pay_pending_attempt
3704 Returns all payment attempts / declined payments for this customer, as pending
3705 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3706 a corresponding payment (see L<FS::cust_pay>).
3710 sub cust_pay_pending_attempt {
3712 return $self->num_cust_pay_pending_attempt unless wantarray;
3713 sort { $a->_date <=> $b->_date }
3714 qsearch( 'cust_pay_pending', {
3715 'custnum' => $self->custnum,
3722 =item num_cust_pay_pending
3724 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3725 customer (without status "done"). Also called automatically when the
3726 cust_pay_pending method is used in a scalar context.
3730 sub num_cust_pay_pending {
3733 " SELECT COUNT(*) FROM cust_pay_pending ".
3734 " WHERE custnum = ? AND status != 'done' ",
3739 =item num_cust_pay_pending_attempt
3741 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3742 customer, with status "done" but without a corresp. Also called automatically when the
3743 cust_pay_pending method is used in a scalar context.
3747 sub num_cust_pay_pending_attempt {
3750 " SELECT COUNT(*) FROM cust_pay_pending ".
3751 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3758 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3764 map { $_ } #return $self->num_cust_refund unless wantarray;
3765 sort { $a->_date <=> $b->_date }
3766 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3769 =item display_custnum
3771 Returns the displayed customer number for this customer: agent_custid if
3772 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3776 sub display_custnum {
3779 return $self->agent_custid
3780 if $default_agent_custid && $self->agent_custid;
3782 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3786 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
3787 } elsif ( $custnum_display_length ) {
3788 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
3790 return $self->custnum;
3796 Returns a name string for this customer, either "Company (Last, First)" or
3803 my $name = $self->contact;
3804 $name = $self->company. " ($name)" if $self->company;
3808 =item service_contact
3810 Returns the L<FS::contact> object for this customer that has the 'Service'
3811 contact class, or undef if there is no such contact. Deprecated; don't use
3816 sub service_contact {
3818 if ( !exists($self->{service_contact}) ) {
3819 my $classnum = $self->scalar_sql(
3820 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3821 ) || 0; #if it's zero, qsearchs will return nothing
3822 my $cust_contact = qsearchs('cust_contact', {
3823 'classnum' => $classnum,
3824 'custnum' => $self->custnum,
3826 $self->{service_contact} = $cust_contact->contact if $cust_contact;
3828 $self->{service_contact};
3833 Returns a name string for this (service/shipping) contact, either
3834 "Company (Last, First)" or "Last, First".
3841 my $name = $self->ship_contact;
3842 $name = $self->company. " ($name)" if $self->company;
3848 Returns a name string for this customer, either "Company" or "First Last".
3854 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3857 =item ship_name_short
3859 Returns a name string for this (service/shipping) contact, either "Company"
3864 sub ship_name_short {
3866 $self->service_contact
3867 ? $self->ship_contact_firstlast
3873 Returns this customer's full (billing) contact name only, "Last, First"
3879 $self->get('last'). ', '. $self->first;
3884 Returns this customer's full (shipping) contact name only, "Last, First"
3890 my $contact = $self->service_contact || $self;
3891 $contact->get('last') . ', ' . $contact->get('first');
3894 =item contact_firstlast
3896 Returns this customers full (billing) contact name only, "First Last".
3900 sub contact_firstlast {
3902 $self->first. ' '. $self->get('last');
3905 =item ship_contact_firstlast
3907 Returns this customer's full (shipping) contact name only, "First Last".
3911 sub ship_contact_firstlast {
3913 my $contact = $self->service_contact || $self;
3914 $contact->get('first') . ' '. $contact->get('last');
3917 sub bill_country_full {
3919 $self->bill_location->country_full;
3922 sub ship_country_full {
3924 $self->ship_location->country_full;
3927 =item county_state_county [ PREFIX ]
3929 Returns a string consisting of just the county, state and country.
3933 sub county_state_country {
3936 if ( @_ && $_[0] && $self->has_ship_address ) {
3937 $locationnum = $self->ship_locationnum;
3939 $locationnum = $self->bill_locationnum;
3941 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
3942 $cust_location->county_state_country;
3945 =item geocode DATA_VENDOR
3947 Returns a value for the customer location as encoded by DATA_VENDOR.
3948 Currently this only makes sense for "CCH" as DATA_VENDOR.
3956 Returns a status string for this customer, currently:
3962 No packages have ever been ordered. Displayed as "No packages".
3966 Recurring packages all are new (not yet billed).
3970 One or more recurring packages is active.
3974 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
3978 All non-cancelled recurring packages are suspended.
3982 All recurring packages are cancelled.
3986 Behavior of inactive vs. cancelled edge cases can be adjusted with the
3987 cust_main-status_module configuration option.
3991 sub status { shift->cust_status(@_); }
3995 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
3996 for my $status ( FS::cust_main->statuses() ) {
3997 my $method = $status.'_sql';
3998 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3999 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4000 $sth->execute( ($self->custnum) x $numnum )
4001 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4002 if ( $sth->fetchrow_arrayref->[0] ) {
4003 $self->hashref->{cust_status} = $status;
4009 =item is_status_delay_cancel
4011 Returns true if customer status is 'suspended'
4012 and all suspended cust_pkg return true for
4013 cust_pkg->is_status_delay_cancel.
4015 This is not a real status, this only meant for hacking display
4016 values, because otherwise treating the customer as suspended is
4017 really the whole point of the delay_cancel option.
4021 sub is_status_delay_cancel {
4023 return 0 unless $self->status eq 'suspended';
4024 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4025 return 0 unless $cust_pkg->is_status_delay_cancel;
4030 =item ucfirst_cust_status
4032 =item ucfirst_status
4034 Deprecated, use the cust_status_label method instead.
4036 Returns the status with the first character capitalized.
4040 sub ucfirst_status {
4041 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4042 local($ucfirst_nowarn) = 1;
4043 shift->ucfirst_cust_status(@_);
4046 sub ucfirst_cust_status {
4047 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4049 ucfirst($self->cust_status);
4052 =item cust_status_label
4056 Returns the display label for this status.
4060 sub status_label { shift->cust_status_label(@_); }
4062 sub cust_status_label {
4064 __PACKAGE__->statuslabels->{$self->cust_status};
4069 Returns a hex triplet color string for this customer's status.
4073 sub statuscolor { shift->cust_statuscolor(@_); }
4075 sub cust_statuscolor {
4077 __PACKAGE__->statuscolors->{$self->cust_status};
4080 =item tickets [ STATUS ]
4082 Returns an array of hashes representing the customer's RT tickets.
4084 An optional status (or arrayref or hashref of statuses) may be specified.
4090 my $status = ( @_ && $_[0] ) ? shift : '';
4092 my $num = $conf->config('cust_main-max_tickets') || 10;
4095 if ( $conf->config('ticket_system') ) {
4096 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4098 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4107 foreach my $priority (
4108 $conf->config('ticket_system-custom_priority_field-values'), ''
4110 last if scalar(@tickets) >= $num;
4112 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4113 $num - scalar(@tickets),
4124 =item appointments [ STATUS ]
4126 Returns an array of hashes representing the customer's RT tickets which
4133 my $status = ( @_ && $_[0] ) ? shift : '';
4135 return () unless $conf->config('ticket_system');
4137 my $queueid = $conf->config('ticket_system-appointment-queueid');
4139 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4148 # Return services representing svc_accts in customer support packages
4149 sub support_services {
4151 my %packages = map { $_ => 1 } $conf->config('support_packages');
4153 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4154 grep { $_->part_svc->svcdb eq 'svc_acct' }
4155 map { $_->cust_svc }
4156 grep { exists $packages{ $_->pkgpart } }
4157 $self->ncancelled_pkgs;
4161 # Return a list of latitude/longitude for one of the services (if any)
4162 sub service_coordinates {
4166 grep { $_->latitude && $_->longitude }
4168 map { $_->cust_svc }
4169 $self->ncancelled_pkgs;
4171 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4176 Returns a masked version of the named field
4181 my ($self,$field) = @_;
4185 'x'x(length($self->getfield($field))-4).
4186 substr($self->getfield($field), (length($self->getfield($field))-4));
4190 =item payment_history
4192 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4193 cust_credit and cust_refund objects. Each hashref has the following fields:
4195 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4197 I<date> - value of _date field, unix timestamp
4199 I<date_pretty> - user-friendly date
4201 I<description> - user-friendly description of item
4203 I<amount> - impact of item on user's balance
4204 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4205 Not to be confused with the native 'amount' field in cust_credit, see below.
4207 I<amount_pretty> - includes money char
4209 I<balance> - customer balance, chronologically as of this item
4211 I<balance_pretty> - includes money char
4213 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4215 I<paid> - amount paid for cust_pay records, undef for other types
4217 I<credit> - amount credited for cust_credit records, undef for other types.
4218 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4220 I<refund> - amount refunded for cust_refund records, undef for other types
4222 The four table-specific keys always have positive values, whether they reflect charges or payments.
4224 The following options may be passed to this method:
4226 I<line_items> - if true, returns charges ('Line item') rather than invoices
4228 I<start_date> - unix timestamp, only include records on or after.
4229 If specified, an item of type 'Previous' will also be included.
4230 It does not have table-specific fields.
4232 I<end_date> - unix timestamp, only include records before
4234 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4236 I<conf> - optional already-loaded FS::Conf object.
4240 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4241 # and also for sending customer statements, which should both be kept customer-friendly.
4242 # If you add anything that shouldn't be passed on through the API or exposed
4243 # to customers, add a new option to include it, don't include it by default
4244 sub payment_history {
4246 my $opt = ref($_[0]) ? $_[0] : { @_ };
4248 my $conf = $$opt{'conf'} || new FS::Conf;
4249 my $money_char = $conf->config("money_char") || '$',
4251 #first load entire history,
4252 #need previous to calculate previous balance
4253 #loading after end_date shouldn't hurt too much?
4255 if ( $$opt{'line_items'} ) {
4257 foreach my $cust_bill ( $self->cust_bill ) {
4260 'type' => 'Line item',
4261 'description' => $_->desc( $self->locale ).
4262 ( $_->sdate && $_->edate
4263 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4264 ' To '. time2str('%d-%b-%Y', $_->edate)
4267 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4268 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4269 'date' => $cust_bill->_date,
4270 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4272 foreach $cust_bill->cust_bill_pkg;
4279 'type' => 'Invoice',
4280 'description' => 'Invoice #'. $_->display_invnum,
4281 'amount' => sprintf('%.2f', $_->charged ),
4282 'charged' => sprintf('%.2f', $_->charged ),
4283 'date' => $_->_date,
4284 'date_pretty' => $self->time2str_local('short', $_->_date ),
4286 foreach $self->cust_bill;
4291 'type' => 'Payment',
4292 'description' => 'Payment', #XXX type
4293 'amount' => sprintf('%.2f', 0 - $_->paid ),
4294 'paid' => sprintf('%.2f', $_->paid ),
4295 'date' => $_->_date,
4296 'date_pretty' => $self->time2str_local('short', $_->_date ),
4298 foreach $self->cust_pay;
4302 'description' => 'Credit', #more info?
4303 'amount' => sprintf('%.2f', 0 -$_->amount ),
4304 'credit' => sprintf('%.2f', $_->amount ),
4305 'date' => $_->_date,
4306 'date_pretty' => $self->time2str_local('short', $_->_date ),
4308 foreach $self->cust_credit;
4312 'description' => 'Refund', #more info? type, like payment?
4313 'amount' => $_->refund,
4314 'refund' => $_->refund,
4315 'date' => $_->_date,
4316 'date_pretty' => $self->time2str_local('short', $_->_date ),
4318 foreach $self->cust_refund;
4320 #put it all in chronological order
4321 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4323 #calculate balance, filter items outside date range
4327 foreach my $item (@history) {
4328 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4329 $balance += $$item{'amount'};
4330 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4331 $previous += $$item{'amount'};
4334 $$item{'balance'} = sprintf("%.2f",$balance);
4335 foreach my $key ( qw(amount balance) ) {
4336 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4341 # start with previous balance, if there was one
4344 'type' => 'Previous',
4345 'description' => 'Previous balance',
4346 'amount' => sprintf("%.2f",$previous),
4347 'balance' => sprintf("%.2f",$previous),
4348 'date' => $$opt{'start_date'},
4349 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4351 #false laziness with above
4352 foreach my $key ( qw(amount balance) ) {
4353 $$item{$key.'_pretty'} = $$item{$key};
4354 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4356 unshift(@out,$item);
4359 @out = reverse @history if $$opt{'reverse_sort'};
4364 =item save_cust_payby
4366 Saves a new cust_payby for this customer, replacing an existing entry only
4367 in select circumstances. Does not validate input.
4369 If auto is specified, marks this as the customer's primary method, or the
4370 specified weight. Existing payment methods have their weight incremented as
4373 If bill_location is specified with auto, also sets location in cust_main.
4375 Will not insert complete duplicates of existing records, or records in which the
4376 only difference from an existing record is to turn off automatic payment (will
4377 return without error.) Will replace existing records in which the only difference
4378 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4379 Fields marked as preserved are optional, and existing values will not be overwritten with
4380 blanks when replacing.
4382 Accepts the following named parameters:
4392 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4396 optional, set higher than 1 for secondary, etc.
4404 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4412 optional, will be preserved when replacing
4420 CARD only, required, FS::cust_location object
4422 =item paystart_month
4424 CARD only, optional, will be preserved when replacing
4428 CARD only, optional, will be preserved when replacing
4432 CARD only, optional, will be preserved when replacing
4436 CARD only, only used if conf cvv-save is set appropriately
4450 #The code for this option is in place, but it's not currently used
4454 # existing cust_payby object to be replaced (must match custnum)
4456 # stateid/stateid_state/ss are not currently supported in cust_payby,
4457 # might not even work properly in 4.x, but will need to work here if ever added
4459 sub save_cust_payby {
4463 my $old = $opt{'replace'};
4464 my $new = new FS::cust_payby { $old ? $old->hash : () };
4465 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4466 $new->set( 'custnum' => $self->custnum );
4468 my $payby = $opt{'payment_payby'};
4469 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4471 # don't allow turning off auto when replacing
4472 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4474 my @check_existing; # payby relevant to this payment_payby
4476 # set payby based on auto
4477 if ( $payby eq 'CARD' ) {
4478 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4479 @check_existing = qw( CARD DCRD );
4480 } elsif ( $payby eq 'CHEK' ) {
4481 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4482 @check_existing = qw( CHEK DCHK );
4485 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4488 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4489 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4490 $new->set( 'payname' => $opt{'payname'} );
4491 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4493 my $conf = new FS::Conf;
4495 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4496 if ( $payby eq 'CARD' &&
4497 ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4498 || $conf->exists('business-onlinepayment-verification')
4501 $new->set( 'paycvv' => $opt{'paycvv'} );
4503 $new->set( 'paycvv' => '');
4506 local $SIG{HUP} = 'IGNORE';
4507 local $SIG{INT} = 'IGNORE';
4508 local $SIG{QUIT} = 'IGNORE';
4509 local $SIG{TERM} = 'IGNORE';
4510 local $SIG{TSTP} = 'IGNORE';
4511 local $SIG{PIPE} = 'IGNORE';
4513 my $oldAutoCommit = $FS::UID::AutoCommit;
4514 local $FS::UID::AutoCommit = 0;
4517 # set fields specific to payment_payby
4518 if ( $payby eq 'CARD' ) {
4519 if ($opt{'bill_location'}) {
4520 $opt{'bill_location'}->set('custnum' => $self->custnum);
4521 my $error = $opt{'bill_location'}->find_or_insert;
4523 $dbh->rollback if $oldAutoCommit;
4526 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4528 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4529 $new->set( $field => $opt{$field} );
4532 foreach my $field ( qw(paytype paystate) ) {
4533 $new->set( $field => $opt{$field} );
4537 # other cust_payby to compare this to
4538 my @existing = $self->cust_payby(@check_existing);
4540 # fields that can overwrite blanks with values, but not values with blanks
4541 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4543 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4545 # generally, we don't want to overwrite existing cust_payby with this,
4546 # but we can replace if we're only marking it auto or adding a preserved field
4547 # and we can avoid saving a total duplicate or merely turning off auto
4549 foreach my $cust_payby (@existing) {
4550 # check fields that absolutely should not change
4551 foreach my $field ($new->fields) {
4552 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4553 next if grep(/^$field$/, @preserve );
4554 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4556 # now check fields that can replace if one value is blank
4558 foreach my $field (@preserve) {
4560 ( $new->get($field) and !$cust_payby->get($field) ) or
4561 ( $cust_payby->get($field) and !$new->get($field) )
4563 # prevention of overwriting values with blanks happens farther below
4565 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4569 unless ( $replace ) {
4570 # nearly identical, now check weight
4571 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4572 # ignore identical cust_payby, and ignore attempts to turn off auto
4573 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4574 $skip_cust_payby = 1;
4577 # otherwise, only change is to mark this as primary
4579 # if we got this far, we're definitely replacing
4586 $new->set( 'custpaybynum' => $old->custpaybynum );
4587 # don't turn off automatic payment (but allow it to be turned on)
4588 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4590 $new->set( 'payby' => $old->payby );
4591 $new->set( 'weight' => 1 );
4593 # make sure we're not overwriting values with blanks
4594 foreach my $field (@preserve) {
4595 if ( $old->get($field) and !$new->get($field) ) {
4596 $new->set( $field => $old->get($field) );
4601 # only overwrite cust_main bill_location if auto
4602 if ($opt{'auto'} && $opt{'bill_location'}) {
4603 $self->set('bill_location' => $opt{'bill_location'});
4604 my $error = $self->replace;
4606 $dbh->rollback if $oldAutoCommit;
4611 # done with everything except reweighting and saving cust_payby
4612 # still need to commit changes to cust_main and cust_location
4613 if ($skip_cust_payby) {
4614 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4618 # re-weight existing primary cust_pay for this payby
4620 foreach my $cust_payby (@existing) {
4621 # relies on cust_payby return order
4622 last unless $cust_payby->payby !~ /^D/;
4623 last if $cust_payby->weight > 1;
4624 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4625 next if $cust_payby->weight < ($opt{'weight'} || 1);
4626 $cust_payby->weight( $cust_payby->weight + 1 );
4627 my $error = $cust_payby->replace;
4629 $dbh->rollback if $oldAutoCommit;
4630 return "Error reweighting cust_payby: $error";
4635 # finally, save cust_payby
4636 my $error = $old ? $new->replace($old) : $new->insert;
4638 $dbh->rollback if $oldAutoCommit;
4642 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4647 =item remove_cvv_from_cust_payby PAYINFO
4649 Removes paycvv from associated cust_payby with matching PAYINFO.
4653 sub remove_cvv_from_cust_payby {
4654 my ($self,$payinfo) = @_;
4656 my $oldAutoCommit = $FS::UID::AutoCommit;
4657 local $FS::UID::AutoCommit = 0;
4660 foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
4661 next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
4662 $cust_payby->paycvv('');
4663 my $error = $cust_payby->replace;
4665 $dbh->rollback if $oldAutoCommit;
4670 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4676 =head1 CLASS METHODS
4682 Class method that returns the list of possible status strings for customers
4683 (see L<the status method|/status>). For example:
4685 @statuses = FS::cust_main->statuses();
4691 keys %{ $self->statuscolors };
4694 =item cust_status_sql
4696 Returns an SQL fragment to determine the status of a cust_main record, as a
4701 sub cust_status_sql {
4703 for my $status ( FS::cust_main->statuses() ) {
4704 my $method = $status.'_sql';
4705 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4714 Returns an SQL expression identifying prospective cust_main records (customers
4715 with no packages ever ordered)
4719 use vars qw($select_count_pkgs);
4720 $select_count_pkgs =
4721 "SELECT COUNT(*) FROM cust_pkg
4722 WHERE cust_pkg.custnum = cust_main.custnum";
4724 sub select_count_pkgs_sql {
4729 " 0 = ( $select_count_pkgs ) ";
4734 Returns an SQL expression identifying ordered cust_main records (customers with
4735 no active packages, but recurring packages not yet setup or one time charges
4741 FS::cust_main->none_active_sql.
4742 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4747 Returns an SQL expression identifying active cust_main records (customers with
4748 active recurring packages).
4753 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4756 =item none_active_sql
4758 Returns an SQL expression identifying cust_main records with no active
4759 recurring packages. This includes customers of status prospect, ordered,
4760 inactive, and suspended.
4764 sub none_active_sql {
4765 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4770 Returns an SQL expression identifying inactive cust_main records (customers with
4771 no active recurring packages, but otherwise unsuspended/uncancelled).
4776 FS::cust_main->none_active_sql.
4777 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4783 Returns an SQL expression identifying suspended cust_main records.
4788 sub suspended_sql { susp_sql(@_); }
4790 FS::cust_main->none_active_sql.
4791 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4797 Returns an SQL expression identifying cancelled cust_main records.
4801 sub cancel_sql { shift->cancelled_sql(@_); }
4804 =item uncancelled_sql
4806 Returns an SQL expression identifying un-cancelled cust_main records.
4810 sub uncancelled_sql { uncancel_sql(@_); }
4813 "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
4818 Returns an SQL fragment to retreive the balance.
4823 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4824 WHERE cust_bill.custnum = cust_main.custnum )
4825 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4826 WHERE cust_pay.custnum = cust_main.custnum )
4827 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4828 WHERE cust_credit.custnum = cust_main.custnum )
4829 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4830 WHERE cust_refund.custnum = cust_main.custnum )
4833 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4835 Returns an SQL fragment to retreive the balance for this customer, optionally
4836 considering invoices with date earlier than START_TIME, and not
4837 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4838 total_unapplied_payments).
4840 Times are specified as SQL fragments or numeric
4841 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4842 L<Date::Parse> for conversion functions. The empty string can be passed
4843 to disable that time constraint completely.
4845 Available options are:
4849 =item unapplied_date
4851 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)
4856 set to true to remove all customer comparison clauses, for totals
4861 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4866 JOIN clause (typically used with the total option)
4870 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4871 time will be ignored. Note that START_TIME and END_TIME only limit the date
4872 range for invoices and I<unapplied> payments, credits, and refunds.
4878 sub balance_date_sql {
4879 my( $class, $start, $end, %opt ) = @_;
4881 my $cutoff = $opt{'cutoff'};
4883 my $owed = FS::cust_bill->owed_sql($cutoff);
4884 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4885 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4886 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4888 my $j = $opt{'join'} || '';
4890 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4891 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4892 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4893 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4895 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4896 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4897 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4898 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4903 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4905 Returns an SQL fragment to retreive the total unapplied payments for this
4906 customer, only considering payments with date earlier than START_TIME, and
4907 optionally not later than END_TIME.
4909 Times are specified as SQL fragments or numeric
4910 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4911 L<Date::Parse> for conversion functions. The empty string can be passed
4912 to disable that time constraint completely.
4914 Available options are:
4918 sub unapplied_payments_date_sql {
4919 my( $class, $start, $end, %opt ) = @_;
4921 my $cutoff = $opt{'cutoff'};
4923 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4925 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4926 'unapplied_date'=>1 );
4928 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4931 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4933 Helper method for balance_date_sql; name (and usage) subject to change
4934 (suggestions welcome).
4936 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4937 cust_refund, cust_credit or cust_pay).
4939 If TABLE is "cust_bill" or the unapplied_date option is true, only
4940 considers records with date earlier than START_TIME, and optionally not
4941 later than END_TIME .
4945 sub _money_table_where {
4946 my( $class, $table, $start, $end, %opt ) = @_;
4949 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4950 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4951 push @where, "$table._date <= $start" if defined($start) && length($start);
4952 push @where, "$table._date > $end" if defined($end) && length($end);
4954 push @where, @{$opt{'where'}} if $opt{'where'};
4955 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4961 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4962 use FS::cust_main::Search;
4965 FS::cust_main::Search->search(@_);
4974 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4976 Generates a templated notification to the customer (see L<Text::Template>).
4978 OPTIONS is a hash and may include
4980 I<extra_fields> - a hashref of name/value pairs which will be substituted
4981 into the template. These values may override values mentioned below
4982 and those from the customer record.
4984 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
4986 The following variables are available in the template instead of or in addition
4987 to the fields of the customer record.
4989 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4993 # a lot like cust_bill::print_latex
4994 sub generate_letter {
4995 my ($self, $template, %options) = @_;
4997 warn "Template $template does not exist" && return
4998 unless $conf->exists($template) || $options{'template_text'};
5000 my $template_source = $options{'template_text'}
5001 ? [ $options{'template_text'} ]
5002 : [ map "$_\n", $conf->config($template) ];
5004 my $letter_template = new Text::Template
5006 SOURCE => $template_source,
5007 DELIMITERS => [ '[@--', '--@]' ],
5009 or die "can't create new Text::Template object: Text::Template::ERROR";
5011 $letter_template->compile()
5012 or die "can't compile template: Text::Template::ERROR";
5014 my %letter_data = map { $_ => $self->$_ } $self->fields;
5016 for (keys %{$options{extra_fields}}){
5017 $letter_data{$_} = $options{extra_fields}->{$_};
5020 unless(exists($letter_data{returnaddress})){
5021 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5022 $self->agent_template)
5024 if ( length($retadd) ) {
5025 $letter_data{returnaddress} = $retadd;
5026 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5027 $letter_data{returnaddress} =
5028 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5032 ( $conf->config('company_name', $self->agentnum),
5033 $conf->config('company_address', $self->agentnum),
5037 $letter_data{returnaddress} = '~';
5041 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5043 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5045 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5047 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5051 ) or die "can't open temp file: $!\n";
5052 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5053 or die "can't write temp file: $!\n";
5055 $letter_data{'logo_file'} = $lh->filename;
5057 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5061 ) or die "can't open temp file: $!\n";
5063 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5065 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5066 return ($1, $letter_data{'logo_file'});
5070 =item print_ps TEMPLATE
5072 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5078 my($file, $lfile) = $self->generate_letter(@_);
5079 my $ps = FS::Misc::generate_ps($file);
5080 unlink($file.'.tex');
5086 =item print TEMPLATE
5088 Prints the filled in template.
5090 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5094 sub queueable_print {
5097 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5098 or die "invalid customer number: " . $opt{custnum};
5100 #do not backport this change to 3.x
5101 # my $error = $self->print( { 'template' => $opt{template} } );
5102 my $error = $self->print( $opt{'template'} );
5103 die $error if $error;
5107 my ($self, $template) = (shift, shift);
5109 [ $self->print_ps($template) ],
5110 'agentnum' => $self->agentnum,
5114 #these three subs should just go away once agent stuff is all config overrides
5116 sub agent_template {
5118 $self->_agent_plandata('agent_templatename');
5121 sub agent_invoice_from {
5123 $self->_agent_plandata('agent_invoice_from');
5126 sub _agent_plandata {
5127 my( $self, $option ) = @_;
5129 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5130 #agent-specific Conf
5132 use FS::part_event::Condition;
5134 my $agentnum = $self->agentnum;
5136 my $regexp = regexp_sql();
5138 my $part_event_option =
5140 'select' => 'part_event_option.*',
5141 'table' => 'part_event_option',
5143 LEFT JOIN part_event USING ( eventpart )
5144 LEFT JOIN part_event_option AS peo_agentnum
5145 ON ( part_event.eventpart = peo_agentnum.eventpart
5146 AND peo_agentnum.optionname = 'agentnum'
5147 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5149 LEFT JOIN part_event_condition
5150 ON ( part_event.eventpart = part_event_condition.eventpart
5151 AND part_event_condition.conditionname = 'cust_bill_age'
5153 LEFT JOIN part_event_condition_option
5154 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5155 AND part_event_condition_option.optionname = 'age'
5158 #'hashref' => { 'optionname' => $option },
5159 #'hashref' => { 'part_event_option.optionname' => $option },
5161 " WHERE part_event_option.optionname = ". dbh->quote($option).
5162 " AND action = 'cust_bill_send_agent' ".
5163 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5164 " AND peo_agentnum.optionname = 'agentnum' ".
5165 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5167 CASE WHEN part_event_condition_option.optionname IS NULL
5169 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5171 , part_event.weight".
5175 unless ( $part_event_option ) {
5176 return $self->agent->invoice_template || ''
5177 if $option eq 'agent_templatename';
5181 $part_event_option->optionvalue;
5185 sub process_o2m_qsearch {
5188 return qsearch($table, @_) unless $table eq 'contact';
5190 my $hashref = shift;
5191 my %hash = %$hashref;
5192 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5193 or die 'guru meditation #4343';
5195 qsearch({ 'table' => 'contact',
5196 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5197 'hashref' => \%hash,
5198 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5199 " cust_contact.custnum = $custnum "
5203 sub process_o2m_qsearchs {
5206 return qsearchs($table, @_) unless $table eq 'contact';
5208 my $hashref = shift;
5209 my %hash = %$hashref;
5210 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5211 or die 'guru meditation #2121';
5213 qsearchs({ 'table' => 'contact',
5214 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5215 'hashref' => \%hash,
5216 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5217 " cust_contact.custnum = $custnum "
5221 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5223 Subroutine (not a method), designed to be called from the queue.
5225 Takes a list of options and values.
5227 Pulls up the customer record via the custnum option and calls bill_and_collect.
5232 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5234 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5235 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5237 #without this errors don't get rolled back
5238 $args{'fatal'} = 1; # runs from job queue, will be caught
5240 $cust_main->bill_and_collect( %args );
5243 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5245 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5246 C<collect> part. This is used in batch tax calculation, where invoice
5247 generation and collection events have to be completely separated.
5251 sub queued_collect {
5253 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5255 $cust_main->collect(%args);
5258 sub process_bill_and_collect {
5261 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5262 or die "custnum '$param->{custnum}' not found!\n";
5263 $param->{'job'} = $job;
5264 $param->{'fatal'} = 1; # runs from job queue, will be caught
5265 $param->{'retry'} = 1;
5267 $cust_main->bill_and_collect( %$param );
5270 #starting to take quite a while for big dbs
5271 # (JRNL: journaled so it only happens once per database)
5272 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5273 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5274 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5275 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5276 # JRNL leading/trailing spaces in first, last, company
5277 # JRNL migrate to cust_payby
5278 # - otaker upgrade? journal and call it good? (double check to make sure
5279 # we're not still setting otaker here)
5281 #only going to get worse with new location stuff...
5283 sub _upgrade_data { #class method
5284 my ($class, %opts) = @_;
5286 my @statements = ();
5288 #this seems to be the only expensive one.. why does it take so long?
5289 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5291 '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';
5292 FS::upgrade_journal->set_done('cust_main__signupdate');
5296 foreach my $sql ( @statements ) {
5297 my $sth = dbh->prepare($sql) or die dbh->errstr;
5298 $sth->execute or die $sth->errstr;
5299 #warn ( (time - $t). " seconds\n" );
5303 local($ignore_expired_card) = 1;
5304 local($ignore_banned_card) = 1;
5305 local($skip_fuzzyfiles) = 1;
5306 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5308 FS::cust_main::Location->_upgrade_data(%opts);
5310 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5312 foreach my $cust_main ( qsearch({
5313 'table' => 'cust_main',
5315 'extra_sql' => 'WHERE '.
5317 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5318 qw( first last company )
5321 my $error = $cust_main->replace;
5322 die $error if $error;
5325 FS::upgrade_journal->set_done('cust_main__trimspaces');
5329 $class->_upgrade_otaker(%opts);
5339 The delete method should possibly take an FS::cust_main object reference
5340 instead of a scalar customer number.
5342 Bill and collect options should probably be passed as references instead of a
5345 There should probably be a configuration file with a list of allowed credit
5348 No multiple currency support (probably a larger project than just this module).
5350 Birthdates rely on negative epoch values.
5352 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5356 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5357 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5358 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.