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('force_prorate_day')
1779 || $self->ut_flag('edit_subject')
1780 || $self->ut_flag('calling_list_exempt')
1781 || $self->ut_flag('invoice_noemail')
1782 || $self->ut_flag('message_noemail')
1783 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1784 || $self->ut_currencyn('currency')
1785 || $self->ut_textn('po_number')
1786 || $self->ut_enum('complimentary', [ '', 'Y' ])
1787 || $self->ut_flag('invoice_ship_address')
1788 || $self->ut_flag('invoice_dest')
1791 foreach (qw(company ship_company)) {
1792 my $company = $self->get($_);
1793 $company =~ s/^\s+//;
1794 $company =~ s/\s+$//;
1795 $company =~ s/\s+/ /g;
1796 $self->set($_, $company);
1799 #barf. need message catalogs. i18n. etc.
1800 $error .= "Please select an advertising source."
1801 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1802 return $error if $error;
1804 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1805 or return "Unknown agent";
1807 if ( $self->currency ) {
1808 my $agent_currency = qsearchs( 'agent_currency', {
1809 'agentnum' => $agent->agentnum,
1810 'currency' => $self->currency,
1812 or return "Agent ". $agent->agent.
1813 " not permitted to offer ". $self->currency. " invoicing";
1816 return "Unknown refnum"
1817 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1819 return "Unknown referring custnum: ". $self->referral_custnum
1820 unless ! $self->referral_custnum
1821 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1823 if ( $self->ss eq '' ) {
1828 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1829 or return "Illegal social security number: ". $self->ss;
1830 $self->ss("$1-$2-$3");
1833 #turn off invoice_ship_address if ship & bill are the same
1834 if ($self->bill_locationnum eq $self->ship_locationnum) {
1835 $self->invoice_ship_address('');
1838 # cust_main_county verification now handled by cust_location check
1841 $self->ut_phonen('daytime', $self->country)
1842 || $self->ut_phonen('night', $self->country)
1843 || $self->ut_phonen('fax', $self->country)
1844 || $self->ut_phonen('mobile', $self->country)
1846 return $error if $error;
1848 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1850 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1853 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1855 : FS::Msgcat::_gettext('daytime');
1856 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1858 : FS::Msgcat::_gettext('night');
1860 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1862 : FS::Msgcat::_gettext('mobile');
1864 return "$daytime_label, $night_label or $mobile_label is required"
1868 return "Please select an invoicing locale"
1871 && $conf->exists('cust_main-require_locale');
1873 return "Please select a customer class"
1874 if ! $self->classnum
1875 && $conf->exists('cust_main-require_classnum');
1877 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1878 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1882 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
1884 warn "$me check AFTER: \n". $self->_dump
1887 $self->SUPER::check;
1890 sub check_payinfo_cardtype {
1893 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
1895 my $payinfo = $self->payinfo;
1896 $payinfo =~ s/\D//g;
1898 return '' if $payinfo =~ /^99\d{14}$/; #token
1900 my %bop_card_types = map { $_=>1 } values %{ card_types() };
1901 my $cardtype = cardtype($payinfo);
1903 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
1911 Additional checks for replace only.
1916 my ($new,$old) = @_;
1917 #preserve old value if global config is set
1918 if ($old && $conf->exists('invoice-ship_address')) {
1919 $new->invoice_ship_address($old->invoice_ship_address);
1926 Returns a list of fields which have ship_ duplicates.
1931 qw( last first company
1933 address1 address2 city county state zip country
1935 daytime night fax mobile
1939 =item has_ship_address
1941 Returns true if this customer record has a separate shipping address.
1945 sub has_ship_address {
1947 $self->bill_locationnum != $self->ship_locationnum;
1952 Returns a list of key/value pairs, with the following keys: address1,
1953 adddress2, city, county, state, zip, country, district, and geocode. The
1954 shipping address is used if present.
1960 $self->ship_location->location_hash;
1965 Returns all locations (see L<FS::cust_location>) for this customer.
1972 'table' => 'cust_location',
1973 'hashref' => { 'custnum' => $self->custnum,
1974 'prospectnum' => '',
1976 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
1982 Returns all contact associations (see L<FS::cust_contact>) for this customer.
1988 qsearch('cust_contact', { 'custnum' => $self->custnum } );
1991 =item cust_payby PAYBY
1993 Returns all payment methods (see L<FS::cust_payby>) for this customer.
1995 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
1996 Does not validate PAYBY.
2004 'table' => 'cust_payby',
2005 'hashref' => { 'custnum' => $self->custnum },
2006 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
2008 $search->{'extra_sql'} = ' AND payby IN ( '.
2009 join(',', map dbh->quote($_), @payby).
2016 =item has_cust_payby_auto
2018 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2022 sub has_cust_payby_auto {
2025 'table' => 'cust_payby',
2026 'hashref' => { 'custnum' => $self->custnum, },
2027 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2028 'order_by' => 'LIMIT 1',
2035 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2036 and L<FS::cust_pkg>) for this customer, except those on hold.
2038 Returns a list: an empty list on success or a list of errors.
2044 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2049 Unsuspends all suspended packages in the on-hold state (those without setup
2050 dates) for this customer.
2056 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2061 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2063 Returns a list: an empty list on success or a list of errors.
2069 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2072 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2074 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2075 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2076 of a list of pkgparts; the hashref has the following keys:
2080 =item pkgparts - listref of pkgparts
2082 =item (other options are passed to the suspend method)
2087 Returns a list: an empty list on success or a list of errors.
2091 sub suspend_if_pkgpart {
2093 my (@pkgparts, %opt);
2094 if (ref($_[0]) eq 'HASH'){
2095 @pkgparts = @{$_[0]{pkgparts}};
2100 grep { $_->suspend(%opt) }
2101 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2102 $self->unsuspended_pkgs;
2105 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2107 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2108 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2109 instead of a list of pkgparts; the hashref has the following keys:
2113 =item pkgparts - listref of pkgparts
2115 =item (other options are passed to the suspend method)
2119 Returns a list: an empty list on success or a list of errors.
2123 sub suspend_unless_pkgpart {
2125 my (@pkgparts, %opt);
2126 if (ref($_[0]) eq 'HASH'){
2127 @pkgparts = @{$_[0]{pkgparts}};
2132 grep { $_->suspend(%opt) }
2133 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2134 $self->unsuspended_pkgs;
2137 =item cancel [ OPTION => VALUE ... ]
2139 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2140 The cancellation time will be now.
2144 Always returns a list: an empty list on success or a list of errors.
2151 warn "$me cancel called on customer ". $self->custnum. " with options ".
2152 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2154 my @pkgs = $self->ncancelled_pkgs;
2156 $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2159 =item cancel_pkgs OPTIONS
2161 Cancels a specified list of packages. OPTIONS can include:
2165 =item cust_pkg - an arrayref of the packages. Required.
2167 =item time - the cancellation time, used to calculate final bills and
2168 unused-time credits if any. Will be passed through to the bill() and
2169 FS::cust_pkg::cancel() methods.
2171 =item quiet - can be set true to supress email cancellation notices.
2173 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a
2174 reasonnum of an existing reason, or passing a hashref will create a new reason.
2175 The hashref should have the following keys:
2176 typenum - Reason type (see L<FS::reason_type>)
2177 reason - Text of the new reason.
2179 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2180 for the individual packages, parallel to the C<cust_pkg> argument. The
2181 reason and reason_otaker arguments will be taken from those objects.
2183 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2185 =item nobill - can be set true to skip billing if it might otherwise be done.
2190 my( $self, %opt ) = @_;
2192 # we're going to cancel services, which is not reversible
2193 die "cancel_pkgs cannot be run inside a transaction"
2194 if $FS::UID::AutoCommit == 0;
2196 local $FS::UID::AutoCommit = 0;
2198 return ( 'access denied' )
2199 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2201 if ( $opt{'ban'} ) {
2203 foreach my $cust_payby ( $self->cust_payby ) {
2205 #well, if they didn't get decrypted on search, then we don't have to
2206 # try again... queue a job for the server that does have decryption
2207 # capability if we're in a paranoid multi-server implementation?
2208 return ( "Can't (yet) ban encrypted credit cards" )
2209 if $cust_payby->is_encrypted($cust_payby->payinfo);
2211 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2212 my $error = $ban->insert;
2222 my @pkgs = @{ delete $opt{'cust_pkg'} };
2223 my $cancel_time = $opt{'time'} || time;
2225 # bill all packages first, so we don't lose usage, service counts for
2226 # bulk billing, etc.
2227 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2229 my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2231 'time' => $cancel_time );
2233 warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2235 return ( "Error billing during cancellation: $error" );
2241 # try to cancel each service, the same way we would for individual packages,
2242 # but in cancel weight order.
2243 my @cust_svc = map { $_->cust_svc } @pkgs;
2244 my @sorted_cust_svc =
2246 sort { $a->[1] <=> $b->[1] }
2247 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2249 warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2252 foreach my $cust_svc (@sorted_cust_svc) {
2253 my $part_svc = $cust_svc->part_svc;
2254 next if ( defined($part_svc) and $part_svc->preserve );
2255 # immediate cancel, no date option
2256 # transactionize individually
2257 my $error = try { $cust_svc->cancel } catch { $_ };
2260 push @errors, $error;
2269 warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2270 $self->custnum. "\n"
2274 if ($opt{'cust_pkg_reason'}) {
2275 @cprs = @{ delete $opt{'cust_pkg_reason'} };
2281 my $cpr = shift @cprs;
2283 $lopt{'reason'} = $cpr->reasonnum;
2284 $lopt{'reason_otaker'} = $cpr->otaker;
2286 warn "no reason found when canceling package ".$_->pkgnum."\n";
2287 # we're not actually required to pass a reason to cust_pkg::cancel,
2288 # but if we're getting to this point, something has gone awry.
2289 $null_reason ||= FS::reason->new_or_existing(
2290 reason => 'unknown reason',
2291 type => 'Cancel Reason',
2294 $lopt{'reason'} = $null_reason->reasonnum;
2295 $lopt{'reason_otaker'} = $FS::CurrentUser::CurrentUser->username;
2298 my $error = $_->cancel(%lopt);
2301 push @errors, 'pkgnum '.$_->pkgnum.': '.$error;
2310 sub _banned_pay_hashref {
2311 die 'cust_main->_banned_pay_hashref deprecated';
2323 'payby' => $payby2ban{$self->payby},
2324 'payinfo' => $self->payinfo,
2325 #don't ever *search* on reason! #'reason' =>
2331 Returns all notes (see L<FS::cust_main_note>) for this customer.
2336 my($self,$orderby_classnum) = (shift,shift);
2337 my $orderby = "sticky DESC, _date DESC";
2338 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2339 qsearch( 'cust_main_note',
2340 { 'custnum' => $self->custnum },
2342 "ORDER BY $orderby",
2348 Returns the agent (see L<FS::agent>) for this customer.
2352 Returns the agent name (see L<FS::agent>) for this customer.
2358 $self->agent->agent;
2363 Returns any tags associated with this customer, as FS::cust_tag objects,
2364 or an empty list if there are no tags.
2368 Returns any tags associated with this customer, as FS::part_tag objects,
2369 or an empty list if there are no tags.
2375 map $_->part_tag, $self->cust_tag;
2381 Returns the customer class, as an FS::cust_class object, or the empty string
2382 if there is no customer class.
2386 Returns the customer category name, or the empty string if there is no customer
2393 my $cust_class = $self->cust_class;
2395 ? $cust_class->categoryname
2401 Returns the customer class name, or the empty string if there is no customer
2408 my $cust_class = $self->cust_class;
2410 ? $cust_class->classname
2416 Returns the external tax status, as an FS::tax_status object, or the empty
2417 string if there is no tax status.
2423 if ( $self->taxstatusnum ) {
2424 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2432 Returns the tax status code if there is one.
2438 my $tax_status = $self->tax_status;
2440 ? $tax_status->taxstatus
2444 =item BILLING METHODS
2446 Documentation on billing methods has been moved to
2447 L<FS::cust_main::Billing>.
2449 =item REALTIME BILLING METHODS
2451 Documentation on realtime billing methods has been moved to
2452 L<FS::cust_main::Billing_Realtime>.
2456 Removes the I<paycvv> field from the database directly.
2458 If there is an error, returns the error, otherwise returns false.
2460 DEPRECATED. Use L</remove_cvv_from_cust_payby> instead.
2465 die 'cust_main->remove_cvv deprecated';
2467 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2468 or return dbh->errstr;
2469 $sth->execute($self->custnum)
2470 or return $sth->errstr;
2477 Returns the total owed for this customer on all invoices
2478 (see L<FS::cust_bill/owed>).
2484 $self->total_owed_date(2145859200); #12/31/2037
2487 =item total_owed_date TIME
2489 Returns the total owed for this customer on all invoices with date earlier than
2490 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2491 see L<Time::Local> and L<Date::Parse> for conversion functions.
2495 sub total_owed_date {
2499 my $custnum = $self->custnum;
2501 my $owed_sql = FS::cust_bill->owed_sql;
2504 SELECT SUM($owed_sql) FROM cust_bill
2505 WHERE custnum = $custnum
2509 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2513 =item total_owed_pkgnum PKGNUM
2515 Returns the total owed on all invoices for this customer's specific package
2516 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2520 sub total_owed_pkgnum {
2521 my( $self, $pkgnum ) = @_;
2522 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2525 =item total_owed_date_pkgnum TIME PKGNUM
2527 Returns the total owed for this customer's specific package when using
2528 experimental package balances on all invoices with date earlier than
2529 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2530 see L<Time::Local> and L<Date::Parse> for conversion functions.
2534 sub total_owed_date_pkgnum {
2535 my( $self, $time, $pkgnum ) = @_;
2538 foreach my $cust_bill (
2539 grep { $_->_date <= $time }
2540 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2542 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2544 sprintf( "%.2f", $total_bill );
2550 Returns the total amount of all payments.
2557 $total += $_->paid foreach $self->cust_pay;
2558 sprintf( "%.2f", $total );
2561 =item total_unapplied_credits
2563 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2564 customer. See L<FS::cust_credit/credited>.
2566 =item total_credited
2568 Old name for total_unapplied_credits. Don't use.
2572 sub total_credited {
2573 #carp "total_credited deprecated, use total_unapplied_credits";
2574 shift->total_unapplied_credits(@_);
2577 sub total_unapplied_credits {
2580 my $custnum = $self->custnum;
2582 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2585 SELECT SUM($unapplied_sql) FROM cust_credit
2586 WHERE custnum = $custnum
2589 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2593 =item total_unapplied_credits_pkgnum PKGNUM
2595 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2596 customer. See L<FS::cust_credit/credited>.
2600 sub total_unapplied_credits_pkgnum {
2601 my( $self, $pkgnum ) = @_;
2602 my $total_credit = 0;
2603 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2604 sprintf( "%.2f", $total_credit );
2608 =item total_unapplied_payments
2610 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2611 See L<FS::cust_pay/unapplied>.
2615 sub total_unapplied_payments {
2618 my $custnum = $self->custnum;
2620 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2623 SELECT SUM($unapplied_sql) FROM cust_pay
2624 WHERE custnum = $custnum
2627 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2631 =item total_unapplied_payments_pkgnum PKGNUM
2633 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2634 specific package when using experimental package balances. See
2635 L<FS::cust_pay/unapplied>.
2639 sub total_unapplied_payments_pkgnum {
2640 my( $self, $pkgnum ) = @_;
2641 my $total_unapplied = 0;
2642 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2643 sprintf( "%.2f", $total_unapplied );
2647 =item total_unapplied_refunds
2649 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2650 customer. See L<FS::cust_refund/unapplied>.
2654 sub total_unapplied_refunds {
2656 my $custnum = $self->custnum;
2658 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2661 SELECT SUM($unapplied_sql) FROM cust_refund
2662 WHERE custnum = $custnum
2665 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2671 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2672 total_unapplied_credits minus total_unapplied_payments).
2678 $self->balance_date_range;
2681 =item balance_date TIME
2683 Returns the balance for this customer, only considering invoices with date
2684 earlier than TIME (total_owed_date minus total_credited minus
2685 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2686 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2693 $self->balance_date_range(shift);
2696 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2698 Returns the balance for this customer, optionally considering invoices with
2699 date earlier than START_TIME, and not later than END_TIME
2700 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2702 Times are specified as SQL fragments or numeric
2703 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2704 L<Date::Parse> for conversion functions. The empty string can be passed
2705 to disable that time constraint completely.
2707 Accepts the same options as L<balance_date_sql>:
2711 =item unapplied_date
2713 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)
2717 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2718 time will be ignored. Note that START_TIME and END_TIME only limit the date
2719 range for invoices and I<unapplied> payments, credits, and refunds.
2725 sub balance_date_range {
2727 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2728 ') FROM cust_main WHERE custnum='. $self->custnum;
2729 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2732 =item balance_pkgnum PKGNUM
2734 Returns the balance for this customer's specific package when using
2735 experimental package balances (total_owed plus total_unrefunded, minus
2736 total_unapplied_credits minus total_unapplied_payments)
2740 sub balance_pkgnum {
2741 my( $self, $pkgnum ) = @_;
2744 $self->total_owed_pkgnum($pkgnum)
2745 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2746 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2747 - $self->total_unapplied_credits_pkgnum($pkgnum)
2748 - $self->total_unapplied_payments_pkgnum($pkgnum)
2754 Returns a hash of useful information for making a payment.
2764 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2765 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2766 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2770 For credit card transactions:
2782 For electronic check transactions:
2792 #XXX i need to be updated for 4.x+
2798 $return{balance} = $self->balance;
2800 $return{payname} = $self->payname
2801 || ( $self->first. ' '. $self->get('last') );
2803 $return{$_} = $self->bill_location->$_
2804 for qw(address1 address2 city state zip);
2806 $return{payby} = $self->payby;
2807 $return{stateid_state} = $self->stateid_state;
2809 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2810 $return{card_type} = cardtype($self->payinfo);
2811 $return{payinfo} = $self->paymask;
2813 @return{'month', 'year'} = $self->paydate_monthyear;
2817 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2818 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2819 $return{payinfo1} = $payinfo1;
2820 $return{payinfo2} = $payinfo2;
2821 $return{paytype} = $self->paytype;
2822 $return{paystate} = $self->paystate;
2826 #doubleclick protection
2828 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2836 Returns the next payment expiration date for this customer. If they have no
2837 payment methods that will expire, returns 0.
2843 # filter out the ones that individually return 0, but then return 0 if
2844 # there are no results
2845 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
2846 min( @epochs ) || 0;
2849 =item paydate_epoch_sql
2851 Returns an SQL expression to get the next payment expiration date for a
2852 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
2853 dates, so that it's safe to test for "will it expire before date X" for any
2858 sub paydate_epoch_sql {
2860 my $paydate = FS::cust_payby->paydate_epoch_sql;
2861 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
2865 my( $self, $taxname ) = @_;
2867 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2868 'taxname' => $taxname,
2873 =item cust_main_exemption
2875 =item invoicing_list
2877 Returns a list of email addresses (with svcnum entries expanded), and the word
2878 'POST' if the customer receives postal invoices.
2882 sub invoicing_list {
2883 my( $self, $arrayref ) = @_;
2886 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
2889 my @emails = $self->invoicing_list_emailonly;
2890 push @emails, 'POST' if $self->get('postal_invoice');
2895 =item check_invoicing_list ARRAYREF
2897 Checks these arguements as valid input for the invoicing_list method. If there
2898 is an error, returns the error, otherwise returns false.
2902 sub check_invoicing_list {
2903 my( $self, $arrayref ) = @_;
2905 foreach my $address ( @$arrayref ) {
2907 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
2908 return 'Can\'t add FAX invoice destination with a blank FAX number.';
2911 my $cust_main_invoice = new FS::cust_main_invoice ( {
2912 'custnum' => $self->custnum,
2915 my $error = $self->custnum
2916 ? $cust_main_invoice->check
2917 : $cust_main_invoice->checkdest
2919 return $error if $error;
2923 return "Email address required"
2924 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
2925 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
2932 Returns the email addresses of all accounts provisioned for this customer.
2939 foreach my $cust_pkg ( $self->all_pkgs ) {
2940 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
2942 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2943 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2945 $list{$_}=1 foreach map { $_->email } @svc_acct;
2950 =item invoicing_list_addpost
2952 Adds postal invoicing to this customer. If this customer is already configured
2953 to receive postal invoices, does nothing.
2957 sub invoicing_list_addpost {
2959 if ( $self->get('postal_invoice') eq '' ) {
2960 $self->set('postal_invoice', 'Y');
2961 my $error = $self->replace;
2962 warn $error if $error; # should fail harder, but this is traditional
2966 =item invoicing_list_emailonly
2968 Returns the list of email invoice recipients (invoicing_list without non-email
2969 destinations such as POST and FAX).
2973 sub invoicing_list_emailonly {
2975 warn "$me invoicing_list_emailonly called"
2977 return () if !$self->custnum; # not yet inserted
2978 return map { $_->emailaddress }
2980 table => 'cust_contact',
2981 select => 'emailaddress',
2982 addl_from => ' JOIN contact USING (contactnum) '.
2983 ' JOIN contact_email USING (contactnum)',
2984 hashref => { 'custnum' => $self->custnum, },
2985 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
2989 =item invoicing_list_emailonly_scalar
2991 Returns the list of email invoice recipients (invoicing_list without non-email
2992 destinations such as POST and FAX) as a comma-separated scalar.
2996 sub invoicing_list_emailonly_scalar {
2998 warn "$me invoicing_list_emailonly_scalar called"
3000 join(', ', $self->invoicing_list_emailonly);
3003 =item contact_list [ CLASSNUM, ... ]
3005 Returns a list of contacts (L<FS::contact> objects) for the customer. If
3006 a list of contact classnums is given, returns only contacts in those
3007 classes. If the pseudo-classnum 'invoice' is given, returns contacts that
3008 are marked as invoice destinations. If '0' is given, also returns contacts
3011 If no arguments are given, returns all contacts for the customer.
3019 select => 'contact.*, cust_contact.invoice_dest',
3020 addl_from => ' JOIN cust_contact USING (contactnum)',
3021 extra_sql => ' WHERE cust_contact.custnum = '.$self->custnum,
3027 if ( $_ eq 'invoice' ) {
3028 push @orwhere, 'cust_contact.invoice_dest = \'Y\'';
3029 } elsif ( $_ eq '0' ) {
3030 push @orwhere, 'cust_contact.classnum is null';
3031 } elsif ( /^\d+$/ ) {
3032 push @classnums, $_;
3034 die "bad classnum argument '$_'";
3039 push @orwhere, 'cust_contact.classnum IN ('.join(',', @classnums).')';
3042 $search->{extra_sql} .= ' AND (' .
3043 join(' OR ', map "( $_ )", @orwhere) .
3050 =item contact_list_email [ CLASSNUM, ... ]
3052 Same as L</contact_list>, but returns email destinations instead of contact
3057 sub contact_list_email {
3059 my @contacts = $self->contact_list(@_);
3061 foreach my $contact (@contacts) {
3062 foreach my $contact_email ($contact->contact_email) {
3064 $contact->firstlast . ' <' . $contact_email->emailaddress . '>';
3070 =item referral_custnum_cust_main
3072 Returns the customer who referred this customer (or the empty string, if
3073 this customer was not referred).
3075 Note the difference with referral_cust_main method: This method,
3076 referral_custnum_cust_main returns the single customer (if any) who referred
3077 this customer, while referral_cust_main returns an array of customers referred
3082 sub referral_custnum_cust_main {
3084 return '' unless $self->referral_custnum;
3085 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3088 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3090 Returns an array of customers referred by this customer (referral_custnum set
3091 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3092 customers referred by customers referred by this customer and so on, inclusive.
3093 The default behavior is DEPTH 1 (no recursion).
3095 Note the difference with referral_custnum_cust_main method: This method,
3096 referral_cust_main, returns an array of customers referred BY this customer,
3097 while referral_custnum_cust_main returns the single customer (if any) who
3098 referred this customer.
3102 sub referral_cust_main {
3104 my $depth = @_ ? shift : 1;
3105 my $exclude = @_ ? shift : {};
3108 map { $exclude->{$_->custnum}++; $_; }
3109 grep { ! $exclude->{ $_->custnum } }
3110 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3114 map { $_->referral_cust_main($depth-1, $exclude) }
3121 =item referral_cust_main_ncancelled
3123 Same as referral_cust_main, except only returns customers with uncancelled
3128 sub referral_cust_main_ncancelled {
3130 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3133 =item referral_cust_pkg [ DEPTH ]
3135 Like referral_cust_main, except returns a flat list of all unsuspended (and
3136 uncancelled) packages for each customer. The number of items in this list may
3137 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3141 sub referral_cust_pkg {
3143 my $depth = @_ ? shift : 1;
3145 map { $_->unsuspended_pkgs }
3146 grep { $_->unsuspended_pkgs }
3147 $self->referral_cust_main($depth);
3150 =item referring_cust_main
3152 Returns the single cust_main record for the customer who referred this customer
3153 (referral_custnum), or false.
3157 sub referring_cust_main {
3159 return '' unless $self->referral_custnum;
3160 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3163 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3165 Applies a credit to this customer. If there is an error, returns the error,
3166 otherwise returns false.
3168 REASON can be a text string, an FS::reason object, or a scalar reference to
3169 a reasonnum. If a text string, it will be automatically inserted as a new
3170 reason, and a 'reason_type' option must be passed to indicate the
3171 FS::reason_type for the new reason.
3173 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3174 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3175 I<commission_pkgnum>.
3177 Any other options are passed to FS::cust_credit::insert.
3182 my( $self, $amount, $reason, %options ) = @_;
3184 my $cust_credit = new FS::cust_credit {
3185 'custnum' => $self->custnum,
3186 'amount' => $amount,
3189 if ( ref($reason) ) {
3191 if ( ref($reason) eq 'SCALAR' ) {
3192 $cust_credit->reasonnum( $$reason );
3194 $cust_credit->reasonnum( $reason->reasonnum );
3198 $cust_credit->set('reason', $reason)
3201 $cust_credit->$_( delete $options{$_} )
3202 foreach grep exists($options{$_}),
3203 qw( addlinfo eventnum ),
3204 map "commission_$_", qw( agentnum salesnum pkgnum );
3206 $cust_credit->insert(%options);
3210 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3212 Creates a one-time charge for this customer. If there is an error, returns
3213 the error, otherwise returns false.
3215 New-style, with a hashref of options:
3217 my $error = $cust_main->charge(
3221 'start_date' => str2time('7/4/2009'),
3222 'pkg' => 'Description',
3223 'comment' => 'Comment',
3224 'additional' => [], #extra invoice detail
3225 'classnum' => 1, #pkg_class
3227 'setuptax' => '', # or 'Y' for tax exempt
3229 'locationnum'=> 1234, # optional
3232 'taxclass' => 'Tax class',
3235 'taxproduct' => 2, #part_pkg_taxproduct
3236 'override' => {}, #XXX describe
3238 #will be filled in with the new object
3239 'cust_pkg_ref' => \$cust_pkg,
3241 #generate an invoice immediately
3243 'invoice_terms' => '', #with these terms
3249 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3253 #super false laziness w/quotation::charge
3256 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3257 my ( $pkg, $comment, $additional );
3258 my ( $setuptax, $taxclass ); #internal taxes
3259 my ( $taxproduct, $override ); #vendor (CCH) taxes
3261 my $separate_bill = '';
3262 my $cust_pkg_ref = '';
3263 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3265 if ( ref( $_[0] ) ) {
3266 $amount = $_[0]->{amount};
3267 $setup_cost = $_[0]->{setup_cost};
3268 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3269 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3270 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3271 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3272 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3273 : '$'. sprintf("%.2f",$amount);
3274 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3275 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3276 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3277 $additional = $_[0]->{additional} || [];
3278 $taxproduct = $_[0]->{taxproductnum};
3279 $override = { '' => $_[0]->{tax_override} };
3280 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3281 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3282 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3283 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3284 $separate_bill = $_[0]->{separate_bill} || '';
3290 $pkg = @_ ? shift : 'One-time charge';
3291 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3293 $taxclass = @_ ? shift : '';
3297 local $SIG{HUP} = 'IGNORE';
3298 local $SIG{INT} = 'IGNORE';
3299 local $SIG{QUIT} = 'IGNORE';
3300 local $SIG{TERM} = 'IGNORE';
3301 local $SIG{TSTP} = 'IGNORE';
3302 local $SIG{PIPE} = 'IGNORE';
3304 my $oldAutoCommit = $FS::UID::AutoCommit;
3305 local $FS::UID::AutoCommit = 0;
3308 my $part_pkg = new FS::part_pkg ( {
3310 'comment' => $comment,
3314 'classnum' => ( $classnum ? $classnum : '' ),
3315 'setuptax' => $setuptax,
3316 'taxclass' => $taxclass,
3317 'taxproductnum' => $taxproduct,
3318 'setup_cost' => $setup_cost,
3321 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3322 ( 0 .. @$additional - 1 )
3324 'additional_count' => scalar(@$additional),
3325 'setup_fee' => $amount,
3328 my $error = $part_pkg->insert( options => \%options,
3329 tax_overrides => $override,
3332 $dbh->rollback if $oldAutoCommit;
3336 my $pkgpart = $part_pkg->pkgpart;
3337 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3338 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3339 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3340 $error = $type_pkgs->insert;
3342 $dbh->rollback if $oldAutoCommit;
3347 my $cust_pkg = new FS::cust_pkg ( {
3348 'custnum' => $self->custnum,
3349 'pkgpart' => $pkgpart,
3350 'quantity' => $quantity,
3351 'start_date' => $start_date,
3352 'no_auto' => $no_auto,
3353 'separate_bill' => $separate_bill,
3354 'locationnum'=> $locationnum,
3357 $error = $cust_pkg->insert;
3359 $dbh->rollback if $oldAutoCommit;
3361 } elsif ( $cust_pkg_ref ) {
3362 ${$cust_pkg_ref} = $cust_pkg;
3366 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3367 'pkg_list' => [ $cust_pkg ],
3370 $dbh->rollback if $oldAutoCommit;
3375 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3380 #=item charge_postal_fee
3382 #Applies a one time charge this customer. If there is an error,
3383 #returns the error, returns the cust_pkg charge object or false
3384 #if there was no charge.
3388 # This should be a customer event. For that to work requires that bill
3389 # also be a customer event.
3391 sub charge_postal_fee {
3394 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3395 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3397 my $cust_pkg = new FS::cust_pkg ( {
3398 'custnum' => $self->custnum,
3399 'pkgpart' => $pkgpart,
3403 my $error = $cust_pkg->insert;
3404 $error ? $error : $cust_pkg;
3407 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3409 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3411 Optionally, a list or hashref of additional arguments to the qsearch call can
3418 my $opt = ref($_[0]) ? shift : { @_ };
3420 #return $self->num_cust_bill unless wantarray || keys %$opt;
3422 $opt->{'table'} = 'cust_bill';
3423 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3424 $opt->{'hashref'}{'custnum'} = $self->custnum;
3425 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3427 map { $_ } #behavior of sort undefined in scalar context
3428 sort { $a->_date <=> $b->_date }
3432 =item open_cust_bill
3434 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3439 sub open_cust_bill {
3443 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3449 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3451 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3455 sub legacy_cust_bill {
3458 #return $self->num_legacy_cust_bill unless wantarray;
3460 map { $_ } #behavior of sort undefined in scalar context
3461 sort { $a->_date <=> $b->_date }
3462 qsearch({ 'table' => 'legacy_cust_bill',
3463 'hashref' => { 'custnum' => $self->custnum, },
3464 'order_by' => 'ORDER BY _date ASC',
3468 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3470 Returns all the statements (see L<FS::cust_statement>) for this customer.
3472 Optionally, a list or hashref of additional arguments to the qsearch call can
3477 =item cust_bill_void
3479 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3483 sub cust_bill_void {
3486 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3487 sort { $a->_date <=> $b->_date }
3488 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3491 sub cust_statement {
3493 my $opt = ref($_[0]) ? shift : { @_ };
3495 #return $self->num_cust_statement unless wantarray || keys %$opt;
3497 $opt->{'table'} = 'cust_statement';
3498 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3499 $opt->{'hashref'}{'custnum'} = $self->custnum;
3500 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3502 map { $_ } #behavior of sort undefined in scalar context
3503 sort { $a->_date <=> $b->_date }
3507 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3509 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3511 Optionally, a list or hashref of additional arguments to the qsearch call can
3512 be passed following the SVCDB.
3519 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3520 warn "$me svc_x requires a svcdb";
3523 my $opt = ref($_[0]) ? shift : { @_ };
3525 $opt->{'table'} = $svcdb;
3526 $opt->{'addl_from'} =
3527 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3528 ($opt->{'addl_from'} || '');
3530 my $custnum = $self->custnum;
3531 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3532 my $where = "cust_pkg.custnum = $custnum";
3534 my $extra_sql = $opt->{'extra_sql'} || '';
3535 if ( keys %{ $opt->{'hashref'} } ) {
3536 $extra_sql = " AND $where $extra_sql";
3539 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3540 $extra_sql = "WHERE $where AND $1";
3543 $extra_sql = "WHERE $where $extra_sql";
3546 $opt->{'extra_sql'} = $extra_sql;
3551 # required for use as an eventtable;
3554 $self->svc_x('svc_acct', @_);
3559 Returns all the credits (see L<FS::cust_credit>) for this customer.
3566 #return $self->num_cust_credit unless wantarray;
3568 map { $_ } #behavior of sort undefined in scalar context
3569 sort { $a->_date <=> $b->_date }
3570 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3573 =item cust_credit_pkgnum
3575 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3576 package when using experimental package balances.
3580 sub cust_credit_pkgnum {
3581 my( $self, $pkgnum ) = @_;
3582 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3583 sort { $a->_date <=> $b->_date }
3584 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3585 'pkgnum' => $pkgnum,
3590 =item cust_credit_void
3592 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3596 sub cust_credit_void {
3599 sort { $a->_date <=> $b->_date }
3600 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3605 Returns all the payments (see L<FS::cust_pay>) for this customer.
3611 my $opt = ref($_[0]) ? shift : { @_ };
3613 return $self->num_cust_pay unless wantarray || keys %$opt;
3615 $opt->{'table'} = 'cust_pay';
3616 $opt->{'hashref'}{'custnum'} = $self->custnum;
3618 map { $_ } #behavior of sort undefined in scalar context
3619 sort { $a->_date <=> $b->_date }
3626 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3627 called automatically when the cust_pay method is used in a scalar context.
3633 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3634 my $sth = dbh->prepare($sql) or die dbh->errstr;
3635 $sth->execute($self->custnum) or die $sth->errstr;
3636 $sth->fetchrow_arrayref->[0];
3639 =item unapplied_cust_pay
3641 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3645 sub unapplied_cust_pay {
3649 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3655 =item cust_pay_pkgnum
3657 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3658 package when using experimental package balances.
3662 sub cust_pay_pkgnum {
3663 my( $self, $pkgnum ) = @_;
3664 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3665 sort { $a->_date <=> $b->_date }
3666 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3667 'pkgnum' => $pkgnum,
3674 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3680 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3681 sort { $a->_date <=> $b->_date }
3682 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3685 =item cust_pay_pending
3687 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3688 (without status "done").
3692 sub cust_pay_pending {
3694 return $self->num_cust_pay_pending unless wantarray;
3695 sort { $a->_date <=> $b->_date }
3696 qsearch( 'cust_pay_pending', {
3697 'custnum' => $self->custnum,
3698 'status' => { op=>'!=', value=>'done' },
3703 =item cust_pay_pending_attempt
3705 Returns all payment attempts / declined payments for this customer, as pending
3706 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3707 a corresponding payment (see L<FS::cust_pay>).
3711 sub cust_pay_pending_attempt {
3713 return $self->num_cust_pay_pending_attempt unless wantarray;
3714 sort { $a->_date <=> $b->_date }
3715 qsearch( 'cust_pay_pending', {
3716 'custnum' => $self->custnum,
3723 =item num_cust_pay_pending
3725 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3726 customer (without status "done"). Also called automatically when the
3727 cust_pay_pending method is used in a scalar context.
3731 sub num_cust_pay_pending {
3734 " SELECT COUNT(*) FROM cust_pay_pending ".
3735 " WHERE custnum = ? AND status != 'done' ",
3740 =item num_cust_pay_pending_attempt
3742 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3743 customer, with status "done" but without a corresp. Also called automatically when the
3744 cust_pay_pending method is used in a scalar context.
3748 sub num_cust_pay_pending_attempt {
3751 " SELECT COUNT(*) FROM cust_pay_pending ".
3752 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3759 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3765 map { $_ } #return $self->num_cust_refund unless wantarray;
3766 sort { $a->_date <=> $b->_date }
3767 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3770 =item display_custnum
3772 Returns the displayed customer number for this customer: agent_custid if
3773 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3777 sub display_custnum {
3780 return $self->agent_custid
3781 if $default_agent_custid && $self->agent_custid;
3783 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3787 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
3788 } elsif ( $custnum_display_length ) {
3789 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
3791 return $self->custnum;
3797 Returns a name string for this customer, either "Company (Last, First)" or
3804 my $name = $self->contact;
3805 $name = $self->company. " ($name)" if $self->company;
3809 =item service_contact
3811 Returns the L<FS::contact> object for this customer that has the 'Service'
3812 contact class, or undef if there is no such contact. Deprecated; don't use
3817 sub service_contact {
3819 if ( !exists($self->{service_contact}) ) {
3820 my $classnum = $self->scalar_sql(
3821 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3822 ) || 0; #if it's zero, qsearchs will return nothing
3823 my $cust_contact = qsearchs('cust_contact', {
3824 'classnum' => $classnum,
3825 'custnum' => $self->custnum,
3827 $self->{service_contact} = $cust_contact->contact if $cust_contact;
3829 $self->{service_contact};
3834 Returns a name string for this (service/shipping) contact, either
3835 "Company (Last, First)" or "Last, First".
3842 my $name = $self->ship_contact;
3843 $name = $self->company. " ($name)" if $self->company;
3849 Returns a name string for this customer, either "Company" or "First Last".
3855 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3858 =item ship_name_short
3860 Returns a name string for this (service/shipping) contact, either "Company"
3865 sub ship_name_short {
3867 $self->service_contact
3868 ? $self->ship_contact_firstlast
3874 Returns this customer's full (billing) contact name only, "Last, First"
3880 $self->get('last'). ', '. $self->first;
3885 Returns this customer's full (shipping) contact name only, "Last, First"
3891 my $contact = $self->service_contact || $self;
3892 $contact->get('last') . ', ' . $contact->get('first');
3895 =item contact_firstlast
3897 Returns this customers full (billing) contact name only, "First Last".
3901 sub contact_firstlast {
3903 $self->first. ' '. $self->get('last');
3906 =item ship_contact_firstlast
3908 Returns this customer's full (shipping) contact name only, "First Last".
3912 sub ship_contact_firstlast {
3914 my $contact = $self->service_contact || $self;
3915 $contact->get('first') . ' '. $contact->get('last');
3918 sub bill_country_full {
3920 $self->bill_location->country_full;
3923 sub ship_country_full {
3925 $self->ship_location->country_full;
3928 =item county_state_county [ PREFIX ]
3930 Returns a string consisting of just the county, state and country.
3934 sub county_state_country {
3937 if ( @_ && $_[0] && $self->has_ship_address ) {
3938 $locationnum = $self->ship_locationnum;
3940 $locationnum = $self->bill_locationnum;
3942 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
3943 $cust_location->county_state_country;
3946 =item geocode DATA_VENDOR
3948 Returns a value for the customer location as encoded by DATA_VENDOR.
3949 Currently this only makes sense for "CCH" as DATA_VENDOR.
3957 Returns a status string for this customer, currently:
3963 No packages have ever been ordered. Displayed as "No packages".
3967 Recurring packages all are new (not yet billed).
3971 One or more recurring packages is active.
3975 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
3979 All non-cancelled recurring packages are suspended.
3983 All recurring packages are cancelled.
3987 Behavior of inactive vs. cancelled edge cases can be adjusted with the
3988 cust_main-status_module configuration option.
3992 sub status { shift->cust_status(@_); }
3996 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
3997 for my $status ( FS::cust_main->statuses() ) {
3998 my $method = $status.'_sql';
3999 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4000 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4001 $sth->execute( ($self->custnum) x $numnum )
4002 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4003 if ( $sth->fetchrow_arrayref->[0] ) {
4004 $self->hashref->{cust_status} = $status;
4010 =item is_status_delay_cancel
4012 Returns true if customer status is 'suspended'
4013 and all suspended cust_pkg return true for
4014 cust_pkg->is_status_delay_cancel.
4016 This is not a real status, this only meant for hacking display
4017 values, because otherwise treating the customer as suspended is
4018 really the whole point of the delay_cancel option.
4022 sub is_status_delay_cancel {
4024 return 0 unless $self->status eq 'suspended';
4025 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4026 return 0 unless $cust_pkg->is_status_delay_cancel;
4031 =item ucfirst_cust_status
4033 =item ucfirst_status
4035 Deprecated, use the cust_status_label method instead.
4037 Returns the status with the first character capitalized.
4041 sub ucfirst_status {
4042 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4043 local($ucfirst_nowarn) = 1;
4044 shift->ucfirst_cust_status(@_);
4047 sub ucfirst_cust_status {
4048 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4050 ucfirst($self->cust_status);
4053 =item cust_status_label
4057 Returns the display label for this status.
4061 sub status_label { shift->cust_status_label(@_); }
4063 sub cust_status_label {
4065 __PACKAGE__->statuslabels->{$self->cust_status};
4070 Returns a hex triplet color string for this customer's status.
4074 sub statuscolor { shift->cust_statuscolor(@_); }
4076 sub cust_statuscolor {
4078 __PACKAGE__->statuscolors->{$self->cust_status};
4081 =item tickets [ STATUS ]
4083 Returns an array of hashes representing the customer's RT tickets.
4085 An optional status (or arrayref or hashref of statuses) may be specified.
4091 my $status = ( @_ && $_[0] ) ? shift : '';
4093 my $num = $conf->config('cust_main-max_tickets') || 10;
4096 if ( $conf->config('ticket_system') ) {
4097 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4099 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4108 foreach my $priority (
4109 $conf->config('ticket_system-custom_priority_field-values'), ''
4111 last if scalar(@tickets) >= $num;
4113 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4114 $num - scalar(@tickets),
4125 =item appointments [ STATUS ]
4127 Returns an array of hashes representing the customer's RT tickets which
4134 my $status = ( @_ && $_[0] ) ? shift : '';
4136 return () unless $conf->config('ticket_system');
4138 my $queueid = $conf->config('ticket_system-appointment-queueid');
4140 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4149 # Return services representing svc_accts in customer support packages
4150 sub support_services {
4152 my %packages = map { $_ => 1 } $conf->config('support_packages');
4154 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4155 grep { $_->part_svc->svcdb eq 'svc_acct' }
4156 map { $_->cust_svc }
4157 grep { exists $packages{ $_->pkgpart } }
4158 $self->ncancelled_pkgs;
4162 # Return a list of latitude/longitude for one of the services (if any)
4163 sub service_coordinates {
4167 grep { $_->latitude && $_->longitude }
4169 map { $_->cust_svc }
4170 $self->ncancelled_pkgs;
4172 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4177 Returns a masked version of the named field
4182 my ($self,$field) = @_;
4186 'x'x(length($self->getfield($field))-4).
4187 substr($self->getfield($field), (length($self->getfield($field))-4));
4191 =item payment_history
4193 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4194 cust_credit and cust_refund objects. Each hashref has the following fields:
4196 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4198 I<date> - value of _date field, unix timestamp
4200 I<date_pretty> - user-friendly date
4202 I<description> - user-friendly description of item
4204 I<amount> - impact of item on user's balance
4205 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4206 Not to be confused with the native 'amount' field in cust_credit, see below.
4208 I<amount_pretty> - includes money char
4210 I<balance> - customer balance, chronologically as of this item
4212 I<balance_pretty> - includes money char
4214 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4216 I<paid> - amount paid for cust_pay records, undef for other types
4218 I<credit> - amount credited for cust_credit records, undef for other types.
4219 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4221 I<refund> - amount refunded for cust_refund records, undef for other types
4223 The four table-specific keys always have positive values, whether they reflect charges or payments.
4225 The following options may be passed to this method:
4227 I<line_items> - if true, returns charges ('Line item') rather than invoices
4229 I<start_date> - unix timestamp, only include records on or after.
4230 If specified, an item of type 'Previous' will also be included.
4231 It does not have table-specific fields.
4233 I<end_date> - unix timestamp, only include records before
4235 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4237 I<conf> - optional already-loaded FS::Conf object.
4241 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4242 # and also for sending customer statements, which should both be kept customer-friendly.
4243 # If you add anything that shouldn't be passed on through the API or exposed
4244 # to customers, add a new option to include it, don't include it by default
4245 sub payment_history {
4247 my $opt = ref($_[0]) ? $_[0] : { @_ };
4249 my $conf = $$opt{'conf'} || new FS::Conf;
4250 my $money_char = $conf->config("money_char") || '$',
4252 #first load entire history,
4253 #need previous to calculate previous balance
4254 #loading after end_date shouldn't hurt too much?
4256 if ( $$opt{'line_items'} ) {
4258 foreach my $cust_bill ( $self->cust_bill ) {
4261 'type' => 'Line item',
4262 'description' => $_->desc( $self->locale ).
4263 ( $_->sdate && $_->edate
4264 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4265 ' To '. time2str('%d-%b-%Y', $_->edate)
4268 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4269 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4270 'date' => $cust_bill->_date,
4271 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4273 foreach $cust_bill->cust_bill_pkg;
4280 'type' => 'Invoice',
4281 'description' => 'Invoice #'. $_->display_invnum,
4282 'amount' => sprintf('%.2f', $_->charged ),
4283 'charged' => sprintf('%.2f', $_->charged ),
4284 'date' => $_->_date,
4285 'date_pretty' => $self->time2str_local('short', $_->_date ),
4287 foreach $self->cust_bill;
4292 'type' => 'Payment',
4293 'description' => 'Payment', #XXX type
4294 'amount' => sprintf('%.2f', 0 - $_->paid ),
4295 'paid' => sprintf('%.2f', $_->paid ),
4296 'date' => $_->_date,
4297 'date_pretty' => $self->time2str_local('short', $_->_date ),
4299 foreach $self->cust_pay;
4303 'description' => 'Credit', #more info?
4304 'amount' => sprintf('%.2f', 0 -$_->amount ),
4305 'credit' => sprintf('%.2f', $_->amount ),
4306 'date' => $_->_date,
4307 'date_pretty' => $self->time2str_local('short', $_->_date ),
4309 foreach $self->cust_credit;
4313 'description' => 'Refund', #more info? type, like payment?
4314 'amount' => $_->refund,
4315 'refund' => $_->refund,
4316 'date' => $_->_date,
4317 'date_pretty' => $self->time2str_local('short', $_->_date ),
4319 foreach $self->cust_refund;
4321 #put it all in chronological order
4322 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4324 #calculate balance, filter items outside date range
4328 foreach my $item (@history) {
4329 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4330 $balance += $$item{'amount'};
4331 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4332 $previous += $$item{'amount'};
4335 $$item{'balance'} = sprintf("%.2f",$balance);
4336 foreach my $key ( qw(amount balance) ) {
4337 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4342 # start with previous balance, if there was one
4345 'type' => 'Previous',
4346 'description' => 'Previous balance',
4347 'amount' => sprintf("%.2f",$previous),
4348 'balance' => sprintf("%.2f",$previous),
4349 'date' => $$opt{'start_date'},
4350 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4352 #false laziness with above
4353 foreach my $key ( qw(amount balance) ) {
4354 $$item{$key.'_pretty'} = $$item{$key};
4355 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4357 unshift(@out,$item);
4360 @out = reverse @history if $$opt{'reverse_sort'};
4365 =item save_cust_payby
4367 Saves a new cust_payby for this customer, replacing an existing entry only
4368 in select circumstances. Does not validate input.
4370 If auto is specified, marks this as the customer's primary method, or the
4371 specified weight. Existing payment methods have their weight incremented as
4374 If bill_location is specified with auto, also sets location in cust_main.
4376 Will not insert complete duplicates of existing records, or records in which the
4377 only difference from an existing record is to turn off automatic payment (will
4378 return without error.) Will replace existing records in which the only difference
4379 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4380 Fields marked as preserved are optional, and existing values will not be overwritten with
4381 blanks when replacing.
4383 Accepts the following named parameters:
4393 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4397 optional, set higher than 1 for secondary, etc.
4405 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4413 optional, will be preserved when replacing
4421 CARD only, required, FS::cust_location object
4423 =item paystart_month
4425 CARD only, optional, will be preserved when replacing
4429 CARD only, optional, will be preserved when replacing
4433 CARD only, optional, will be preserved when replacing
4437 CARD only, only used if conf cvv-save is set appropriately
4447 =item saved_cust_payby
4449 scalar reference, for returning saved object
4455 #The code for this option is in place, but it's not currently used
4459 # existing cust_payby object to be replaced (must match custnum)
4461 # stateid/stateid_state/ss are not currently supported in cust_payby,
4462 # might not even work properly in 4.x, but will need to work here if ever added
4464 sub save_cust_payby {
4468 my $old = $opt{'replace'};
4469 my $new = new FS::cust_payby { $old ? $old->hash : () };
4470 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4471 $new->set( 'custnum' => $self->custnum );
4473 my $payby = $opt{'payment_payby'};
4474 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4476 # don't allow turning off auto when replacing
4477 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4479 my @check_existing; # payby relevant to this payment_payby
4481 # set payby based on auto
4482 if ( $payby eq 'CARD' ) {
4483 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4484 @check_existing = qw( CARD DCRD );
4485 } elsif ( $payby eq 'CHEK' ) {
4486 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4487 @check_existing = qw( CHEK DCHK );
4490 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4493 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4494 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4495 $new->set( 'payname' => $opt{'payname'} );
4496 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4498 my $conf = new FS::Conf;
4500 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4501 if ( $payby eq 'CARD' &&
4502 ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4503 || $conf->exists('business-onlinepayment-verification')
4506 $new->set( 'paycvv' => $opt{'paycvv'} );
4508 $new->set( 'paycvv' => '');
4511 local $SIG{HUP} = 'IGNORE';
4512 local $SIG{INT} = 'IGNORE';
4513 local $SIG{QUIT} = 'IGNORE';
4514 local $SIG{TERM} = 'IGNORE';
4515 local $SIG{TSTP} = 'IGNORE';
4516 local $SIG{PIPE} = 'IGNORE';
4518 my $oldAutoCommit = $FS::UID::AutoCommit;
4519 local $FS::UID::AutoCommit = 0;
4522 # set fields specific to payment_payby
4523 if ( $payby eq 'CARD' ) {
4524 if ($opt{'bill_location'}) {
4525 $opt{'bill_location'}->set('custnum' => $self->custnum);
4526 my $error = $opt{'bill_location'}->find_or_insert;
4528 $dbh->rollback if $oldAutoCommit;
4531 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4533 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4534 $new->set( $field => $opt{$field} );
4537 foreach my $field ( qw(paytype paystate) ) {
4538 $new->set( $field => $opt{$field} );
4542 # other cust_payby to compare this to
4543 my @existing = $self->cust_payby(@check_existing);
4545 # fields that can overwrite blanks with values, but not values with blanks
4546 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4548 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4550 # generally, we don't want to overwrite existing cust_payby with this,
4551 # but we can replace if we're only marking it auto or adding a preserved field
4552 # and we can avoid saving a total duplicate or merely turning off auto
4554 foreach my $cust_payby (@existing) {
4555 # check fields that absolutely should not change
4556 foreach my $field ($new->fields) {
4557 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4558 next if grep(/^$field$/, @preserve );
4559 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4561 # now check fields that can replace if one value is blank
4563 foreach my $field (@preserve) {
4565 ( $new->get($field) and !$cust_payby->get($field) ) or
4566 ( $cust_payby->get($field) and !$new->get($field) )
4568 # prevention of overwriting values with blanks happens farther below
4570 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4574 unless ( $replace ) {
4575 # nearly identical, now check weight
4576 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4577 # ignore identical cust_payby, and ignore attempts to turn off auto
4578 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4579 $skip_cust_payby = 1;
4582 # otherwise, only change is to mark this as primary
4584 # if we got this far, we're definitely replacing
4591 $new->set( 'custpaybynum' => $old->custpaybynum );
4592 # don't turn off automatic payment (but allow it to be turned on)
4593 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4595 $new->set( 'payby' => $old->payby );
4596 $new->set( 'weight' => 1 );
4598 # make sure we're not overwriting values with blanks
4599 foreach my $field (@preserve) {
4600 if ( $old->get($field) and !$new->get($field) ) {
4601 $new->set( $field => $old->get($field) );
4606 # only overwrite cust_main bill_location if auto
4607 if ($opt{'auto'} && $opt{'bill_location'}) {
4608 $self->set('bill_location' => $opt{'bill_location'});
4609 my $error = $self->replace;
4611 $dbh->rollback if $oldAutoCommit;
4616 # done with everything except reweighting and saving cust_payby
4617 # still need to commit changes to cust_main and cust_location
4618 if ($skip_cust_payby) {
4619 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4623 # re-weight existing primary cust_pay for this payby
4625 foreach my $cust_payby (@existing) {
4626 # relies on cust_payby return order
4627 last unless $cust_payby->payby !~ /^D/;
4628 last if $cust_payby->weight > 1;
4629 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4630 next if $cust_payby->weight < ($opt{'weight'} || 1);
4631 $cust_payby->weight( $cust_payby->weight + 1 );
4632 my $error = $cust_payby->replace;
4634 $dbh->rollback if $oldAutoCommit;
4635 return "Error reweighting cust_payby: $error";
4640 # finally, save cust_payby
4641 my $error = $old ? $new->replace($old) : $new->insert;
4643 $dbh->rollback if $oldAutoCommit;
4647 ${$opt{'saved_cust_payby'}} = $new
4648 if $opt{'saved_cust_payby'};
4650 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4655 =item remove_cvv_from_cust_payby PAYINFO
4657 Removes paycvv from associated cust_payby with matching PAYINFO.
4661 sub remove_cvv_from_cust_payby {
4662 my ($self,$payinfo) = @_;
4664 my $oldAutoCommit = $FS::UID::AutoCommit;
4665 local $FS::UID::AutoCommit = 0;
4668 foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
4669 next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
4670 $cust_payby->paycvv('');
4671 my $error = $cust_payby->replace;
4673 $dbh->rollback if $oldAutoCommit;
4678 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4684 =head1 CLASS METHODS
4690 Class method that returns the list of possible status strings for customers
4691 (see L<the status method|/status>). For example:
4693 @statuses = FS::cust_main->statuses();
4699 keys %{ $self->statuscolors };
4702 =item cust_status_sql
4704 Returns an SQL fragment to determine the status of a cust_main record, as a
4709 sub cust_status_sql {
4711 for my $status ( FS::cust_main->statuses() ) {
4712 my $method = $status.'_sql';
4713 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4722 Returns an SQL expression identifying prospective cust_main records (customers
4723 with no packages ever ordered)
4727 use vars qw($select_count_pkgs);
4728 $select_count_pkgs =
4729 "SELECT COUNT(*) FROM cust_pkg
4730 WHERE cust_pkg.custnum = cust_main.custnum";
4732 sub select_count_pkgs_sql {
4737 " 0 = ( $select_count_pkgs ) ";
4742 Returns an SQL expression identifying ordered cust_main records (customers with
4743 no active packages, but recurring packages not yet setup or one time charges
4749 FS::cust_main->none_active_sql.
4750 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4755 Returns an SQL expression identifying active cust_main records (customers with
4756 active recurring packages).
4761 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4764 =item none_active_sql
4766 Returns an SQL expression identifying cust_main records with no active
4767 recurring packages. This includes customers of status prospect, ordered,
4768 inactive, and suspended.
4772 sub none_active_sql {
4773 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4778 Returns an SQL expression identifying inactive cust_main records (customers with
4779 no active recurring packages, but otherwise unsuspended/uncancelled).
4784 FS::cust_main->none_active_sql.
4785 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4791 Returns an SQL expression identifying suspended cust_main records.
4796 sub suspended_sql { susp_sql(@_); }
4798 FS::cust_main->none_active_sql.
4799 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4805 Returns an SQL expression identifying cancelled cust_main records.
4809 sub cancel_sql { shift->cancelled_sql(@_); }
4812 =item uncancelled_sql
4814 Returns an SQL expression identifying un-cancelled cust_main records.
4818 sub uncancelled_sql { uncancel_sql(@_); }
4821 "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
4826 Returns an SQL fragment to retreive the balance.
4831 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4832 WHERE cust_bill.custnum = cust_main.custnum )
4833 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4834 WHERE cust_pay.custnum = cust_main.custnum )
4835 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4836 WHERE cust_credit.custnum = cust_main.custnum )
4837 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4838 WHERE cust_refund.custnum = cust_main.custnum )
4841 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4843 Returns an SQL fragment to retreive the balance for this customer, optionally
4844 considering invoices with date earlier than START_TIME, and not
4845 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4846 total_unapplied_payments).
4848 Times are specified as SQL fragments or numeric
4849 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4850 L<Date::Parse> for conversion functions. The empty string can be passed
4851 to disable that time constraint completely.
4853 Available options are:
4857 =item unapplied_date
4859 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)
4864 set to true to remove all customer comparison clauses, for totals
4869 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4874 JOIN clause (typically used with the total option)
4878 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4879 time will be ignored. Note that START_TIME and END_TIME only limit the date
4880 range for invoices and I<unapplied> payments, credits, and refunds.
4886 sub balance_date_sql {
4887 my( $class, $start, $end, %opt ) = @_;
4889 my $cutoff = $opt{'cutoff'};
4891 my $owed = FS::cust_bill->owed_sql($cutoff);
4892 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4893 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4894 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4896 my $j = $opt{'join'} || '';
4898 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4899 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4900 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4901 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4903 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4904 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4905 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4906 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4911 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4913 Returns an SQL fragment to retreive the total unapplied payments for this
4914 customer, only considering payments with date earlier than START_TIME, and
4915 optionally not later than END_TIME.
4917 Times are specified as SQL fragments or numeric
4918 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4919 L<Date::Parse> for conversion functions. The empty string can be passed
4920 to disable that time constraint completely.
4922 Available options are:
4926 sub unapplied_payments_date_sql {
4927 my( $class, $start, $end, %opt ) = @_;
4929 my $cutoff = $opt{'cutoff'};
4931 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4933 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4934 'unapplied_date'=>1 );
4936 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4939 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4941 Helper method for balance_date_sql; name (and usage) subject to change
4942 (suggestions welcome).
4944 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4945 cust_refund, cust_credit or cust_pay).
4947 If TABLE is "cust_bill" or the unapplied_date option is true, only
4948 considers records with date earlier than START_TIME, and optionally not
4949 later than END_TIME .
4953 sub _money_table_where {
4954 my( $class, $table, $start, $end, %opt ) = @_;
4957 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4958 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4959 push @where, "$table._date <= $start" if defined($start) && length($start);
4960 push @where, "$table._date > $end" if defined($end) && length($end);
4962 push @where, @{$opt{'where'}} if $opt{'where'};
4963 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4969 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4970 use FS::cust_main::Search;
4973 FS::cust_main::Search->search(@_);
4982 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4984 Generates a templated notification to the customer (see L<Text::Template>).
4986 OPTIONS is a hash and may include
4988 I<extra_fields> - a hashref of name/value pairs which will be substituted
4989 into the template. These values may override values mentioned below
4990 and those from the customer record.
4992 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
4994 The following variables are available in the template instead of or in addition
4995 to the fields of the customer record.
4997 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5001 # a lot like cust_bill::print_latex
5002 sub generate_letter {
5003 my ($self, $template, %options) = @_;
5005 warn "Template $template does not exist" && return
5006 unless $conf->exists($template) || $options{'template_text'};
5008 my $template_source = $options{'template_text'}
5009 ? [ $options{'template_text'} ]
5010 : [ map "$_\n", $conf->config($template) ];
5012 my $letter_template = new Text::Template
5014 SOURCE => $template_source,
5015 DELIMITERS => [ '[@--', '--@]' ],
5017 or die "can't create new Text::Template object: Text::Template::ERROR";
5019 $letter_template->compile()
5020 or die "can't compile template: Text::Template::ERROR";
5022 my %letter_data = map { $_ => $self->$_ } $self->fields;
5024 for (keys %{$options{extra_fields}}){
5025 $letter_data{$_} = $options{extra_fields}->{$_};
5028 unless(exists($letter_data{returnaddress})){
5029 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5030 $self->agent_template)
5032 if ( length($retadd) ) {
5033 $letter_data{returnaddress} = $retadd;
5034 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5035 $letter_data{returnaddress} =
5036 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5040 ( $conf->config('company_name', $self->agentnum),
5041 $conf->config('company_address', $self->agentnum),
5045 $letter_data{returnaddress} = '~';
5049 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5051 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5053 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5055 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5059 ) or die "can't open temp file: $!\n";
5060 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5061 or die "can't write temp file: $!\n";
5063 $letter_data{'logo_file'} = $lh->filename;
5065 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5069 ) or die "can't open temp file: $!\n";
5071 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5073 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5074 return ($1, $letter_data{'logo_file'});
5078 =item print_ps TEMPLATE
5080 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5086 my($file, $lfile) = $self->generate_letter(@_);
5087 my $ps = FS::Misc::generate_ps($file);
5088 unlink($file.'.tex');
5094 =item print TEMPLATE
5096 Prints the filled in template.
5098 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5102 sub queueable_print {
5105 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5106 or die "invalid customer number: " . $opt{custnum};
5108 #do not backport this change to 3.x
5109 # my $error = $self->print( { 'template' => $opt{template} } );
5110 my $error = $self->print( $opt{'template'} );
5111 die $error if $error;
5115 my ($self, $template) = (shift, shift);
5117 [ $self->print_ps($template) ],
5118 'agentnum' => $self->agentnum,
5122 #these three subs should just go away once agent stuff is all config overrides
5124 sub agent_template {
5126 $self->_agent_plandata('agent_templatename');
5129 sub agent_invoice_from {
5131 $self->_agent_plandata('agent_invoice_from');
5134 sub _agent_plandata {
5135 my( $self, $option ) = @_;
5137 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5138 #agent-specific Conf
5140 use FS::part_event::Condition;
5142 my $agentnum = $self->agentnum;
5144 my $regexp = regexp_sql();
5146 my $part_event_option =
5148 'select' => 'part_event_option.*',
5149 'table' => 'part_event_option',
5151 LEFT JOIN part_event USING ( eventpart )
5152 LEFT JOIN part_event_option AS peo_agentnum
5153 ON ( part_event.eventpart = peo_agentnum.eventpart
5154 AND peo_agentnum.optionname = 'agentnum'
5155 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5157 LEFT JOIN part_event_condition
5158 ON ( part_event.eventpart = part_event_condition.eventpart
5159 AND part_event_condition.conditionname = 'cust_bill_age'
5161 LEFT JOIN part_event_condition_option
5162 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5163 AND part_event_condition_option.optionname = 'age'
5166 #'hashref' => { 'optionname' => $option },
5167 #'hashref' => { 'part_event_option.optionname' => $option },
5169 " WHERE part_event_option.optionname = ". dbh->quote($option).
5170 " AND action = 'cust_bill_send_agent' ".
5171 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5172 " AND peo_agentnum.optionname = 'agentnum' ".
5173 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5175 CASE WHEN part_event_condition_option.optionname IS NULL
5177 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5179 , part_event.weight".
5183 unless ( $part_event_option ) {
5184 return $self->agent->invoice_template || ''
5185 if $option eq 'agent_templatename';
5189 $part_event_option->optionvalue;
5193 sub process_o2m_qsearch {
5196 return qsearch($table, @_) unless $table eq 'contact';
5198 my $hashref = shift;
5199 my %hash = %$hashref;
5200 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5201 or die 'guru meditation #4343';
5203 qsearch({ 'table' => 'contact',
5204 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5205 'hashref' => \%hash,
5206 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5207 " cust_contact.custnum = $custnum "
5211 sub process_o2m_qsearchs {
5214 return qsearchs($table, @_) unless $table eq 'contact';
5216 my $hashref = shift;
5217 my %hash = %$hashref;
5218 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5219 or die 'guru meditation #2121';
5221 qsearchs({ 'table' => 'contact',
5222 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5223 'hashref' => \%hash,
5224 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5225 " cust_contact.custnum = $custnum "
5229 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5231 Subroutine (not a method), designed to be called from the queue.
5233 Takes a list of options and values.
5235 Pulls up the customer record via the custnum option and calls bill_and_collect.
5240 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5242 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5243 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5245 #without this errors don't get rolled back
5246 $args{'fatal'} = 1; # runs from job queue, will be caught
5248 $cust_main->bill_and_collect( %args );
5251 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5253 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5254 C<collect> part. This is used in batch tax calculation, where invoice
5255 generation and collection events have to be completely separated.
5259 sub queued_collect {
5261 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5263 $cust_main->collect(%args);
5266 sub process_bill_and_collect {
5269 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5270 or die "custnum '$param->{custnum}' not found!\n";
5271 $param->{'job'} = $job;
5272 $param->{'fatal'} = 1; # runs from job queue, will be caught
5273 $param->{'retry'} = 1;
5275 $cust_main->bill_and_collect( %$param );
5278 #starting to take quite a while for big dbs
5279 # (JRNL: journaled so it only happens once per database)
5280 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5281 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5282 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5283 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5284 # JRNL leading/trailing spaces in first, last, company
5285 # JRNL migrate to cust_payby
5286 # - otaker upgrade? journal and call it good? (double check to make sure
5287 # we're not still setting otaker here)
5289 #only going to get worse with new location stuff...
5291 sub _upgrade_data { #class method
5292 my ($class, %opts) = @_;
5294 my @statements = ();
5296 #this seems to be the only expensive one.. why does it take so long?
5297 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5299 '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';
5300 FS::upgrade_journal->set_done('cust_main__signupdate');
5304 foreach my $sql ( @statements ) {
5305 my $sth = dbh->prepare($sql) or die dbh->errstr;
5306 $sth->execute or die $sth->errstr;
5307 #warn ( (time - $t). " seconds\n" );
5311 local($ignore_expired_card) = 1;
5312 local($ignore_banned_card) = 1;
5313 local($skip_fuzzyfiles) = 1;
5314 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5316 FS::cust_main::Location->_upgrade_data(%opts);
5318 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5320 foreach my $cust_main ( qsearch({
5321 'table' => 'cust_main',
5323 'extra_sql' => 'WHERE '.
5325 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5326 qw( first last company )
5329 my $error = $cust_main->replace;
5330 die $error if $error;
5333 FS::upgrade_journal->set_done('cust_main__trimspaces');
5337 $class->_upgrade_otaker(%opts);
5347 The delete method should possibly take an FS::cust_main object reference
5348 instead of a scalar customer number.
5350 Bill and collect options should probably be passed as references instead of a
5353 There should probably be a configuration file with a list of allowed credit
5356 No multiple currency support (probably a larger project than just this module).
5358 Birthdates rely on negative epoch values.
5360 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5364 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5365 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5366 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.