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::payinfo_Mixin FS::cust_main_Mixin
15 FS::geocode_Mixin FS::Quotable_Mixin FS::Sales_Mixin
24 use Scalar::Util qw( blessed );
25 use List::Util qw(min);
27 use File::Temp; #qw( tempfile );
29 use Time::Local qw(timelocal);
33 use Business::CreditCard 0.28;
34 use FS::UID qw( dbh driver_name );
35 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
37 use FS::Misc qw( generate_ps do_print money_pretty card_types );
38 use FS::Msgcat qw(gettext);
45 use FS::cust_bill_void;
46 use FS::legacy_cust_bill;
48 use FS::cust_pay_pending;
49 use FS::cust_pay_void;
50 use FS::cust_pay_batch;
53 use FS::part_referral;
54 use FS::cust_main_county;
55 use FS::cust_location;
58 use FS::cust_main_exemption;
59 use FS::cust_tax_adjustment;
60 use FS::cust_tax_location;
61 use FS::agent_currency;
62 use FS::cust_main_invoice;
64 use FS::prepay_credit;
70 use FS::payment_gateway;
71 use FS::agent_payment_gateway;
73 use FS::cust_main_note;
74 use FS::cust_attachment;
77 use FS::upgrade_journal;
83 # 1 is mostly method/subroutine entry and options
84 # 2 traces progress of some operations
85 # 3 is even more information including possibly sensitive data
87 our $me = '[FS::cust_main]';
90 our $ignore_expired_card = 0;
91 our $ignore_banned_card = 0;
92 our $ignore_invalid_card = 0;
94 our $skip_fuzzyfiles = 0;
96 our $ucfirst_nowarn = 0;
98 #this info is in cust_payby as of 4.x
99 #this and the fields themselves can be removed in 5.x
100 our @encrypted_fields = ('payinfo', 'paycvv');
101 sub nohistory_fields { ('payinfo', 'paycvv'); }
104 our $default_agent_custid;
105 our $custnum_display_length;
106 #ask FS::UID to run this stuff for us later
107 #$FS::UID::callback{'FS::cust_main'} = sub {
108 install_callback FS::UID sub {
109 $conf = new FS::Conf;
110 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
111 $default_agent_custid = $conf->exists('cust_main-default_agent_custid');
112 $custnum_display_length = $conf->config('cust_main-custnum-display_length');
117 my ( $hashref, $cache ) = @_;
118 if ( exists $hashref->{'pkgnum'} ) {
119 #@{ $self->{'_pkgnum'} } = ();
120 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
121 $self->{'_pkgnum'} = $subcache;
122 #push @{ $self->{'_pkgnum'} },
123 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
129 FS::cust_main - Object methods for cust_main records
135 $record = new FS::cust_main \%hash;
136 $record = new FS::cust_main { 'column' => 'value' };
138 $error = $record->insert;
140 $error = $new_record->replace($old_record);
142 $error = $record->delete;
144 $error = $record->check;
146 @cust_pkg = $record->all_pkgs;
148 @cust_pkg = $record->ncancelled_pkgs;
150 @cust_pkg = $record->suspended_pkgs;
152 $error = $record->bill;
153 $error = $record->bill %options;
154 $error = $record->bill 'time' => $time;
156 $error = $record->collect;
157 $error = $record->collect %options;
158 $error = $record->collect 'invoice_time' => $time,
163 An FS::cust_main object represents a customer. FS::cust_main inherits from
164 FS::Record. The following fields are currently supported:
170 Primary key (assigned automatically for new customers)
174 Agent (see L<FS::agent>)
178 Advertising source (see L<FS::part_referral>)
190 Cocial security number (optional)
214 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
218 Payment Information (See L<FS::payinfo_Mixin> for data format)
222 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
226 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
230 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
234 Start date month (maestro/solo cards only)
238 Start date year (maestro/solo cards only)
242 Issue number (maestro/solo cards only)
246 Name on card or billing name
250 IP address from which payment information was received
254 Tax exempt, empty or `Y'
258 Order taker (see L<FS::access_user>)
264 =item referral_custnum
266 Referring customer number
270 Enable individual CDR spooling, empty or `Y'
274 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
278 Discourage individual CDR printing, empty or `Y'
282 Allow self-service editing of ticket subjects, empty or 'Y'
284 =item calling_list_exempt
286 Do not call, empty or 'Y'
288 =item invoice_ship_address
290 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
300 Creates a new customer. To add the customer to the database, see L<"insert">.
302 Note that this stores the hash reference, not a distinct copy of the hash it
303 points to. You can ask the object for a copy with the I<hash> method.
307 sub table { 'cust_main'; }
309 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
311 Adds this customer to the database. If there is an error, returns the error,
312 otherwise returns false.
314 Usually the customer's location will not yet exist in the database, and
315 the C<bill_location> and C<ship_location> pseudo-fields must be set to
316 uninserted L<FS::cust_location> objects. These will be inserted and linked
317 (in both directions) to the new customer record. If they're references
318 to the same object, they will become the same location.
320 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
321 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
322 are inserted atomicly, or the transaction is rolled back. Passing an empty
323 hash reference is equivalent to not supplying this parameter. There should be
324 a better explanation of this, but until then, here's an example:
327 tie %hash, 'Tie::RefHash'; #this part is important
329 $cust_pkg => [ $svc_acct ],
332 $cust_main->insert( \%hash );
334 INVOICING_LIST_ARYREF: No longer supported.
336 Currently available options are: I<depend_jobnum>, I<noexport>,
337 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
339 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
340 on the supplied jobnum (they will not run until the specific job completes).
341 This can be used to defer provisioning until some action completes (such
342 as running the customer's credit card successfully).
344 The I<noexport> option is deprecated. If I<noexport> is set true, no
345 provisioning jobs (exports) are scheduled. (You can schedule them later with
346 the B<reexport> method.)
348 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
349 of tax names and exemption numbers. FS::cust_main_exemption records will be
350 created and inserted.
352 If I<prospectnum> is set, moves contacts and locations from that prospect.
354 If I<contact> is set to an arrayref of FS::contact objects, those will be
357 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
358 unset), inserts those new contacts with this new customer. Handles CGI
359 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
361 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
362 new stored payment records with this new customer. Handles CGI parameters
363 for an "m2" multiple entry field as passed by edit/cust_main.cgi
369 my $cust_pkgs = @_ ? shift : {};
371 if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
372 warn "cust_main::insert using deprecated invoicing list argument";
373 $invoicing_list = shift;
376 warn "$me insert called with options ".
377 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
380 local $SIG{HUP} = 'IGNORE';
381 local $SIG{INT} = 'IGNORE';
382 local $SIG{QUIT} = 'IGNORE';
383 local $SIG{TERM} = 'IGNORE';
384 local $SIG{TSTP} = 'IGNORE';
385 local $SIG{PIPE} = 'IGNORE';
387 my $oldAutoCommit = $FS::UID::AutoCommit;
388 local $FS::UID::AutoCommit = 0;
391 my $prepay_identifier = '';
392 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
394 if ( $self->payby eq 'PREPAY' ) {
396 $self->payby(''); #'BILL');
397 $prepay_identifier = $self->payinfo;
400 warn " looking up prepaid card $prepay_identifier\n"
403 my $error = $self->get_prepay( $prepay_identifier,
404 'amount_ref' => \$amount,
405 'seconds_ref' => \$seconds,
406 'upbytes_ref' => \$upbytes,
407 'downbytes_ref' => \$downbytes,
408 'totalbytes_ref' => \$totalbytes,
411 $dbh->rollback if $oldAutoCommit;
412 #return "error applying prepaid card (transaction rolled back): $error";
416 $payby = 'PREP' if $amount;
418 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
421 $self->payby(''); #'BILL');
422 $amount = $self->paid;
427 foreach my $l (qw(bill_location ship_location)) {
429 my $loc = delete $self->hashref->{$l} or next;
431 if ( !$loc->locationnum ) {
432 # warn the location that we're going to insert it with no custnum
433 $loc->set(custnum_pending => 1);
434 warn " inserting $l\n"
436 my $error = $loc->insert;
438 $dbh->rollback if $oldAutoCommit;
439 my $label = $l eq 'ship_location' ? 'service' : 'billing';
440 return "$error (in $label location)";
443 } elsif ( $loc->prospectnum ) {
445 $loc->prospectnum('');
446 $loc->set(custnum_pending => 1);
447 my $error = $loc->replace;
449 $dbh->rollback if $oldAutoCommit;
450 my $label = $l eq 'ship_location' ? 'service' : 'billing';
451 return "$error (moving $label location)";
454 } elsif ( ($loc->custnum || 0) > 0 ) {
455 # then it somehow belongs to another customer--shouldn't happen
456 $dbh->rollback if $oldAutoCommit;
457 return "$l belongs to customer ".$loc->custnum;
459 # else it already belongs to this customer
460 # (happens when ship_location is identical to bill_location)
462 $self->set($l.'num', $loc->locationnum);
464 if ( $self->get($l.'num') eq '' ) {
465 $dbh->rollback if $oldAutoCommit;
470 warn " inserting $self\n"
473 $self->signupdate(time) unless $self->signupdate;
475 $self->auto_agent_custid()
476 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
478 my $error = $self->check_payinfo_cardtype
479 || $self->SUPER::insert;
481 $dbh->rollback if $oldAutoCommit;
482 #return "inserting cust_main record (transaction rolled back): $error";
486 # now set cust_location.custnum
487 foreach my $l (qw(bill_location ship_location)) {
488 warn " setting $l.custnum\n"
490 my $loc = $self->$l or next;
491 unless ( $loc->custnum ) {
492 $loc->set(custnum => $self->custnum);
493 $error ||= $loc->replace;
497 $dbh->rollback if $oldAutoCommit;
498 return "error setting $l custnum: $error";
502 warn " setting customer tags\n"
505 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
506 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
507 'custnum' => $self->custnum };
508 my $error = $cust_tag->insert;
510 $dbh->rollback if $oldAutoCommit;
515 my $prospectnum = delete $options{'prospectnum'};
516 if ( $prospectnum ) {
518 warn " moving contacts and locations from prospect $prospectnum\n"
522 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
523 unless ( $prospect_main ) {
524 $dbh->rollback if $oldAutoCommit;
525 return "Unknown prospectnum $prospectnum";
527 $prospect_main->custnum($self->custnum);
528 $prospect_main->disabled('Y');
529 my $error = $prospect_main->replace;
531 $dbh->rollback if $oldAutoCommit;
535 foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
536 my $cust_contact = new FS::cust_contact {
537 'custnum' => $self->custnum,
538 'invoice_dest' => 'Y', # invoice_dest currently not set for prospect contacts
539 map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
541 my $error = $cust_contact->insert
542 || $prospect_contact->delete;
544 $dbh->rollback if $oldAutoCommit;
549 my @cust_location = $prospect_main->cust_location;
550 my @qual = $prospect_main->qual;
552 foreach my $r ( @cust_location, @qual ) {
554 $r->custnum($self->custnum);
555 my $error = $r->replace;
557 $dbh->rollback if $oldAutoCommit;
561 # since we set invoice_dest on all migrated prospect contacts (for now),
562 # don't process invoicing_list.
563 delete $options{'invoicing_list'};
564 $invoicing_list = undef;
567 warn " setting contacts\n"
570 $invoicing_list ||= $options{'invoicing_list'};
571 if ( $invoicing_list ) {
573 $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
576 foreach my $dest (@$invoicing_list ) {
577 if ($dest eq 'POST') {
578 $self->set('postal_invoice', 'Y');
581 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
582 if ( $contact_email ) {
583 my $cust_contact = FS::cust_contact->new({
584 contactnum => $contact_email->contactnum,
585 custnum => $self->custnum,
587 $cust_contact->set('invoice_dest', 'Y');
588 my $error = $cust_contact->insert;
590 $dbh->rollback if $oldAutoCommit;
591 return "$error (linking to email address $dest)";
595 # this email address is not yet linked to any contact
596 $email .= ',' if length($email);
604 my $contact = FS::contact->new({
605 'custnum' => $self->get('custnum'),
606 'last' => $self->get('last'),
607 'first' => $self->get('first'),
608 'emailaddress' => $email,
609 'invoice_dest' => 'Y', # yes, you can set this via the contact
611 my $error = $contact->insert;
613 $dbh->rollback if $oldAutoCommit;
621 if ( my $contact = delete $options{'contact'} ) {
623 foreach my $c ( @$contact ) {
624 $c->custnum($self->custnum);
625 my $error = $c->insert;
627 $dbh->rollback if $oldAutoCommit;
633 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
635 my $error = $self->process_o2m( 'table' => 'contact',
636 'fields' => FS::contact->cgi_contact_fields,
637 'params' => $contact_params,
640 $dbh->rollback if $oldAutoCommit;
645 warn " setting cust_payby\n"
648 if ( $options{cust_payby} ) {
650 foreach my $cust_payby ( @{ $options{cust_payby} } ) {
651 $cust_payby->custnum($self->custnum);
652 my $error = $cust_payby->insert;
654 $dbh->rollback if $oldAutoCommit;
659 } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
661 my $error = $self->process_o2m(
662 'table' => 'cust_payby',
663 'fields' => FS::cust_payby->cgi_cust_payby_fields,
664 'params' => $cust_payby_params,
665 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
668 $dbh->rollback if $oldAutoCommit;
674 warn " setting cust_main_exemption\n"
677 my $tax_exemption = delete $options{'tax_exemption'};
678 if ( $tax_exemption ) {
680 $tax_exemption = { map { $_ => '' } @$tax_exemption }
681 if ref($tax_exemption) eq 'ARRAY';
683 foreach my $taxname ( keys %$tax_exemption ) {
684 my $cust_main_exemption = new FS::cust_main_exemption {
685 'custnum' => $self->custnum,
686 'taxname' => $taxname,
687 'exempt_number' => $tax_exemption->{$taxname},
689 my $error = $cust_main_exemption->insert;
691 $dbh->rollback if $oldAutoCommit;
692 return "inserting cust_main_exemption (transaction rolled back): $error";
697 warn " ordering packages\n"
700 $error = $self->order_pkgs( $cust_pkgs,
702 'seconds_ref' => \$seconds,
703 'upbytes_ref' => \$upbytes,
704 'downbytes_ref' => \$downbytes,
705 'totalbytes_ref' => \$totalbytes,
708 $dbh->rollback if $oldAutoCommit;
713 $dbh->rollback if $oldAutoCommit;
714 return "No svc_acct record to apply pre-paid time";
716 if ( $upbytes || $downbytes || $totalbytes ) {
717 $dbh->rollback if $oldAutoCommit;
718 return "No svc_acct record to apply pre-paid data";
722 warn " inserting initial $payby payment of $amount\n"
724 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
726 $dbh->rollback if $oldAutoCommit;
727 return "inserting payment (transaction rolled back): $error";
731 unless ( $import || $skip_fuzzyfiles ) {
732 warn " queueing fuzzyfiles update\n"
734 $error = $self->queue_fuzzyfiles_update;
736 $dbh->rollback if $oldAutoCommit;
737 return "updating fuzzy search cache: $error";
741 # FS::geocode_Mixin::after_insert or something?
742 if ( $conf->config('tax_district_method') and !$import ) {
743 # if anything non-empty, try to look it up
744 my $queue = new FS::queue {
745 'job' => 'FS::geocode_Mixin::process_district_update',
746 'custnum' => $self->custnum,
748 my $error = $queue->insert( ref($self), $self->custnum );
750 $dbh->rollback if $oldAutoCommit;
751 return "queueing tax district update: $error";
756 warn " exporting\n" if $DEBUG > 1;
758 my $export_args = $options{'export_args'} || [];
761 map qsearch( 'part_export', {exportnum=>$_} ),
762 $conf->config('cust_main-exports'); #, $agentnum
764 foreach my $part_export ( @part_export ) {
765 my $error = $part_export->export_insert($self, @$export_args);
767 $dbh->rollback if $oldAutoCommit;
768 return "exporting to ". $part_export->exporttype.
769 " (transaction rolled back): $error";
773 #foreach my $depend_jobnum ( @$depend_jobnums ) {
774 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
776 # foreach my $jobnum ( @jobnums ) {
777 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
778 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
780 # my $error = $queue->depend_insert($depend_jobnum);
782 # $dbh->rollback if $oldAutoCommit;
783 # return "error queuing job dependancy: $error";
790 #if ( exists $options{'jobnums'} ) {
791 # push @{ $options{'jobnums'} }, @jobnums;
794 warn " insert complete; committing transaction\n"
797 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
802 use File::CounterFile;
803 sub auto_agent_custid {
806 my $format = $conf->config('cust_main-auto_agent_custid');
808 if ( $format eq '1YMMXXXXXXXX' ) {
810 my $counter = new File::CounterFile 'cust_main.agent_custid';
813 my $ym = 100000000000 + time2str('%y%m00000000', time);
814 if ( $ym > $counter->value ) {
815 $counter->{'value'} = $agent_custid = $ym;
816 $counter->{'updated'} = 1;
818 $agent_custid = $counter->inc;
824 die "Unknown cust_main-auto_agent_custid format: $format";
827 $self->agent_custid($agent_custid);
831 =item PACKAGE METHODS
833 Documentation on customer package methods has been moved to
834 L<FS::cust_main::Packages>.
836 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
838 Recharges this (existing) customer with the specified prepaid card (see
839 L<FS::prepay_credit>), specified either by I<identifier> or as an
840 FS::prepay_credit object. If there is an error, returns the error, otherwise
843 Optionally, five scalar references can be passed as well. They will have their
844 values filled in with the amount, number of seconds, and number of upload,
845 download, and total bytes applied by this prepaid card.
849 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
850 #the only place that uses these args
851 sub recharge_prepay {
852 my( $self, $prepay_credit, $amountref, $secondsref,
853 $upbytesref, $downbytesref, $totalbytesref ) = @_;
855 local $SIG{HUP} = 'IGNORE';
856 local $SIG{INT} = 'IGNORE';
857 local $SIG{QUIT} = 'IGNORE';
858 local $SIG{TERM} = 'IGNORE';
859 local $SIG{TSTP} = 'IGNORE';
860 local $SIG{PIPE} = 'IGNORE';
862 my $oldAutoCommit = $FS::UID::AutoCommit;
863 local $FS::UID::AutoCommit = 0;
866 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
868 my $error = $self->get_prepay( $prepay_credit,
869 'amount_ref' => \$amount,
870 'seconds_ref' => \$seconds,
871 'upbytes_ref' => \$upbytes,
872 'downbytes_ref' => \$downbytes,
873 'totalbytes_ref' => \$totalbytes,
875 || $self->increment_seconds($seconds)
876 || $self->increment_upbytes($upbytes)
877 || $self->increment_downbytes($downbytes)
878 || $self->increment_totalbytes($totalbytes)
879 || $self->insert_cust_pay_prepay( $amount,
881 ? $prepay_credit->identifier
886 $dbh->rollback if $oldAutoCommit;
890 if ( defined($amountref) ) { $$amountref = $amount; }
891 if ( defined($secondsref) ) { $$secondsref = $seconds; }
892 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
893 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
894 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
896 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
901 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
903 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
904 specified either by I<identifier> or as an FS::prepay_credit object.
906 Available options are: I<amount_ref>, I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>. The scalars (provided by references) will be
907 incremented by the values of the prepaid card.
909 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
910 check or set this customer's I<agentnum>.
912 If there is an error, returns the error, otherwise returns false.
918 my( $self, $prepay_credit, %opt ) = @_;
920 local $SIG{HUP} = 'IGNORE';
921 local $SIG{INT} = 'IGNORE';
922 local $SIG{QUIT} = 'IGNORE';
923 local $SIG{TERM} = 'IGNORE';
924 local $SIG{TSTP} = 'IGNORE';
925 local $SIG{PIPE} = 'IGNORE';
927 my $oldAutoCommit = $FS::UID::AutoCommit;
928 local $FS::UID::AutoCommit = 0;
931 unless ( ref($prepay_credit) ) {
933 my $identifier = $prepay_credit;
935 $prepay_credit = qsearchs(
937 { 'identifier' => $identifier },
942 unless ( $prepay_credit ) {
943 $dbh->rollback if $oldAutoCommit;
944 return "Invalid prepaid card: ". $identifier;
949 if ( $prepay_credit->agentnum ) {
950 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
951 $dbh->rollback if $oldAutoCommit;
952 return "prepaid card not valid for agent ". $self->agentnum;
954 $self->agentnum($prepay_credit->agentnum);
957 my $error = $prepay_credit->delete;
959 $dbh->rollback if $oldAutoCommit;
960 return "removing prepay_credit (transaction rolled back): $error";
963 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
964 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
966 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
971 =item increment_upbytes SECONDS
973 Updates this customer's single or primary account (see L<FS::svc_acct>) by
974 the specified number of upbytes. If there is an error, returns the error,
975 otherwise returns false.
979 sub increment_upbytes {
980 _increment_column( shift, 'upbytes', @_);
983 =item increment_downbytes SECONDS
985 Updates this customer's single or primary account (see L<FS::svc_acct>) by
986 the specified number of downbytes. If there is an error, returns the error,
987 otherwise returns false.
991 sub increment_downbytes {
992 _increment_column( shift, 'downbytes', @_);
995 =item increment_totalbytes SECONDS
997 Updates this customer's single or primary account (see L<FS::svc_acct>) by
998 the specified number of totalbytes. If there is an error, returns the error,
999 otherwise returns false.
1003 sub increment_totalbytes {
1004 _increment_column( shift, 'totalbytes', @_);
1007 =item increment_seconds SECONDS
1009 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1010 the specified number of seconds. If there is an error, returns the error,
1011 otherwise returns false.
1015 sub increment_seconds {
1016 _increment_column( shift, 'seconds', @_);
1019 =item _increment_column AMOUNT
1021 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1022 the specified number of seconds or bytes. If there is an error, returns
1023 the error, otherwise returns false.
1027 sub _increment_column {
1028 my( $self, $column, $amount ) = @_;
1029 warn "$me increment_column called: $column, $amount\n"
1032 return '' unless $amount;
1034 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1035 $self->ncancelled_pkgs;
1037 if ( ! @cust_pkg ) {
1038 return 'No packages with primary or single services found'.
1039 ' to apply pre-paid time';
1040 } elsif ( scalar(@cust_pkg) > 1 ) {
1041 #maybe have a way to specify the package/account?
1042 return 'Multiple packages found to apply pre-paid time';
1045 my $cust_pkg = $cust_pkg[0];
1046 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1050 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1052 if ( ! @cust_svc ) {
1053 return 'No account found to apply pre-paid time';
1054 } elsif ( scalar(@cust_svc) > 1 ) {
1055 return 'Multiple accounts found to apply pre-paid time';
1058 my $svc_acct = $cust_svc[0]->svc_x;
1059 warn " found service svcnum ". $svc_acct->pkgnum.
1060 ' ('. $svc_acct->email. ")\n"
1063 $column = "increment_$column";
1064 $svc_acct->$column($amount);
1068 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1070 Inserts a prepayment in the specified amount for this customer. An optional
1071 second argument can specify the prepayment identifier for tracking purposes.
1072 If there is an error, returns the error, otherwise returns false.
1076 sub insert_cust_pay_prepay {
1077 shift->insert_cust_pay('PREP', @_);
1080 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1082 Inserts a cash payment in the specified amount for this customer. An optional
1083 second argument can specify the payment identifier for tracking purposes.
1084 If there is an error, returns the error, otherwise returns false.
1088 sub insert_cust_pay_cash {
1089 shift->insert_cust_pay('CASH', @_);
1092 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1094 Inserts a Western Union payment in the specified amount for this customer. An
1095 optional second argument can specify the prepayment identifier for tracking
1096 purposes. If there is an error, returns the error, otherwise returns false.
1100 sub insert_cust_pay_west {
1101 shift->insert_cust_pay('WEST', @_);
1104 sub insert_cust_pay {
1105 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1106 my $payinfo = scalar(@_) ? shift : '';
1108 my $cust_pay = new FS::cust_pay {
1109 'custnum' => $self->custnum,
1110 'paid' => sprintf('%.2f', $amount),
1111 #'_date' => #date the prepaid card was purchased???
1113 'payinfo' => $payinfo,
1119 =item delete [ OPTION => VALUE ... ]
1121 This deletes the customer. If there is an error, returns the error, otherwise
1124 This will completely remove all traces of the customer record. This is not
1125 what you want when a customer cancels service; for that, cancel all of the
1126 customer's packages (see L</cancel>).
1128 If the customer has any uncancelled packages, you need to pass a new (valid)
1129 customer number for those packages to be transferred to, as the "new_customer"
1130 option. Cancelled packages will be deleted. Did I mention that this is NOT
1131 what you want when a customer cancels service and that you really should be
1132 looking at L<FS::cust_pkg/cancel>?
1134 You can't delete a customer with invoices (see L<FS::cust_bill>),
1135 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1136 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1137 set the "delete_financials" option to a true value.
1142 my( $self, %opt ) = @_;
1144 local $SIG{HUP} = 'IGNORE';
1145 local $SIG{INT} = 'IGNORE';
1146 local $SIG{QUIT} = 'IGNORE';
1147 local $SIG{TERM} = 'IGNORE';
1148 local $SIG{TSTP} = 'IGNORE';
1149 local $SIG{PIPE} = 'IGNORE';
1151 my $oldAutoCommit = $FS::UID::AutoCommit;
1152 local $FS::UID::AutoCommit = 0;
1155 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1156 $dbh->rollback if $oldAutoCommit;
1157 return "Can't delete a master agent customer";
1160 #use FS::access_user
1161 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1162 $dbh->rollback if $oldAutoCommit;
1163 return "Can't delete a master employee customer";
1166 tie my %financial_tables, 'Tie::IxHash',
1167 'cust_bill' => 'invoices',
1168 'cust_statement' => 'statements',
1169 'cust_credit' => 'credits',
1170 'cust_pay' => 'payments',
1171 'cust_refund' => 'refunds',
1174 foreach my $table ( keys %financial_tables ) {
1176 my @records = $self->$table();
1178 if ( @records && ! $opt{'delete_financials'} ) {
1179 $dbh->rollback if $oldAutoCommit;
1180 return "Can't delete a customer with ". $financial_tables{$table};
1183 foreach my $record ( @records ) {
1184 my $error = $record->delete;
1186 $dbh->rollback if $oldAutoCommit;
1187 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1193 my @cust_pkg = $self->ncancelled_pkgs;
1195 my $new_custnum = $opt{'new_custnum'};
1196 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1197 $dbh->rollback if $oldAutoCommit;
1198 return "Invalid new customer number: $new_custnum";
1200 foreach my $cust_pkg ( @cust_pkg ) {
1201 my %hash = $cust_pkg->hash;
1202 $hash{'custnum'} = $new_custnum;
1203 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1204 my $error = $new_cust_pkg->replace($cust_pkg,
1205 options => { $cust_pkg->options },
1208 $dbh->rollback if $oldAutoCommit;
1213 my @cancelled_cust_pkg = $self->all_pkgs;
1214 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1215 my $error = $cust_pkg->delete;
1217 $dbh->rollback if $oldAutoCommit;
1222 #cust_tax_adjustment in financials?
1223 #cust_pay_pending? ouch
1224 foreach my $table (qw(
1225 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1226 cust_payby cust_location cust_main_note cust_tax_adjustment
1227 cust_pay_void cust_pay_batch queue cust_tax_exempt
1229 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1230 my $error = $record->delete;
1232 $dbh->rollback if $oldAutoCommit;
1238 my $sth = $dbh->prepare(
1239 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1241 my $errstr = $dbh->errstr;
1242 $dbh->rollback if $oldAutoCommit;
1245 $sth->execute($self->custnum) or do {
1246 my $errstr = $sth->errstr;
1247 $dbh->rollback if $oldAutoCommit;
1253 my $ticket_dbh = '';
1254 if ($conf->config('ticket_system') eq 'RT_Internal') {
1256 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1257 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1258 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1259 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1262 if ( $ticket_dbh ) {
1264 my $ticket_sth = $ticket_dbh->prepare(
1265 'DELETE FROM Links WHERE Target = ?'
1267 my $errstr = $ticket_dbh->errstr;
1268 $dbh->rollback if $oldAutoCommit;
1271 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1273 my $errstr = $ticket_sth->errstr;
1274 $dbh->rollback if $oldAutoCommit;
1278 #check and see if the customer is the only link on the ticket, and
1279 #if so, set the ticket to deleted status in RT?
1280 #maybe someday, for now this will at least fix tickets not displaying
1284 #delete the customer record
1286 my $error = $self->SUPER::delete;
1288 $dbh->rollback if $oldAutoCommit;
1292 # cust_main exports!
1294 #my $export_args = $options{'export_args'} || [];
1297 map qsearch( 'part_export', {exportnum=>$_} ),
1298 $conf->config('cust_main-exports'); #, $agentnum
1300 foreach my $part_export ( @part_export ) {
1301 my $error = $part_export->export_delete( $self ); #, @$export_args);
1303 $dbh->rollback if $oldAutoCommit;
1304 return "exporting to ". $part_export->exporttype.
1305 " (transaction rolled back): $error";
1309 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1314 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1316 Replaces the OLD_RECORD with this one in the database. If there is an error,
1317 returns the error, otherwise returns false.
1319 To change the customer's address, set the pseudo-fields C<bill_location> and
1320 C<ship_location>. The address will still only change if at least one of the
1321 address fields differs from the existing values.
1323 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1324 set as the contact email address for a default contact with the same name as
1327 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1328 I<contact_params>, I<invoicing_list>.
1330 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1331 of tax names and exemption numbers. FS::cust_main_exemption records will be
1332 deleted and inserted as appropriate.
1334 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1335 groups (describing the customer's payment methods and contacts, respectively)
1336 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1337 and L<FS::contact> for the fields these can contain.
1339 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1340 should be used instead if possible.
1347 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1349 : $self->replace_old;
1353 warn "$me replace called\n"
1356 my $curuser = $FS::CurrentUser::CurrentUser;
1357 return "You are not permitted to create complimentary accounts."
1358 if $self->complimentary eq 'Y'
1359 && $self->complimentary ne $old->complimentary
1360 && ! $curuser->access_right('Complimentary customer');
1362 local($ignore_expired_card) = 1
1363 if $old->payby =~ /^(CARD|DCRD)$/
1364 && $self->payby =~ /^(CARD|DCRD)$/
1365 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1367 local($ignore_banned_card) = 1
1368 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1369 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1370 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1372 if ( $self->payby =~ /^(CARD|DCRD)$/
1373 && $old->payinfo ne $self->payinfo
1374 && $old->paymask ne $self->paymask )
1376 my $error = $self->check_payinfo_cardtype;
1377 return $error if $error;
1380 return "Invoicing locale is required"
1383 && $conf->exists('cust_main-require_locale');
1385 local $SIG{HUP} = 'IGNORE';
1386 local $SIG{INT} = 'IGNORE';
1387 local $SIG{QUIT} = 'IGNORE';
1388 local $SIG{TERM} = 'IGNORE';
1389 local $SIG{TSTP} = 'IGNORE';
1390 local $SIG{PIPE} = 'IGNORE';
1392 my $oldAutoCommit = $FS::UID::AutoCommit;
1393 local $FS::UID::AutoCommit = 0;
1396 for my $l (qw(bill_location ship_location)) {
1397 #my $old_loc = $old->$l;
1398 my $new_loc = $self->$l or next;
1400 # find the existing location if there is one
1401 $new_loc->set('custnum' => $self->custnum);
1402 my $error = $new_loc->find_or_insert;
1404 $dbh->rollback if $oldAutoCommit;
1407 $self->set($l.'num', $new_loc->locationnum);
1411 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1412 warn "cust_main::replace: using deprecated invoicing list argument";
1413 $invoicing_list = shift @param;
1416 my %options = @param;
1418 $invoicing_list ||= $options{invoicing_list};
1420 my @contacts = map { $_->contact } $self->cust_contact;
1421 # find a contact that matches the customer's name
1422 my ($implicit_contact) = grep { $_->first eq $old->get('first')
1423 and $_->last eq $old->get('last') }
1425 $implicit_contact ||= FS::contact->new({
1426 'custnum' => $self->custnum,
1427 'locationnum' => $self->get('bill_locationnum'),
1430 # for any of these that are already contact emails, link to the existing
1432 if ( $invoicing_list ) {
1435 # kind of like process_m2m on these, except:
1436 # - the other side is two tables in a join
1437 # - and we might have to create new contact_emails
1438 # - and possibly a new contact
1440 # Find existing invoice emails that aren't on the implicit contact.
1441 # Any of these that are not on the new invoicing list will be removed.
1442 my %old_email_cust_contact;
1443 foreach my $cust_contact ($self->cust_contact) {
1444 next if !$cust_contact->invoice_dest;
1445 next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1447 foreach my $contact_email ($cust_contact->contact->contact_email) {
1448 $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1452 foreach my $dest (@$invoicing_list) {
1454 if ($dest eq 'POST') {
1456 $self->set('postal_invoice', 'Y');
1458 } elsif ( exists($old_email_cust_contact{$dest}) ) {
1460 delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1464 # See if it belongs to some other contact; if so, link it.
1465 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1467 and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1468 my $cust_contact = qsearchs('cust_contact', {
1469 contactnum => $contact_email->contactnum,
1470 custnum => $self->custnum,
1471 }) || FS::cust_contact->new({
1472 contactnum => $contact_email->contactnum,
1473 custnum => $self->custnum,
1475 $cust_contact->set('invoice_dest', 'Y');
1476 my $error = $cust_contact->custcontactnum ?
1477 $cust_contact->replace : $cust_contact->insert;
1479 $dbh->rollback if $oldAutoCommit;
1480 return "$error (linking to email address $dest)";
1484 # This email address is not yet linked to any contact, so it will
1485 # be added to the implicit contact.
1486 $email .= ',' if length($email);
1492 foreach my $remove_dest (keys %old_email_cust_contact) {
1493 my $cust_contact = $old_email_cust_contact{$remove_dest};
1494 # These were not in the list of requested destinations, so take them off.
1495 $cust_contact->set('invoice_dest', '');
1496 my $error = $cust_contact->replace;
1498 $dbh->rollback if $oldAutoCommit;
1499 return "$error (unlinking email address $remove_dest)";
1503 # make sure it keeps up with the changed customer name, if any
1504 $implicit_contact->set('last', $self->get('last'));
1505 $implicit_contact->set('first', $self->get('first'));
1506 $implicit_contact->set('emailaddress', $email);
1507 $implicit_contact->set('invoice_dest', 'Y');
1508 $implicit_contact->set('custnum', $self->custnum);
1511 if ( $implicit_contact->contactnum ) {
1512 $error = $implicit_contact->replace;
1513 } elsif ( length($email) ) { # don't create a new contact if not needed
1514 $error = $implicit_contact->insert;
1518 $dbh->rollback if $oldAutoCommit;
1519 return "$error (adding email address $email)";
1524 # replace the customer record
1525 my $error = $self->SUPER::replace($old);
1528 $dbh->rollback if $oldAutoCommit;
1532 # now move packages to the new service location
1533 $self->set('ship_location', ''); #flush cache
1534 if ( $old->ship_locationnum and # should only be null during upgrade...
1535 $old->ship_locationnum != $self->ship_locationnum ) {
1536 $error = $old->ship_location->move_to($self->ship_location);
1538 $dbh->rollback if $oldAutoCommit;
1542 # don't move packages based on the billing location, but
1543 # disable it if it's no longer in use
1544 if ( $old->bill_locationnum and
1545 $old->bill_locationnum != $self->bill_locationnum ) {
1546 $error = $old->bill_location->disable_if_unused;
1548 $dbh->rollback if $oldAutoCommit;
1553 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1555 #this could be more efficient than deleting and re-inserting, if it matters
1556 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1557 my $error = $cust_tag->delete;
1559 $dbh->rollback if $oldAutoCommit;
1563 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1564 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1565 'custnum' => $self->custnum };
1566 my $error = $cust_tag->insert;
1568 $dbh->rollback if $oldAutoCommit;
1575 my $tax_exemption = delete $options{'tax_exemption'};
1576 if ( $tax_exemption ) {
1578 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1579 if ref($tax_exemption) eq 'ARRAY';
1581 my %cust_main_exemption =
1582 map { $_->taxname => $_ }
1583 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1585 foreach my $taxname ( keys %$tax_exemption ) {
1587 if ( $cust_main_exemption{$taxname} &&
1588 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1591 delete $cust_main_exemption{$taxname};
1595 my $cust_main_exemption = new FS::cust_main_exemption {
1596 'custnum' => $self->custnum,
1597 'taxname' => $taxname,
1598 'exempt_number' => $tax_exemption->{$taxname},
1600 my $error = $cust_main_exemption->insert;
1602 $dbh->rollback if $oldAutoCommit;
1603 return "inserting cust_main_exemption (transaction rolled back): $error";
1607 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1608 my $error = $cust_main_exemption->delete;
1610 $dbh->rollback if $oldAutoCommit;
1611 return "deleting cust_main_exemption (transaction rolled back): $error";
1617 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1619 my $error = $self->process_o2m(
1620 'table' => 'cust_payby',
1621 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1622 'params' => $cust_payby_params,
1623 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1626 $dbh->rollback if $oldAutoCommit;
1632 if ( my $contact_params = delete $options{'contact_params'} ) {
1634 # this can potentially replace contacts that were created by the
1635 # invoicing list argument, but the UI shouldn't allow both of them
1638 my $error = $self->process_o2m(
1639 'table' => 'contact',
1640 'fields' => FS::contact->cgi_contact_fields,
1641 'params' => $contact_params,
1644 $dbh->rollback if $oldAutoCommit;
1650 unless ( $import || $skip_fuzzyfiles ) {
1651 $error = $self->queue_fuzzyfiles_update;
1653 $dbh->rollback if $oldAutoCommit;
1654 return "updating fuzzy search cache: $error";
1658 # tax district update in cust_location
1660 # cust_main exports!
1662 my $export_args = $options{'export_args'} || [];
1665 map qsearch( 'part_export', {exportnum=>$_} ),
1666 $conf->config('cust_main-exports'); #, $agentnum
1668 foreach my $part_export ( @part_export ) {
1669 my $error = $part_export->export_replace( $self, $old, @$export_args);
1671 $dbh->rollback if $oldAutoCommit;
1672 return "exporting to ". $part_export->exporttype.
1673 " (transaction rolled back): $error";
1677 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1682 =item queue_fuzzyfiles_update
1684 Used by insert & replace to update the fuzzy search cache
1688 use FS::cust_main::Search;
1689 sub queue_fuzzyfiles_update {
1692 local $SIG{HUP} = 'IGNORE';
1693 local $SIG{INT} = 'IGNORE';
1694 local $SIG{QUIT} = 'IGNORE';
1695 local $SIG{TERM} = 'IGNORE';
1696 local $SIG{TSTP} = 'IGNORE';
1697 local $SIG{PIPE} = 'IGNORE';
1699 my $oldAutoCommit = $FS::UID::AutoCommit;
1700 local $FS::UID::AutoCommit = 0;
1703 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1704 my $queue = new FS::queue {
1705 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1707 my @args = "cust_main.$field", $self->get($field);
1708 my $error = $queue->insert( @args );
1710 $dbh->rollback if $oldAutoCommit;
1711 return "queueing job (transaction rolled back): $error";
1716 push @locations, $self->bill_location if $self->bill_locationnum;
1717 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1718 foreach my $location (@locations) {
1719 my $queue = new FS::queue {
1720 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1722 my @args = 'cust_location.address1', $location->address1;
1723 my $error = $queue->insert( @args );
1725 $dbh->rollback if $oldAutoCommit;
1726 return "queueing job (transaction rolled back): $error";
1730 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1737 Checks all fields to make sure this is a valid customer record. If there is
1738 an error, returns the error, otherwise returns false. Called by the insert
1739 and replace methods.
1746 warn "$me check BEFORE: \n". $self->_dump
1750 $self->ut_numbern('custnum')
1751 || $self->ut_number('agentnum')
1752 || $self->ut_textn('agent_custid')
1753 || $self->ut_number('refnum')
1754 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1755 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1756 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1757 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1758 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1759 || $self->ut_textn('custbatch')
1760 || $self->ut_name('last')
1761 || $self->ut_name('first')
1762 || $self->ut_snumbern('signupdate')
1763 || $self->ut_snumbern('birthdate')
1764 || $self->ut_namen('spouse_last')
1765 || $self->ut_namen('spouse_first')
1766 || $self->ut_snumbern('spouse_birthdate')
1767 || $self->ut_snumbern('anniversary_date')
1768 || $self->ut_textn('company')
1769 || $self->ut_textn('ship_company')
1770 || $self->ut_anything('comments')
1771 || $self->ut_numbern('referral_custnum')
1772 || $self->ut_textn('stateid')
1773 || $self->ut_textn('stateid_state')
1774 || $self->ut_textn('invoice_terms')
1775 || $self->ut_floatn('cdr_termination_percentage')
1776 || $self->ut_floatn('credit_limit')
1777 || $self->ut_numbern('billday')
1778 || $self->ut_numbern('prorate_day')
1779 || $self->ut_flag('force_prorate_day')
1780 || $self->ut_flag('edit_subject')
1781 || $self->ut_flag('calling_list_exempt')
1782 || $self->ut_flag('invoice_noemail')
1783 || $self->ut_flag('message_noemail')
1784 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1785 || $self->ut_currencyn('currency')
1786 || $self->ut_textn('po_number')
1787 || $self->ut_enum('complimentary', [ '', 'Y' ])
1788 || $self->ut_flag('invoice_ship_address')
1789 || $self->ut_flag('invoice_dest')
1792 foreach (qw(company ship_company)) {
1793 my $company = $self->get($_);
1794 $company =~ s/^\s+//;
1795 $company =~ s/\s+$//;
1796 $company =~ s/\s+/ /g;
1797 $self->set($_, $company);
1800 #barf. need message catalogs. i18n. etc.
1801 $error .= "Please select an advertising source."
1802 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1803 return $error if $error;
1805 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1806 or return "Unknown agent";
1808 if ( $self->currency ) {
1809 my $agent_currency = qsearchs( 'agent_currency', {
1810 'agentnum' => $agent->agentnum,
1811 'currency' => $self->currency,
1813 or return "Agent ". $agent->agent.
1814 " not permitted to offer ". $self->currency. " invoicing";
1817 return "Unknown refnum"
1818 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1820 return "Unknown referring custnum: ". $self->referral_custnum
1821 unless ! $self->referral_custnum
1822 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1824 if ( $self->ss eq '' ) {
1829 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1830 or return "Illegal social security number: ". $self->ss;
1831 $self->ss("$1-$2-$3");
1834 #turn off invoice_ship_address if ship & bill are the same
1835 if ($self->bill_locationnum eq $self->ship_locationnum) {
1836 $self->invoice_ship_address('');
1839 # cust_main_county verification now handled by cust_location check
1842 $self->ut_phonen('daytime', $self->country)
1843 || $self->ut_phonen('night', $self->country)
1844 || $self->ut_phonen('fax', $self->country)
1845 || $self->ut_phonen('mobile', $self->country)
1847 return $error if $error;
1849 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1851 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1854 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1856 : FS::Msgcat::_gettext('daytime');
1857 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1859 : FS::Msgcat::_gettext('night');
1861 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1863 : FS::Msgcat::_gettext('mobile');
1865 return "$daytime_label, $night_label or $mobile_label is required"
1869 ### start of stuff moved to cust_payby
1870 # then mostly kept here to support upgrades (can remove in 5.x)
1871 # but modified to allow everything to be empty
1873 if ( $self->payby ) {
1874 FS::payby->can_payby($self->table, $self->payby)
1875 or return "Illegal payby: ". $self->payby;
1880 $error = $self->ut_numbern('paystart_month')
1881 || $self->ut_numbern('paystart_year')
1882 || $self->ut_numbern('payissue')
1883 || $self->ut_textn('paytype')
1885 return $error if $error;
1887 if ( $self->payip eq '' ) {
1890 $error = $self->ut_ip('payip');
1891 return $error if $error;
1894 # If it is encrypted and the private key is not availaible then we can't
1895 # check the credit card.
1896 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1898 # Need some kind of global flag to accept invalid cards, for testing
1900 if ( !$import && !$ignore_invalid_card && $check_payinfo &&
1901 $self->payby =~ /^(CARD|DCRD)$/ ) {
1903 my $payinfo = $self->payinfo;
1904 $payinfo =~ s/\D//g;
1905 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1906 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1908 $self->payinfo($payinfo);
1910 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1912 return gettext('unknown_card_type')
1913 if $self->payinfo !~ /^99\d{14}$/ #token
1914 && cardtype($self->payinfo) eq "Unknown";
1916 unless ( $ignore_banned_card ) {
1917 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1919 if ( $ban->bantype eq 'warn' ) {
1920 #or others depending on value of $ban->reason ?
1921 return '_duplicate_card'.
1922 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1923 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1924 ' (ban# '. $ban->bannum. ')'
1925 unless $self->override_ban_warn;
1927 return 'Banned credit card: banned on '.
1928 time2str('%a %h %o at %r', $ban->_date).
1929 ' by '. $ban->otaker.
1930 ' (ban# '. $ban->bannum. ')';
1935 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1936 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1937 $self->paycvv =~ /^(\d{4})$/
1938 or return "CVV2 (CID) for American Express cards is four digits.";
1941 $self->paycvv =~ /^(\d{3})$/
1942 or return "CVV2 (CVC2/CID) is three digits.";
1949 my $cardtype = cardtype($payinfo);
1950 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1952 return "Start date or issue number is required for $cardtype cards"
1953 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1955 return "Start month must be between 1 and 12"
1956 if $self->paystart_month
1957 and $self->paystart_month < 1 || $self->paystart_month > 12;
1959 return "Start year must be 1990 or later"
1960 if $self->paystart_year
1961 and $self->paystart_year < 1990;
1963 return "Issue number must be beween 1 and 99"
1965 and $self->payissue < 1 || $self->payissue > 99;
1968 $self->paystart_month('');
1969 $self->paystart_year('');
1970 $self->payissue('');
1973 } elsif ( !$ignore_invalid_card && $check_payinfo &&
1974 $self->payby =~ /^(CHEK|DCHK)$/ ) {
1976 my $payinfo = $self->payinfo;
1977 $payinfo =~ s/[^\d\@\.]//g;
1978 if ( $conf->config('echeck-country') eq 'CA' ) {
1979 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1980 or return 'invalid echeck account@branch.bank';
1981 $payinfo = "$1\@$2.$3";
1982 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1983 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1984 $payinfo = "$1\@$2";
1986 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1987 $payinfo = "$1\@$2";
1989 $self->payinfo($payinfo);
1992 unless ( $ignore_banned_card ) {
1993 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1995 if ( $ban->bantype eq 'warn' ) {
1996 #or others depending on value of $ban->reason ?
1997 return '_duplicate_ach' unless $self->override_ban_warn;
1999 return 'Banned ACH account: banned on '.
2000 time2str('%a %h %o at %r', $ban->_date).
2001 ' by '. $ban->otaker.
2002 ' (ban# '. $ban->bannum. ')';
2007 } elsif ( $self->payby eq 'LECB' ) {
2009 my $payinfo = $self->payinfo;
2010 $payinfo =~ s/\D//g;
2011 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2013 $self->payinfo($payinfo);
2016 } elsif ( $self->payby eq 'BILL' ) {
2018 $error = $self->ut_textn('payinfo');
2019 return "Illegal P.O. number: ". $self->payinfo if $error;
2022 } elsif ( $self->payby eq 'COMP' ) {
2024 my $curuser = $FS::CurrentUser::CurrentUser;
2025 if ( ! $self->custnum
2026 && ! $curuser->access_right('Complimentary customer')
2029 return "You are not permitted to create complimentary accounts."
2032 $error = $self->ut_textn('payinfo');
2033 return "Illegal comp account issuer: ". $self->payinfo if $error;
2036 } elsif ( $self->payby eq 'PREPAY' ) {
2038 my $payinfo = $self->payinfo;
2039 $payinfo =~ s/\W//g; #anything else would just confuse things
2040 $self->payinfo($payinfo);
2041 $error = $self->ut_alpha('payinfo');
2042 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2043 return "Unknown prepayment identifier"
2044 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2049 return "You are not permitted to create complimentary accounts."
2051 && $self->complimentary eq 'Y'
2052 && ! $FS::CurrentUser::CurrentUser->access_right('Complimentary customer');
2054 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2055 return "Expiration date required"
2056 # shouldn't payinfo_check do this?
2057 unless ! $self->payby
2058 || $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2062 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2063 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2064 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2065 ( $m, $y ) = ( $2, "19$1" );
2066 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2067 ( $m, $y ) = ( $3, "20$2" );
2069 return "Illegal expiration date: ". $self->paydate;
2071 $m = sprintf('%02d',$m);
2072 $self->paydate("$y-$m-01");
2073 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2074 return gettext('expired_card')
2076 && !$ignore_expired_card
2077 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2080 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2081 ( ! $conf->exists('require_cardname')
2082 || $self->payby !~ /^(CARD|DCRD)$/ )
2084 $self->payname( $self->first. " ". $self->getfield('last') );
2087 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2088 $self->payname =~ /^([\w \,\.\-\']*)$/
2089 or return gettext('illegal_name'). " payname: ". $self->payname;
2092 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2093 or return gettext('illegal_name'). " payname: ". $self->payname;
2099 ### end of stuff moved to cust_payby
2101 return "Please select an invoicing locale"
2104 && $conf->exists('cust_main-require_locale');
2106 return "Please select a customer class"
2107 if ! $self->classnum
2108 && $conf->exists('cust_main-require_classnum');
2110 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2111 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2115 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2117 warn "$me check AFTER: \n". $self->_dump
2120 $self->SUPER::check;
2123 sub check_payinfo_cardtype {
2126 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
2128 my $payinfo = $self->payinfo;
2129 $payinfo =~ s/\D//g;
2131 return '' if $self->tokenized($payinfo); #token
2133 my %bop_card_types = map { $_=>1 } values %{ card_types() };
2134 my $cardtype = cardtype($payinfo);
2136 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
2144 Additional checks for replace only.
2149 my ($new,$old) = @_;
2150 #preserve old value if global config is set
2151 if ($old && $conf->exists('invoice-ship_address')) {
2152 $new->invoice_ship_address($old->invoice_ship_address);
2159 Returns a list of fields which have ship_ duplicates.
2164 qw( last first company
2166 address1 address2 city county state zip country
2168 daytime night fax mobile
2172 =item has_ship_address
2174 Returns true if this customer record has a separate shipping address.
2178 sub has_ship_address {
2180 $self->bill_locationnum != $self->ship_locationnum;
2185 Returns a list of key/value pairs, with the following keys: address1,
2186 adddress2, city, county, state, zip, country, district, and geocode. The
2187 shipping address is used if present.
2193 $self->ship_location->location_hash;
2198 Returns all locations (see L<FS::cust_location>) for this customer.
2205 'table' => 'cust_location',
2206 'hashref' => { 'custnum' => $self->custnum,
2207 'prospectnum' => '',
2209 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
2215 Returns all contact associations (see L<FS::cust_contact>) for this customer.
2221 qsearch('cust_contact', { 'custnum' => $self->custnum } );
2224 =item cust_payby PAYBY
2226 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2228 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
2229 Does not validate PAYBY.
2237 'table' => 'cust_payby',
2238 'hashref' => { 'custnum' => $self->custnum },
2239 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
2241 $search->{'extra_sql'} = ' AND payby IN ( '.
2242 join(',', map dbh->quote($_), @payby).
2249 =item has_cust_payby_auto
2251 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2255 sub has_cust_payby_auto {
2258 'table' => 'cust_payby',
2259 'hashref' => { 'custnum' => $self->custnum, },
2260 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2261 'order_by' => 'LIMIT 1',
2268 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2269 and L<FS::cust_pkg>) for this customer, except those on hold.
2271 Returns a list: an empty list on success or a list of errors.
2277 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2282 Unsuspends all suspended packages in the on-hold state (those without setup
2283 dates) for this customer.
2289 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2294 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2296 Returns a list: an empty list on success or a list of errors.
2302 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2305 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2307 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2308 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2309 of a list of pkgparts; the hashref has the following keys:
2313 =item pkgparts - listref of pkgparts
2315 =item (other options are passed to the suspend method)
2320 Returns a list: an empty list on success or a list of errors.
2324 sub suspend_if_pkgpart {
2326 my (@pkgparts, %opt);
2327 if (ref($_[0]) eq 'HASH'){
2328 @pkgparts = @{$_[0]{pkgparts}};
2333 grep { $_->suspend(%opt) }
2334 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2335 $self->unsuspended_pkgs;
2338 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2340 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2341 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2342 instead of a list of pkgparts; the hashref has the following keys:
2346 =item pkgparts - listref of pkgparts
2348 =item (other options are passed to the suspend method)
2352 Returns a list: an empty list on success or a list of errors.
2356 sub suspend_unless_pkgpart {
2358 my (@pkgparts, %opt);
2359 if (ref($_[0]) eq 'HASH'){
2360 @pkgparts = @{$_[0]{pkgparts}};
2365 grep { $_->suspend(%opt) }
2366 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2367 $self->unsuspended_pkgs;
2370 =item cancel [ OPTION => VALUE ... ]
2372 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2373 The cancellation time will be now.
2377 Always returns a list: an empty list on success or a list of errors.
2384 warn "$me cancel called on customer ". $self->custnum. " with options ".
2385 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2387 my @pkgs = $self->ncancelled_pkgs;
2389 $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2392 =item cancel_pkgs OPTIONS
2394 Cancels a specified list of packages. OPTIONS can include:
2398 =item cust_pkg - an arrayref of the packages. Required.
2400 =item time - the cancellation time, used to calculate final bills and
2401 unused-time credits if any. Will be passed through to the bill() and
2402 FS::cust_pkg::cancel() methods.
2404 =item quiet - can be set true to supress email cancellation notices.
2406 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a
2407 reasonnum of an existing reason, or passing a hashref will create a new reason.
2408 The hashref should have the following keys:
2409 typenum - Reason type (see L<FS::reason_type>)
2410 reason - Text of the new reason.
2412 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2413 for the individual packages, parallel to the C<cust_pkg> argument. The
2414 reason and reason_otaker arguments will be taken from those objects.
2416 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2418 =item nobill - can be set true to skip billing if it might otherwise be done.
2423 my( $self, %opt ) = @_;
2425 # we're going to cancel services, which is not reversible
2426 die "cancel_pkgs cannot be run inside a transaction"
2427 if $FS::UID::AutoCommit == 0;
2429 local $FS::UID::AutoCommit = 0;
2431 return ( 'access denied' )
2432 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2434 if ( $opt{'ban'} ) {
2436 foreach my $cust_payby ( $self->cust_payby ) {
2438 #well, if they didn't get decrypted on search, then we don't have to
2439 # try again... queue a job for the server that does have decryption
2440 # capability if we're in a paranoid multi-server implementation?
2441 return ( "Can't (yet) ban encrypted credit cards" )
2442 if $cust_payby->is_encrypted($cust_payby->payinfo);
2444 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2445 my $error = $ban->insert;
2455 my @pkgs = @{ delete $opt{'cust_pkg'} };
2456 my $cancel_time = $opt{'time'} || time;
2458 # bill all packages first, so we don't lose usage, service counts for
2459 # bulk billing, etc.
2460 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2462 my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2464 'time' => $cancel_time );
2466 warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2468 return ( "Error billing during cancellation: $error" );
2473 $FS::UID::AutoCommit = 1;
2475 # now cancel all services, the same way we would for individual packages.
2476 # if any of them fail, cancel the rest anyway.
2477 my @cust_svc = map { $_->cust_svc } @pkgs;
2478 my @sorted_cust_svc =
2480 sort { $a->[1] <=> $b->[1] }
2481 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2483 warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2486 foreach my $cust_svc (@sorted_cust_svc) {
2487 my $part_svc = $cust_svc->part_svc;
2488 next if ( defined($part_svc) and $part_svc->preserve );
2489 my $error = $cust_svc->cancel; # immediate cancel, no date option
2490 push @errors, $error if $error;
2496 warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2497 $self->custnum. "\n"
2501 if ($opt{'cust_pkg_reason'}) {
2502 @cprs = @{ delete $opt{'cust_pkg_reason'} };
2508 my $cpr = shift @cprs;
2510 $lopt{'reason'} = $cpr->reasonnum;
2511 $lopt{'reason_otaker'} = $cpr->otaker;
2513 warn "no reason found when canceling package ".$_->pkgnum."\n";
2514 # we're not actually required to pass a reason to cust_pkg::cancel,
2515 # but if we're getting to this point, something has gone awry.
2516 $null_reason ||= FS::reason->new_or_existing(
2517 reason => 'unknown reason',
2518 type => 'Cancel Reason',
2521 $lopt{'reason'} = $null_reason->reasonnum;
2522 $lopt{'reason_otaker'} = $FS::CurrentUser::CurrentUser->username;
2525 my $error = $_->cancel(%lopt);
2526 push @errors, 'pkgnum '.$_->pkgnum.': '.$error if $error;
2532 sub _banned_pay_hashref {
2543 'payby' => $payby2ban{$self->payby},
2544 'payinfo' => $self->payinfo,
2545 #don't ever *search* on reason! #'reason' =>
2551 Returns all notes (see L<FS::cust_main_note>) for this customer.
2556 my($self,$orderby_classnum) = (shift,shift);
2557 my $orderby = "sticky DESC, _date DESC";
2558 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2559 qsearch( 'cust_main_note',
2560 { 'custnum' => $self->custnum },
2562 "ORDER BY $orderby",
2568 Returns the agent (see L<FS::agent>) for this customer.
2572 Returns the agent name (see L<FS::agent>) for this customer.
2578 $self->agent->agent;
2583 Returns any tags associated with this customer, as FS::cust_tag objects,
2584 or an empty list if there are no tags.
2588 Returns any tags associated with this customer, as FS::part_tag objects,
2589 or an empty list if there are no tags.
2595 map $_->part_tag, $self->cust_tag;
2601 Returns the customer class, as an FS::cust_class object, or the empty string
2602 if there is no customer class.
2606 Returns the customer category name, or the empty string if there is no customer
2613 my $cust_class = $self->cust_class;
2615 ? $cust_class->categoryname
2621 Returns the customer class name, or the empty string if there is no customer
2628 my $cust_class = $self->cust_class;
2630 ? $cust_class->classname
2636 Returns the external tax status, as an FS::tax_status object, or the empty
2637 string if there is no tax status.
2643 if ( $self->taxstatusnum ) {
2644 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2652 Returns the tax status code if there is one.
2658 my $tax_status = $self->tax_status;
2660 ? $tax_status->taxstatus
2664 =item BILLING METHODS
2666 Documentation on billing methods has been moved to
2667 L<FS::cust_main::Billing>.
2669 =item REALTIME BILLING METHODS
2671 Documentation on realtime billing methods has been moved to
2672 L<FS::cust_main::Billing_Realtime>.
2676 Removes the I<paycvv> field from the database directly.
2678 If there is an error, returns the error, otherwise returns false.
2680 DEPRECATED. Use L</remove_cvv_from_cust_payby> instead.
2686 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2687 or return dbh->errstr;
2688 $sth->execute($self->custnum)
2689 or return $sth->errstr;
2696 Returns the total owed for this customer on all invoices
2697 (see L<FS::cust_bill/owed>).
2703 $self->total_owed_date(2145859200); #12/31/2037
2706 =item total_owed_date TIME
2708 Returns the total owed for this customer on all invoices with date earlier than
2709 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2710 see L<Time::Local> and L<Date::Parse> for conversion functions.
2714 sub total_owed_date {
2718 my $custnum = $self->custnum;
2720 my $owed_sql = FS::cust_bill->owed_sql;
2723 SELECT SUM($owed_sql) FROM cust_bill
2724 WHERE custnum = $custnum
2728 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2732 =item total_owed_pkgnum PKGNUM
2734 Returns the total owed on all invoices for this customer's specific package
2735 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2739 sub total_owed_pkgnum {
2740 my( $self, $pkgnum ) = @_;
2741 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2744 =item total_owed_date_pkgnum TIME PKGNUM
2746 Returns the total owed for this customer's specific package when using
2747 experimental package balances on all invoices with date earlier than
2748 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2749 see L<Time::Local> and L<Date::Parse> for conversion functions.
2753 sub total_owed_date_pkgnum {
2754 my( $self, $time, $pkgnum ) = @_;
2757 foreach my $cust_bill (
2758 grep { $_->_date <= $time }
2759 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2761 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2763 sprintf( "%.2f", $total_bill );
2769 Returns the total amount of all payments.
2776 $total += $_->paid foreach $self->cust_pay;
2777 sprintf( "%.2f", $total );
2780 =item total_unapplied_credits
2782 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2783 customer. See L<FS::cust_credit/credited>.
2785 =item total_credited
2787 Old name for total_unapplied_credits. Don't use.
2791 sub total_credited {
2792 #carp "total_credited deprecated, use total_unapplied_credits";
2793 shift->total_unapplied_credits(@_);
2796 sub total_unapplied_credits {
2799 my $custnum = $self->custnum;
2801 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2804 SELECT SUM($unapplied_sql) FROM cust_credit
2805 WHERE custnum = $custnum
2808 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2812 =item total_unapplied_credits_pkgnum PKGNUM
2814 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2815 customer. See L<FS::cust_credit/credited>.
2819 sub total_unapplied_credits_pkgnum {
2820 my( $self, $pkgnum ) = @_;
2821 my $total_credit = 0;
2822 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2823 sprintf( "%.2f", $total_credit );
2827 =item total_unapplied_payments
2829 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2830 See L<FS::cust_pay/unapplied>.
2834 sub total_unapplied_payments {
2837 my $custnum = $self->custnum;
2839 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2842 SELECT SUM($unapplied_sql) FROM cust_pay
2843 WHERE custnum = $custnum
2846 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2850 =item total_unapplied_payments_pkgnum PKGNUM
2852 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2853 specific package when using experimental package balances. See
2854 L<FS::cust_pay/unapplied>.
2858 sub total_unapplied_payments_pkgnum {
2859 my( $self, $pkgnum ) = @_;
2860 my $total_unapplied = 0;
2861 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2862 sprintf( "%.2f", $total_unapplied );
2866 =item total_unapplied_refunds
2868 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2869 customer. See L<FS::cust_refund/unapplied>.
2873 sub total_unapplied_refunds {
2875 my $custnum = $self->custnum;
2877 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2880 SELECT SUM($unapplied_sql) FROM cust_refund
2881 WHERE custnum = $custnum
2884 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2890 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2891 total_unapplied_credits minus total_unapplied_payments).
2897 $self->balance_date_range;
2900 =item balance_date TIME
2902 Returns the balance for this customer, only considering invoices with date
2903 earlier than TIME (total_owed_date minus total_credited minus
2904 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2905 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2912 $self->balance_date_range(shift);
2915 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2917 Returns the balance for this customer, optionally considering invoices with
2918 date earlier than START_TIME, and not later than END_TIME
2919 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2921 Times are specified as SQL fragments or numeric
2922 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2923 L<Date::Parse> for conversion functions. The empty string can be passed
2924 to disable that time constraint completely.
2926 Accepts the same options as L<balance_date_sql>:
2930 =item unapplied_date
2932 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)
2936 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2937 time will be ignored. Note that START_TIME and END_TIME only limit the date
2938 range for invoices and I<unapplied> payments, credits, and refunds.
2944 sub balance_date_range {
2946 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2947 ') FROM cust_main WHERE custnum='. $self->custnum;
2948 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2951 =item balance_pkgnum PKGNUM
2953 Returns the balance for this customer's specific package when using
2954 experimental package balances (total_owed plus total_unrefunded, minus
2955 total_unapplied_credits minus total_unapplied_payments)
2959 sub balance_pkgnum {
2960 my( $self, $pkgnum ) = @_;
2963 $self->total_owed_pkgnum($pkgnum)
2964 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2965 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2966 - $self->total_unapplied_credits_pkgnum($pkgnum)
2967 - $self->total_unapplied_payments_pkgnum($pkgnum)
2973 Returns a hash of useful information for making a payment.
2983 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2984 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2985 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2989 For credit card transactions:
3001 For electronic check transactions:
3016 $return{balance} = $self->balance;
3018 $return{payname} = $self->payname
3019 || ( $self->first. ' '. $self->get('last') );
3021 $return{$_} = $self->bill_location->$_
3022 for qw(address1 address2 city state zip);
3024 $return{payby} = $self->payby;
3025 $return{stateid_state} = $self->stateid_state;
3027 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
3028 $return{card_type} = cardtype($self->payinfo);
3029 $return{payinfo} = $self->paymask;
3031 @return{'month', 'year'} = $self->paydate_monthyear;
3035 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
3036 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
3037 $return{payinfo1} = $payinfo1;
3038 $return{payinfo2} = $payinfo2;
3039 $return{paytype} = $self->paytype;
3040 $return{paystate} = $self->paystate;
3044 #doubleclick protection
3046 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3054 Returns the next payment expiration date for this customer. If they have no
3055 payment methods that will expire, returns 0.
3061 # filter out the ones that individually return 0, but then return 0 if
3062 # there are no results
3063 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
3064 min( @epochs ) || 0;
3067 =item paydate_epoch_sql
3069 Returns an SQL expression to get the next payment expiration date for a
3070 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
3071 dates, so that it's safe to test for "will it expire before date X" for any
3076 sub paydate_epoch_sql {
3078 my $paydate = FS::cust_payby->paydate_epoch_sql;
3079 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
3083 my( $self, $taxname ) = @_;
3085 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3086 'taxname' => $taxname,
3091 =item cust_main_exemption
3093 =item invoicing_list
3095 Returns a list of email addresses (with svcnum entries expanded), and the word
3096 'POST' if the customer receives postal invoices.
3100 sub invoicing_list {
3101 my( $self, $arrayref ) = @_;
3104 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
3107 my @emails = $self->invoicing_list_emailonly;
3108 push @emails, 'POST' if $self->get('postal_invoice');
3113 =item check_invoicing_list ARRAYREF
3115 Checks these arguements as valid input for the invoicing_list method. If there
3116 is an error, returns the error, otherwise returns false.
3120 sub check_invoicing_list {
3121 my( $self, $arrayref ) = @_;
3123 foreach my $address ( @$arrayref ) {
3125 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3126 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3129 my $cust_main_invoice = new FS::cust_main_invoice ( {
3130 'custnum' => $self->custnum,
3133 my $error = $self->custnum
3134 ? $cust_main_invoice->check
3135 : $cust_main_invoice->checkdest
3137 return $error if $error;
3141 return "Email address required"
3142 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3143 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3150 Returns the email addresses of all accounts provisioned for this customer.
3157 foreach my $cust_pkg ( $self->all_pkgs ) {
3158 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3160 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3161 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3163 $list{$_}=1 foreach map { $_->email } @svc_acct;
3168 =item invoicing_list_addpost
3170 Adds postal invoicing to this customer. If this customer is already configured
3171 to receive postal invoices, does nothing.
3175 sub invoicing_list_addpost {
3177 if ( $self->get('postal_invoice') eq '' ) {
3178 $self->set('postal_invoice', 'Y');
3179 my $error = $self->replace;
3180 warn $error if $error; # should fail harder, but this is traditional
3184 =item invoicing_list_emailonly
3186 Returns the list of email invoice recipients (invoicing_list without non-email
3187 destinations such as POST and FAX).
3191 sub invoicing_list_emailonly {
3193 warn "$me invoicing_list_emailonly called"
3195 return () if !$self->custnum; # not yet inserted
3196 return map { $_->emailaddress }
3198 table => 'cust_contact',
3199 select => 'emailaddress',
3200 addl_from => ' JOIN contact USING (contactnum) '.
3201 ' JOIN contact_email USING (contactnum)',
3202 hashref => { 'custnum' => $self->custnum, },
3203 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
3207 =item invoicing_list_emailonly_scalar
3209 Returns the list of email invoice recipients (invoicing_list without non-email
3210 destinations such as POST and FAX) as a comma-separated scalar.
3214 sub invoicing_list_emailonly_scalar {
3216 warn "$me invoicing_list_emailonly_scalar called"
3218 join(', ', $self->invoicing_list_emailonly);
3221 =item contact_list [ CLASSNUM, ... ]
3223 Returns a list of contacts (L<FS::contact> objects) for the customer. If
3224 a list of contact classnums is given, returns only contacts in those
3225 classes. If the pseudo-classnum 'invoice' is given, returns contacts that
3226 are marked as invoice destinations. If '0' is given, also returns contacts
3229 If no arguments are given, returns all contacts for the customer.
3237 select => 'contact.*, cust_contact.invoice_dest',
3238 addl_from => ' JOIN cust_contact USING (contactnum)',
3239 extra_sql => ' WHERE cust_contact.custnum = '.$self->custnum,
3245 if ( $_ eq 'invoice' ) {
3246 push @orwhere, 'cust_contact.invoice_dest = \'Y\'';
3247 } elsif ( $_ eq '0' ) {
3248 push @orwhere, 'cust_contact.classnum is null';
3249 } elsif ( /^\d+$/ ) {
3250 push @classnums, $_;
3252 die "bad classnum argument '$_'";
3257 push @orwhere, 'cust_contact.classnum IN ('.join(',', @classnums).')';
3260 $search->{extra_sql} .= ' AND (' .
3261 join(' OR ', map "( $_ )", @orwhere) .
3268 =item contact_list_email [ CLASSNUM, ... ]
3270 Same as L</contact_list>, but returns email destinations instead of contact
3275 sub contact_list_email {
3277 my @contacts = $self->contact_list(@_);
3279 foreach my $contact (@contacts) {
3280 foreach my $contact_email ($contact->contact_email) {
3281 push @emails, Email::Address->new( $contact->firstlast,
3282 $contact_email->emailaddress
3289 =item referral_custnum_cust_main
3291 Returns the customer who referred this customer (or the empty string, if
3292 this customer was not referred).
3294 Note the difference with referral_cust_main method: This method,
3295 referral_custnum_cust_main returns the single customer (if any) who referred
3296 this customer, while referral_cust_main returns an array of customers referred
3301 sub referral_custnum_cust_main {
3303 return '' unless $self->referral_custnum;
3304 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3307 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3309 Returns an array of customers referred by this customer (referral_custnum set
3310 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3311 customers referred by customers referred by this customer and so on, inclusive.
3312 The default behavior is DEPTH 1 (no recursion).
3314 Note the difference with referral_custnum_cust_main method: This method,
3315 referral_cust_main, returns an array of customers referred BY this customer,
3316 while referral_custnum_cust_main returns the single customer (if any) who
3317 referred this customer.
3321 sub referral_cust_main {
3323 my $depth = @_ ? shift : 1;
3324 my $exclude = @_ ? shift : {};
3327 map { $exclude->{$_->custnum}++; $_; }
3328 grep { ! $exclude->{ $_->custnum } }
3329 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3333 map { $_->referral_cust_main($depth-1, $exclude) }
3340 =item referral_cust_main_ncancelled
3342 Same as referral_cust_main, except only returns customers with uncancelled
3347 sub referral_cust_main_ncancelled {
3349 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3352 =item referral_cust_pkg [ DEPTH ]
3354 Like referral_cust_main, except returns a flat list of all unsuspended (and
3355 uncancelled) packages for each customer. The number of items in this list may
3356 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3360 sub referral_cust_pkg {
3362 my $depth = @_ ? shift : 1;
3364 map { $_->unsuspended_pkgs }
3365 grep { $_->unsuspended_pkgs }
3366 $self->referral_cust_main($depth);
3369 =item referring_cust_main
3371 Returns the single cust_main record for the customer who referred this customer
3372 (referral_custnum), or false.
3376 sub referring_cust_main {
3378 return '' unless $self->referral_custnum;
3379 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3382 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3384 Applies a credit to this customer. If there is an error, returns the error,
3385 otherwise returns false.
3387 REASON can be a text string, an FS::reason object, or a scalar reference to
3388 a reasonnum. If a text string, it will be automatically inserted as a new
3389 reason, and a 'reason_type' option must be passed to indicate the
3390 FS::reason_type for the new reason.
3392 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3393 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3394 I<commission_pkgnum>.
3396 Any other options are passed to FS::cust_credit::insert.
3401 my( $self, $amount, $reason, %options ) = @_;
3403 my $cust_credit = new FS::cust_credit {
3404 'custnum' => $self->custnum,
3405 'amount' => $amount,
3408 if ( ref($reason) ) {
3410 if ( ref($reason) eq 'SCALAR' ) {
3411 $cust_credit->reasonnum( $$reason );
3413 $cust_credit->reasonnum( $reason->reasonnum );
3417 $cust_credit->set('reason', $reason)
3420 $cust_credit->$_( delete $options{$_} )
3421 foreach grep exists($options{$_}),
3422 qw( addlinfo eventnum ),
3423 map "commission_$_", qw( agentnum salesnum pkgnum );
3425 $cust_credit->insert(%options);
3429 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3431 Creates a one-time charge for this customer. If there is an error, returns
3432 the error, otherwise returns false.
3434 New-style, with a hashref of options:
3436 my $error = $cust_main->charge(
3440 'start_date' => str2time('7/4/2009'),
3441 'pkg' => 'Description',
3442 'comment' => 'Comment',
3443 'additional' => [], #extra invoice detail
3444 'classnum' => 1, #pkg_class
3446 'setuptax' => '', # or 'Y' for tax exempt
3448 'locationnum'=> 1234, # optional
3451 'taxclass' => 'Tax class',
3454 'taxproduct' => 2, #part_pkg_taxproduct
3455 'override' => {}, #XXX describe
3457 #will be filled in with the new object
3458 'cust_pkg_ref' => \$cust_pkg,
3460 #generate an invoice immediately
3462 'invoice_terms' => '', #with these terms
3468 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3472 #super false laziness w/quotation::charge
3475 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3476 my ( $pkg, $comment, $additional );
3477 my ( $setuptax, $taxclass ); #internal taxes
3478 my ( $taxproduct, $override ); #vendor (CCH) taxes
3480 my $separate_bill = '';
3481 my $cust_pkg_ref = '';
3482 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3484 my ( $discountnum, $discountnum_amount, $discountnum_percent ) = ( '','','' );
3485 if ( ref( $_[0] ) ) {
3486 $amount = $_[0]->{amount};
3487 $setup_cost = $_[0]->{setup_cost};
3488 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3489 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3490 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3491 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3492 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3493 : '$'. sprintf("%.2f",$amount);
3494 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3495 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3496 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3497 $additional = $_[0]->{additional} || [];
3498 $taxproduct = $_[0]->{taxproductnum};
3499 $override = { '' => $_[0]->{tax_override} };
3500 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3501 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3502 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3503 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3504 $separate_bill = $_[0]->{separate_bill} || '';
3505 $discountnum = $_[0]->{setup_discountnum};
3506 $discountnum_amount = $_[0]->{setup_discountnum_amount};
3507 $discountnum_percent = $_[0]->{setup_discountnum_percent};
3513 $pkg = @_ ? shift : 'One-time charge';
3514 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3516 $taxclass = @_ ? shift : '';
3520 local $SIG{HUP} = 'IGNORE';
3521 local $SIG{INT} = 'IGNORE';
3522 local $SIG{QUIT} = 'IGNORE';
3523 local $SIG{TERM} = 'IGNORE';
3524 local $SIG{TSTP} = 'IGNORE';
3525 local $SIG{PIPE} = 'IGNORE';
3527 my $oldAutoCommit = $FS::UID::AutoCommit;
3528 local $FS::UID::AutoCommit = 0;
3531 my $part_pkg = new FS::part_pkg ( {
3533 'comment' => $comment,
3537 'classnum' => ( $classnum ? $classnum : '' ),
3538 'setuptax' => $setuptax,
3539 'taxclass' => $taxclass,
3540 'taxproductnum' => $taxproduct,
3541 'setup_cost' => $setup_cost,
3544 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3545 ( 0 .. @$additional - 1 )
3547 'additional_count' => scalar(@$additional),
3548 'setup_fee' => $amount,
3551 my $error = $part_pkg->insert( options => \%options,
3552 tax_overrides => $override,
3555 $dbh->rollback if $oldAutoCommit;
3559 my $pkgpart = $part_pkg->pkgpart;
3560 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3561 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3562 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3563 $error = $type_pkgs->insert;
3565 $dbh->rollback if $oldAutoCommit;
3570 my $cust_pkg = new FS::cust_pkg ( {
3571 'custnum' => $self->custnum,
3572 'pkgpart' => $pkgpart,
3573 'quantity' => $quantity,
3574 'start_date' => $start_date,
3575 'no_auto' => $no_auto,
3576 'separate_bill' => $separate_bill,
3577 'locationnum' => $locationnum,
3578 'setup_discountnum' => $discountnum,
3579 'setup_discountnum_amount' => $discountnum_amount,
3580 'setup_discountnum_percent' => $discountnum_percent,
3583 $error = $cust_pkg->insert;
3585 $dbh->rollback if $oldAutoCommit;
3587 } elsif ( $cust_pkg_ref ) {
3588 ${$cust_pkg_ref} = $cust_pkg;
3592 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3593 'pkg_list' => [ $cust_pkg ],
3596 $dbh->rollback if $oldAutoCommit;
3601 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3606 #=item charge_postal_fee
3608 #Applies a one time charge this customer. If there is an error,
3609 #returns the error, returns the cust_pkg charge object or false
3610 #if there was no charge.
3614 # This should be a customer event. For that to work requires that bill
3615 # also be a customer event.
3617 sub charge_postal_fee {
3620 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3621 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3623 my $cust_pkg = new FS::cust_pkg ( {
3624 'custnum' => $self->custnum,
3625 'pkgpart' => $pkgpart,
3629 my $error = $cust_pkg->insert;
3630 $error ? $error : $cust_pkg;
3633 =item num_cust_attachment_deleted
3635 Returns the number of deleted attachments for this customer (see
3636 L<FS::num_cust_attachment>).
3640 sub num_cust_attachments_deleted {
3643 " SELECT COUNT(*) FROM cust_attachment ".
3644 " WHERE custnum = ? AND disabled IS NOT NULL AND disabled > 0",
3651 Returns the most recent invnum (invoice number) for this customer.
3658 " SELECT MAX(invnum) FROM cust_bill WHERE custnum = ?",
3663 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3665 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3667 Optionally, a list or hashref of additional arguments to the qsearch call can
3674 my $opt = ref($_[0]) ? shift : { @_ };
3676 #return $self->num_cust_bill unless wantarray || keys %$opt;
3678 $opt->{'table'} = 'cust_bill';
3679 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3680 $opt->{'hashref'}{'custnum'} = $self->custnum;
3681 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3683 map { $_ } #behavior of sort undefined in scalar context
3684 sort { $a->_date <=> $b->_date }
3688 =item open_cust_bill
3690 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3695 sub open_cust_bill {
3699 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3705 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3707 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3711 sub legacy_cust_bill {
3714 #return $self->num_legacy_cust_bill unless wantarray;
3716 map { $_ } #behavior of sort undefined in scalar context
3717 sort { $a->_date <=> $b->_date }
3718 qsearch({ 'table' => 'legacy_cust_bill',
3719 'hashref' => { 'custnum' => $self->custnum, },
3720 'order_by' => 'ORDER BY _date ASC',
3724 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3726 Returns all the statements (see L<FS::cust_statement>) for this customer.
3728 Optionally, a list or hashref of additional arguments to the qsearch call can
3733 =item cust_bill_void
3735 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3739 sub cust_bill_void {
3742 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3743 sort { $a->_date <=> $b->_date }
3744 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3747 sub cust_statement {
3749 my $opt = ref($_[0]) ? shift : { @_ };
3751 #return $self->num_cust_statement unless wantarray || keys %$opt;
3753 $opt->{'table'} = 'cust_statement';
3754 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3755 $opt->{'hashref'}{'custnum'} = $self->custnum;
3756 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3758 map { $_ } #behavior of sort undefined in scalar context
3759 sort { $a->_date <=> $b->_date }
3763 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3765 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3767 Optionally, a list or hashref of additional arguments to the qsearch call can
3768 be passed following the SVCDB.
3775 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3776 warn "$me svc_x requires a svcdb";
3779 my $opt = ref($_[0]) ? shift : { @_ };
3781 $opt->{'table'} = $svcdb;
3782 $opt->{'addl_from'} =
3783 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3784 ($opt->{'addl_from'} || '');
3786 my $custnum = $self->custnum;
3787 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3788 my $where = "cust_pkg.custnum = $custnum";
3790 my $extra_sql = $opt->{'extra_sql'} || '';
3791 if ( keys %{ $opt->{'hashref'} } ) {
3792 $extra_sql = " AND $where $extra_sql";
3795 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3796 $extra_sql = "WHERE $where AND $1";
3799 $extra_sql = "WHERE $where $extra_sql";
3802 $opt->{'extra_sql'} = $extra_sql;
3807 # required for use as an eventtable;
3810 $self->svc_x('svc_acct', @_);
3815 Returns all the credits (see L<FS::cust_credit>) for this customer.
3822 #return $self->num_cust_credit unless wantarray;
3824 map { $_ } #behavior of sort undefined in scalar context
3825 sort { $a->_date <=> $b->_date }
3826 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3829 =item cust_credit_pkgnum
3831 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3832 package when using experimental package balances.
3836 sub cust_credit_pkgnum {
3837 my( $self, $pkgnum ) = @_;
3838 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3839 sort { $a->_date <=> $b->_date }
3840 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3841 'pkgnum' => $pkgnum,
3846 =item cust_credit_void
3848 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3852 sub cust_credit_void {
3855 sort { $a->_date <=> $b->_date }
3856 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3861 Returns all the payments (see L<FS::cust_pay>) for this customer.
3867 my $opt = ref($_[0]) ? shift : { @_ };
3869 return $self->num_cust_pay unless wantarray || keys %$opt;
3871 $opt->{'table'} = 'cust_pay';
3872 $opt->{'hashref'}{'custnum'} = $self->custnum;
3874 map { $_ } #behavior of sort undefined in scalar context
3875 sort { $a->_date <=> $b->_date }
3882 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3883 called automatically when the cust_pay method is used in a scalar context.
3889 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3890 my $sth = dbh->prepare($sql) or die dbh->errstr;
3891 $sth->execute($self->custnum) or die $sth->errstr;
3892 $sth->fetchrow_arrayref->[0];
3895 =item unapplied_cust_pay
3897 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3901 sub unapplied_cust_pay {
3905 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3911 =item cust_pay_pkgnum
3913 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3914 package when using experimental package balances.
3918 sub cust_pay_pkgnum {
3919 my( $self, $pkgnum ) = @_;
3920 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3921 sort { $a->_date <=> $b->_date }
3922 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3923 'pkgnum' => $pkgnum,
3930 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3936 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3937 sort { $a->_date <=> $b->_date }
3938 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3941 =item cust_pay_pending
3943 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3944 (without status "done").
3948 sub cust_pay_pending {
3950 return $self->num_cust_pay_pending unless wantarray;
3951 sort { $a->_date <=> $b->_date }
3952 qsearch( 'cust_pay_pending', {
3953 'custnum' => $self->custnum,
3954 'status' => { op=>'!=', value=>'done' },
3959 =item cust_pay_pending_attempt
3961 Returns all payment attempts / declined payments for this customer, as pending
3962 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3963 a corresponding payment (see L<FS::cust_pay>).
3967 sub cust_pay_pending_attempt {
3969 return $self->num_cust_pay_pending_attempt unless wantarray;
3970 sort { $a->_date <=> $b->_date }
3971 qsearch( 'cust_pay_pending', {
3972 'custnum' => $self->custnum,
3979 =item num_cust_pay_pending
3981 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3982 customer (without status "done"). Also called automatically when the
3983 cust_pay_pending method is used in a scalar context.
3987 sub num_cust_pay_pending {
3990 " SELECT COUNT(*) FROM cust_pay_pending ".
3991 " WHERE custnum = ? AND status != 'done' ",
3996 =item num_cust_pay_pending_attempt
3998 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3999 customer, with status "done" but without a corresp. Also called automatically when the
4000 cust_pay_pending method is used in a scalar context.
4004 sub num_cust_pay_pending_attempt {
4007 " SELECT COUNT(*) FROM cust_pay_pending ".
4008 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
4015 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4021 map { $_ } #return $self->num_cust_refund unless wantarray;
4022 sort { $a->_date <=> $b->_date }
4023 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4026 =item display_custnum
4028 Returns the displayed customer number for this customer: agent_custid if
4029 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
4033 sub display_custnum {
4036 return $self->agent_custid
4037 if $default_agent_custid && $self->agent_custid;
4039 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
4043 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
4044 } elsif ( $custnum_display_length ) {
4045 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
4047 return $self->custnum;
4053 Returns a name string for this customer, either "Company (Last, First)" or
4060 my $name = $self->contact;
4061 $name = $self->company. " ($name)" if $self->company;
4065 =item service_contact
4067 Returns the L<FS::contact> object for this customer that has the 'Service'
4068 contact class, or undef if there is no such contact. Deprecated; don't use
4073 sub service_contact {
4075 if ( !exists($self->{service_contact}) ) {
4076 my $classnum = $self->scalar_sql(
4077 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4078 ) || 0; #if it's zero, qsearchs will return nothing
4079 my $cust_contact = qsearchs('cust_contact', {
4080 'classnum' => $classnum,
4081 'custnum' => $self->custnum,
4083 $self->{service_contact} = $cust_contact->contact if $cust_contact;
4085 $self->{service_contact};
4090 Returns a name string for this (service/shipping) contact, either
4091 "Company (Last, First)" or "Last, First".
4098 my $name = $self->ship_contact;
4099 $name = $self->company. " ($name)" if $self->company;
4105 Returns a name string for this customer, either "Company" or "First Last".
4111 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4114 =item ship_name_short
4116 Returns a name string for this (service/shipping) contact, either "Company"
4121 sub ship_name_short {
4123 $self->service_contact
4124 ? $self->ship_contact_firstlast
4130 Returns this customer's full (billing) contact name only, "Last, First"
4136 $self->get('last'). ', '. $self->first;
4141 Returns this customer's full (shipping) contact name only, "Last, First"
4147 my $contact = $self->service_contact || $self;
4148 $contact->get('last') . ', ' . $contact->get('first');
4151 =item contact_firstlast
4153 Returns this customers full (billing) contact name only, "First Last".
4157 sub contact_firstlast {
4159 $self->first. ' '. $self->get('last');
4162 =item ship_contact_firstlast
4164 Returns this customer's full (shipping) contact name only, "First Last".
4168 sub ship_contact_firstlast {
4170 my $contact = $self->service_contact || $self;
4171 $contact->get('first') . ' '. $contact->get('last');
4174 sub bill_country_full {
4176 $self->bill_location->country_full;
4179 sub ship_country_full {
4181 $self->ship_location->country_full;
4184 =item county_state_county [ PREFIX ]
4186 Returns a string consisting of just the county, state and country.
4190 sub county_state_country {
4193 if ( @_ && $_[0] && $self->has_ship_address ) {
4194 $locationnum = $self->ship_locationnum;
4196 $locationnum = $self->bill_locationnum;
4198 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4199 $cust_location->county_state_country;
4202 =item geocode DATA_VENDOR
4204 Returns a value for the customer location as encoded by DATA_VENDOR.
4205 Currently this only makes sense for "CCH" as DATA_VENDOR.
4213 Returns a status string for this customer, currently:
4219 No packages have ever been ordered. Displayed as "No packages".
4223 Recurring packages all are new (not yet billed).
4227 One or more recurring packages is active.
4231 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
4235 All non-cancelled recurring packages are suspended.
4239 All recurring packages are cancelled.
4243 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4244 cust_main-status_module configuration option.
4248 sub status { shift->cust_status(@_); }
4252 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4253 for my $status ( FS::cust_main->statuses() ) {
4254 my $method = $status.'_sql';
4255 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4256 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4257 $sth->execute( ($self->custnum) x $numnum )
4258 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4259 if ( $sth->fetchrow_arrayref->[0] ) {
4260 $self->hashref->{cust_status} = $status;
4266 =item is_status_delay_cancel
4268 Returns true if customer status is 'suspended'
4269 and all suspended cust_pkg return true for
4270 cust_pkg->is_status_delay_cancel.
4272 This is not a real status, this only meant for hacking display
4273 values, because otherwise treating the customer as suspended is
4274 really the whole point of the delay_cancel option.
4278 sub is_status_delay_cancel {
4280 return 0 unless $self->status eq 'suspended';
4281 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4282 return 0 unless $cust_pkg->is_status_delay_cancel;
4287 =item ucfirst_cust_status
4289 =item ucfirst_status
4291 Deprecated, use the cust_status_label method instead.
4293 Returns the status with the first character capitalized.
4297 sub ucfirst_status {
4298 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4299 local($ucfirst_nowarn) = 1;
4300 shift->ucfirst_cust_status(@_);
4303 sub ucfirst_cust_status {
4304 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4306 ucfirst($self->cust_status);
4309 =item cust_status_label
4313 Returns the display label for this status.
4317 sub status_label { shift->cust_status_label(@_); }
4319 sub cust_status_label {
4321 __PACKAGE__->statuslabels->{$self->cust_status};
4326 Returns a hex triplet color string for this customer's status.
4330 sub statuscolor { shift->cust_statuscolor(@_); }
4332 sub cust_statuscolor {
4334 __PACKAGE__->statuscolors->{$self->cust_status};
4337 =item tickets [ STATUS ]
4339 Returns an array of hashes representing the customer's RT tickets.
4341 An optional status (or arrayref or hashref of statuses) may be specified.
4347 my $status = ( @_ && $_[0] ) ? shift : '';
4349 my $num = $conf->config('cust_main-max_tickets') || 10;
4352 if ( $conf->config('ticket_system') ) {
4353 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4355 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4364 foreach my $priority (
4365 $conf->config('ticket_system-custom_priority_field-values'), ''
4367 last if scalar(@tickets) >= $num;
4369 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4370 $num - scalar(@tickets),
4381 =item appointments [ STATUS ]
4383 Returns an array of hashes representing the customer's RT tickets which
4390 my $status = ( @_ && $_[0] ) ? shift : '';
4392 return () unless $conf->config('ticket_system');
4394 my $queueid = $conf->config('ticket_system-appointment-queueid');
4396 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4405 # Return services representing svc_accts in customer support packages
4406 sub support_services {
4408 my %packages = map { $_ => 1 } $conf->config('support_packages');
4410 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4411 grep { $_->part_svc->svcdb eq 'svc_acct' }
4412 map { $_->cust_svc }
4413 grep { exists $packages{ $_->pkgpart } }
4414 $self->ncancelled_pkgs;
4418 # Return a list of latitude/longitude for one of the services (if any)
4419 sub service_coordinates {
4423 grep { $_->latitude && $_->longitude }
4425 map { $_->cust_svc }
4426 $self->ncancelled_pkgs;
4428 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4433 Returns a masked version of the named field
4438 my ($self,$field) = @_;
4442 'x'x(length($self->getfield($field))-4).
4443 substr($self->getfield($field), (length($self->getfield($field))-4));
4447 =item payment_history
4449 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4450 cust_credit and cust_refund objects. Each hashref has the following fields:
4452 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4454 I<date> - value of _date field, unix timestamp
4456 I<date_pretty> - user-friendly date
4458 I<description> - user-friendly description of item
4460 I<amount> - impact of item on user's balance
4461 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4462 Not to be confused with the native 'amount' field in cust_credit, see below.
4464 I<amount_pretty> - includes money char
4466 I<balance> - customer balance, chronologically as of this item
4468 I<balance_pretty> - includes money char
4470 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4472 I<paid> - amount paid for cust_pay records, undef for other types
4474 I<credit> - amount credited for cust_credit records, undef for other types.
4475 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4477 I<refund> - amount refunded for cust_refund records, undef for other types
4479 The four table-specific keys always have positive values, whether they reflect charges or payments.
4481 The following options may be passed to this method:
4483 I<line_items> - if true, returns charges ('Line item') rather than invoices
4485 I<start_date> - unix timestamp, only include records on or after.
4486 If specified, an item of type 'Previous' will also be included.
4487 It does not have table-specific fields.
4489 I<end_date> - unix timestamp, only include records before
4491 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4493 I<conf> - optional already-loaded FS::Conf object.
4497 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4498 # and also for sending customer statements, which should both be kept customer-friendly.
4499 # If you add anything that shouldn't be passed on through the API or exposed
4500 # to customers, add a new option to include it, don't include it by default
4501 sub payment_history {
4503 my $opt = ref($_[0]) ? $_[0] : { @_ };
4505 my $conf = $$opt{'conf'} || new FS::Conf;
4506 my $money_char = $conf->config("money_char") || '$',
4508 #first load entire history,
4509 #need previous to calculate previous balance
4510 #loading after end_date shouldn't hurt too much?
4512 if ( $$opt{'line_items'} ) {
4514 foreach my $cust_bill ( $self->cust_bill ) {
4517 'type' => 'Line item',
4518 'description' => $_->desc( $self->locale ).
4519 ( $_->sdate && $_->edate
4520 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4521 ' To '. time2str('%d-%b-%Y', $_->edate)
4524 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4525 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4526 'date' => $cust_bill->_date,
4527 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4529 foreach $cust_bill->cust_bill_pkg;
4536 'type' => 'Invoice',
4537 'description' => 'Invoice #'. $_->display_invnum,
4538 'amount' => sprintf('%.2f', $_->charged ),
4539 'charged' => sprintf('%.2f', $_->charged ),
4540 'date' => $_->_date,
4541 'date_pretty' => $self->time2str_local('short', $_->_date ),
4543 foreach $self->cust_bill;
4548 'type' => 'Payment',
4549 'description' => 'Payment', #XXX type
4550 'amount' => sprintf('%.2f', 0 - $_->paid ),
4551 'paid' => sprintf('%.2f', $_->paid ),
4552 'date' => $_->_date,
4553 'date_pretty' => $self->time2str_local('short', $_->_date ),
4555 foreach $self->cust_pay;
4559 'description' => 'Credit', #more info?
4560 'amount' => sprintf('%.2f', 0 -$_->amount ),
4561 'credit' => sprintf('%.2f', $_->amount ),
4562 'date' => $_->_date,
4563 'date_pretty' => $self->time2str_local('short', $_->_date ),
4565 foreach $self->cust_credit;
4569 'description' => 'Refund', #more info? type, like payment?
4570 'amount' => $_->refund,
4571 'refund' => $_->refund,
4572 'date' => $_->_date,
4573 'date_pretty' => $self->time2str_local('short', $_->_date ),
4575 foreach $self->cust_refund;
4577 #put it all in chronological order
4578 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4580 #calculate balance, filter items outside date range
4584 foreach my $item (@history) {
4585 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4586 $balance += $$item{'amount'};
4587 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4588 $previous += $$item{'amount'};
4591 $$item{'balance'} = sprintf("%.2f",$balance);
4592 foreach my $key ( qw(amount balance) ) {
4593 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4598 # start with previous balance, if there was one
4601 'type' => 'Previous',
4602 'description' => 'Previous balance',
4603 'amount' => sprintf("%.2f",$previous),
4604 'balance' => sprintf("%.2f",$previous),
4605 'date' => $$opt{'start_date'},
4606 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4608 #false laziness with above
4609 foreach my $key ( qw(amount balance) ) {
4610 $$item{$key.'_pretty'} = $$item{$key};
4611 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4613 unshift(@out,$item);
4616 @out = reverse @history if $$opt{'reverse_sort'};
4621 =item save_cust_payby
4623 Saves a new cust_payby for this customer, replacing an existing entry only
4624 in select circumstances. Does not validate input.
4626 If auto is specified, marks this as the customer's primary method, or the
4627 specified weight. Existing payment methods have their weight incremented as
4630 If bill_location is specified with auto, also sets location in cust_main.
4632 Will not insert complete duplicates of existing records, or records in which the
4633 only difference from an existing record is to turn off automatic payment (will
4634 return without error.) Will replace existing records in which the only difference
4635 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4636 Fields marked as preserved are optional, and existing values will not be overwritten with
4637 blanks when replacing.
4639 Accepts the following named parameters:
4649 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4653 optional, set higher than 1 for secondary, etc.
4661 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4669 optional, will be preserved when replacing
4677 CARD only, required, FS::cust_location object
4679 =item paystart_month
4681 CARD only, optional, will be preserved when replacing
4685 CARD only, optional, will be preserved when replacing
4689 CARD only, optional, will be preserved when replacing
4693 CARD only, only used if conf cvv-save is set appropriately
4703 =item saved_cust_payby
4705 scalar reference, for returning saved object
4711 #The code for this option is in place, but it's not currently used
4715 # existing cust_payby object to be replaced (must match custnum)
4717 # stateid/stateid_state/ss are not currently supported in cust_payby,
4718 # might not even work properly in 4.x, but will need to work here if ever added
4720 sub save_cust_payby {
4724 my $old = $opt{'replace'};
4725 my $new = new FS::cust_payby { $old ? $old->hash : () };
4726 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4727 $new->set( 'custnum' => $self->custnum );
4729 my $payby = $opt{'payment_payby'};
4730 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4732 # don't allow turning off auto when replacing
4733 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4735 my @check_existing; # payby relevant to this payment_payby
4737 # set payby based on auto
4738 if ( $payby eq 'CARD' ) {
4739 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4740 @check_existing = qw( CARD DCRD );
4741 } elsif ( $payby eq 'CHEK' ) {
4742 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4743 @check_existing = qw( CHEK DCHK );
4746 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4749 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4750 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4751 $new->set( 'payname' => $opt{'payname'} );
4752 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4754 my $conf = new FS::Conf;
4756 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4757 if ( $payby eq 'CARD' &&
4758 ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4759 || $conf->exists('business-onlinepayment-verification')
4762 $new->set( 'paycvv' => $opt{'paycvv'} );
4764 $new->set( 'paycvv' => '');
4767 local $SIG{HUP} = 'IGNORE';
4768 local $SIG{INT} = 'IGNORE';
4769 local $SIG{QUIT} = 'IGNORE';
4770 local $SIG{TERM} = 'IGNORE';
4771 local $SIG{TSTP} = 'IGNORE';
4772 local $SIG{PIPE} = 'IGNORE';
4774 my $oldAutoCommit = $FS::UID::AutoCommit;
4775 local $FS::UID::AutoCommit = 0;
4778 # set fields specific to payment_payby
4779 if ( $payby eq 'CARD' ) {
4780 if ($opt{'bill_location'}) {
4781 $opt{'bill_location'}->set('custnum' => $self->custnum);
4782 my $error = $opt{'bill_location'}->find_or_insert;
4784 $dbh->rollback if $oldAutoCommit;
4787 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4789 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4790 $new->set( $field => $opt{$field} );
4793 foreach my $field ( qw(paytype paystate) ) {
4794 $new->set( $field => $opt{$field} );
4798 # other cust_payby to compare this to
4799 my @existing = $self->cust_payby(@check_existing);
4801 # fields that can overwrite blanks with values, but not values with blanks
4802 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4804 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4806 # generally, we don't want to overwrite existing cust_payby with this,
4807 # but we can replace if we're only marking it auto or adding a preserved field
4808 # and we can avoid saving a total duplicate or merely turning off auto
4810 foreach my $cust_payby (@existing) {
4811 # check fields that absolutely should not change
4812 foreach my $field ($new->fields) {
4813 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4814 next if grep(/^$field$/, @preserve );
4815 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4817 # now check fields that can replace if one value is blank
4819 foreach my $field (@preserve) {
4821 ( $new->get($field) and !$cust_payby->get($field) ) or
4822 ( $cust_payby->get($field) and !$new->get($field) )
4824 # prevention of overwriting values with blanks happens farther below
4826 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4830 unless ( $replace ) {
4831 # nearly identical, now check weight
4832 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4833 # ignore identical cust_payby, and ignore attempts to turn off auto
4834 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4835 $skip_cust_payby = 1;
4838 # otherwise, only change is to mark this as primary
4840 # if we got this far, we're definitely replacing
4847 $new->set( 'custpaybynum' => $old->custpaybynum );
4848 # don't turn off automatic payment (but allow it to be turned on)
4849 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4851 $new->set( 'payby' => $old->payby );
4852 $new->set( 'weight' => 1 );
4854 # make sure we're not overwriting values with blanks
4855 foreach my $field (@preserve) {
4856 if ( $old->get($field) and !$new->get($field) ) {
4857 $new->set( $field => $old->get($field) );
4862 # only overwrite cust_main bill_location if auto
4863 if ($opt{'auto'} && $opt{'bill_location'}) {
4864 $self->set('bill_location' => $opt{'bill_location'});
4865 my $error = $self->replace;
4867 $dbh->rollback if $oldAutoCommit;
4872 # done with everything except reweighting and saving cust_payby
4873 # still need to commit changes to cust_main and cust_location
4874 if ($skip_cust_payby) {
4875 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4879 # re-weight existing primary cust_pay for this payby
4881 foreach my $cust_payby (@existing) {
4882 # relies on cust_payby return order
4883 last unless $cust_payby->payby !~ /^D/;
4884 last if $cust_payby->weight > 1;
4885 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4886 next if $cust_payby->weight < ($opt{'weight'} || 1);
4887 $cust_payby->weight( $cust_payby->weight + 1 );
4888 my $error = $cust_payby->replace;
4890 $dbh->rollback if $oldAutoCommit;
4891 return "Error reweighting cust_payby: $error";
4896 # finally, save cust_payby
4897 my $error = $old ? $new->replace($old) : $new->insert;
4899 $dbh->rollback if $oldAutoCommit;
4903 ${$opt{'saved_cust_payby'}} = $new
4904 if $opt{'saved_cust_payby'};
4906 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4911 =item remove_cvv_from_cust_payby PAYINFO
4913 Removes paycvv from associated cust_payby with matching PAYINFO.
4917 sub remove_cvv_from_cust_payby {
4918 my ($self,$payinfo) = @_;
4920 my $oldAutoCommit = $FS::UID::AutoCommit;
4921 local $FS::UID::AutoCommit = 0;
4924 foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
4925 next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
4926 $cust_payby->paycvv('');
4927 my $error = $cust_payby->replace;
4929 $dbh->rollback if $oldAutoCommit;
4934 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4940 =head1 CLASS METHODS
4946 Class method that returns the list of possible status strings for customers
4947 (see L<the status method|/status>). For example:
4949 @statuses = FS::cust_main->statuses();
4955 keys %{ $self->statuscolors };
4958 =item cust_status_sql
4960 Returns an SQL fragment to determine the status of a cust_main record, as a
4965 sub cust_status_sql {
4967 for my $status ( FS::cust_main->statuses() ) {
4968 my $method = $status.'_sql';
4969 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4978 Returns an SQL expression identifying prospective cust_main records (customers
4979 with no packages ever ordered)
4983 use vars qw($select_count_pkgs);
4984 $select_count_pkgs =
4985 "SELECT COUNT(*) FROM cust_pkg
4986 WHERE cust_pkg.custnum = cust_main.custnum";
4988 sub select_count_pkgs_sql {
4993 " 0 = ( $select_count_pkgs ) ";
4998 Returns an SQL expression identifying ordered cust_main records (customers with
4999 no active packages, but recurring packages not yet setup or one time charges
5005 FS::cust_main->none_active_sql.
5006 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
5011 Returns an SQL expression identifying active cust_main records (customers with
5012 active recurring packages).
5017 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
5020 =item none_active_sql
5022 Returns an SQL expression identifying cust_main records with no active
5023 recurring packages. This includes customers of status prospect, ordered,
5024 inactive, and suspended.
5028 sub none_active_sql {
5029 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
5034 Returns an SQL expression identifying inactive cust_main records (customers with
5035 no active recurring packages, but otherwise unsuspended/uncancelled).
5040 FS::cust_main->none_active_sql.
5041 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
5047 Returns an SQL expression identifying suspended cust_main records.
5052 sub suspended_sql { susp_sql(@_); }
5054 FS::cust_main->none_active_sql.
5055 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
5061 Returns an SQL expression identifying cancelled cust_main records.
5065 sub cancel_sql { shift->cancelled_sql(@_); }
5068 =item uncancelled_sql
5070 Returns an SQL expression identifying un-cancelled cust_main records.
5074 sub uncancelled_sql { uncancel_sql(@_); }
5077 "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
5082 Returns an SQL fragment to retreive the balance.
5087 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5088 WHERE cust_bill.custnum = cust_main.custnum )
5089 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5090 WHERE cust_pay.custnum = cust_main.custnum )
5091 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5092 WHERE cust_credit.custnum = cust_main.custnum )
5093 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5094 WHERE cust_refund.custnum = cust_main.custnum )
5097 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
5099 Returns an SQL fragment to retreive the balance for this customer, optionally
5100 considering invoices with date earlier than START_TIME, and not
5101 later than END_TIME (total_owed_date minus total_unapplied_credits minus
5102 total_unapplied_payments).
5104 Times are specified as SQL fragments or numeric
5105 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5106 L<Date::Parse> for conversion functions. The empty string can be passed
5107 to disable that time constraint completely.
5109 Available options are:
5113 =item unapplied_date
5115 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)
5120 set to true to remove all customer comparison clauses, for totals
5125 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5130 JOIN clause (typically used with the total option)
5134 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
5135 time will be ignored. Note that START_TIME and END_TIME only limit the date
5136 range for invoices and I<unapplied> payments, credits, and refunds.
5142 sub balance_date_sql {
5143 my( $class, $start, $end, %opt ) = @_;
5145 my $cutoff = $opt{'cutoff'};
5147 my $owed = FS::cust_bill->owed_sql($cutoff);
5148 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
5149 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
5150 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5152 my $j = $opt{'join'} || '';
5154 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5155 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5156 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5157 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5159 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5160 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5161 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5162 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5167 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
5169 Returns an SQL fragment to retreive the total unapplied payments for this
5170 customer, only considering payments with date earlier than START_TIME, and
5171 optionally not later than END_TIME.
5173 Times are specified as SQL fragments or numeric
5174 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5175 L<Date::Parse> for conversion functions. The empty string can be passed
5176 to disable that time constraint completely.
5178 Available options are:
5182 sub unapplied_payments_date_sql {
5183 my( $class, $start, $end, %opt ) = @_;
5185 my $cutoff = $opt{'cutoff'};
5187 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5189 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
5190 'unapplied_date'=>1 );
5192 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
5195 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5197 Helper method for balance_date_sql; name (and usage) subject to change
5198 (suggestions welcome).
5200 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5201 cust_refund, cust_credit or cust_pay).
5203 If TABLE is "cust_bill" or the unapplied_date option is true, only
5204 considers records with date earlier than START_TIME, and optionally not
5205 later than END_TIME .
5209 sub _money_table_where {
5210 my( $class, $table, $start, $end, %opt ) = @_;
5213 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5214 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5215 push @where, "$table._date <= $start" if defined($start) && length($start);
5216 push @where, "$table._date > $end" if defined($end) && length($end);
5218 push @where, @{$opt{'where'}} if $opt{'where'};
5219 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5225 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
5226 use FS::cust_main::Search;
5229 FS::cust_main::Search->search(@_);
5238 #=item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5240 #Deprecated. Use event notification and message templates
5241 #(L<FS::msg_template>) instead.
5243 #Sends a templated email notification to the customer (see L<Text::Template>).
5245 #OPTIONS is a hash and may include
5247 #I<from> - the email sender (default is invoice_from)
5249 #I<to> - comma-separated scalar or arrayref of recipients
5250 # (default is invoicing_list)
5252 #I<subject> - The subject line of the sent email notification
5253 # (default is "Notice from company_name")
5255 #I<extra_fields> - a hashref of name/value pairs which will be substituted
5258 #The following variables are vavailable in the template.
5260 #I<$first> - the customer first name
5261 #I<$last> - the customer last name
5262 #I<$company> - the customer company
5263 #I<$payby> - a description of the method of payment for the customer
5264 # # would be nice to use FS::payby::shortname
5265 #I<$payinfo> - the account information used to collect for this customer
5266 #I<$expdate> - the expiration of the customer payment in seconds from epoch
5271 # my ($self, $template, %options) = @_;
5273 # return unless $conf->exists($template);
5275 # my $from = $conf->invoice_from_full($self->agentnum)
5276 # if $conf->exists('invoice_from', $self->agentnum);
5277 # $from = $options{from} if exists($options{from});
5279 # my $to = join(',', $self->invoicing_list_emailonly);
5280 # $to = $options{to} if exists($options{to});
5282 # my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
5283 # if $conf->exists('company_name', $self->agentnum);
5284 # $subject = $options{subject} if exists($options{subject});
5286 # my $notify_template = new Text::Template (TYPE => 'ARRAY',
5287 # SOURCE => [ map "$_\n",
5288 # $conf->config($template)]
5290 # or die "can't create new Text::Template object: Text::Template::ERROR";
5291 # $notify_template->compile()
5292 # or die "can't compile template: Text::Template::ERROR";
5294 # $FS::notify_template::_template::company_name =
5295 # $conf->config('company_name', $self->agentnum);
5296 # $FS::notify_template::_template::company_address =
5297 # join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
5299 # my $paydate = $self->paydate || '2037-12-31';
5300 # $FS::notify_template::_template::first = $self->first;
5301 # $FS::notify_template::_template::last = $self->last;
5302 # $FS::notify_template::_template::company = $self->company;
5303 # $FS::notify_template::_template::payinfo = $self->mask_payinfo;
5304 # my $payby = $self->payby;
5305 # my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5306 # my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5308 # #credit cards expire at the end of the month/year of their exp date
5309 # if ($payby eq 'CARD' || $payby eq 'DCRD') {
5310 # $FS::notify_template::_template::payby = 'credit card';
5311 # ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5312 # $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5314 # }elsif ($payby eq 'COMP') {
5315 # $FS::notify_template::_template::payby = 'complimentary account';
5317 # $FS::notify_template::_template::payby = 'current method';
5319 # $FS::notify_template::_template::expdate = $expire_time;
5321 # for (keys %{$options{extra_fields}}){
5323 # ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5326 # send_email(from => $from,
5328 # subject => $subject,
5329 # body => $notify_template->fill_in( PACKAGE =>
5330 # 'FS::notify_template::_template' ),
5335 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5337 Generates a templated notification to the customer (see L<Text::Template>).
5339 OPTIONS is a hash and may include
5341 I<extra_fields> - a hashref of name/value pairs which will be substituted
5342 into the template. These values may override values mentioned below
5343 and those from the customer record.
5345 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5347 The following variables are available in the template instead of or in addition
5348 to the fields of the customer record.
5350 I<$payby> - a description of the method of payment for the customer
5351 # would be nice to use FS::payby::shortname
5352 I<$payinfo> - the masked account information used to collect for this customer
5353 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5354 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5358 # a lot like cust_bill::print_latex
5359 sub generate_letter {
5360 my ($self, $template, %options) = @_;
5362 warn "Template $template does not exist" && return
5363 unless $conf->exists($template) || $options{'template_text'};
5365 my $template_source = $options{'template_text'}
5366 ? [ $options{'template_text'} ]
5367 : [ map "$_\n", $conf->config($template) ];
5369 my $letter_template = new Text::Template
5371 SOURCE => $template_source,
5372 DELIMITERS => [ '[@--', '--@]' ],
5374 or die "can't create new Text::Template object: Text::Template::ERROR";
5376 $letter_template->compile()
5377 or die "can't compile template: Text::Template::ERROR";
5379 my %letter_data = map { $_ => $self->$_ } $self->fields;
5380 $letter_data{payinfo} = $self->mask_payinfo;
5382 #my $paydate = $self->paydate || '2037-12-31';
5383 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
5385 my $payby = $self->payby;
5386 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5387 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5389 #credit cards expire at the end of the month/year of their exp date
5390 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5391 $letter_data{payby} = 'credit card';
5392 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5393 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5395 }elsif ($payby eq 'COMP') {
5396 $letter_data{payby} = 'complimentary account';
5398 $letter_data{payby} = 'current method';
5400 $letter_data{expdate} = $expire_time;
5402 for (keys %{$options{extra_fields}}){
5403 $letter_data{$_} = $options{extra_fields}->{$_};
5406 unless(exists($letter_data{returnaddress})){
5407 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5408 $self->agent_template)
5410 if ( length($retadd) ) {
5411 $letter_data{returnaddress} = $retadd;
5412 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5413 $letter_data{returnaddress} =
5414 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5418 ( $conf->config('company_name', $self->agentnum),
5419 $conf->config('company_address', $self->agentnum),
5423 $letter_data{returnaddress} = '~';
5427 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5429 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5431 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5433 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5437 ) or die "can't open temp file: $!\n";
5438 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5439 or die "can't write temp file: $!\n";
5441 $letter_data{'logo_file'} = $lh->filename;
5443 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5447 ) or die "can't open temp file: $!\n";
5449 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5451 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5452 return ($1, $letter_data{'logo_file'});
5456 =item print_ps TEMPLATE
5458 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5464 my($file, $lfile) = $self->generate_letter(@_);
5465 my $ps = FS::Misc::generate_ps($file);
5466 unlink($file.'.tex');
5472 =item print TEMPLATE
5474 Prints the filled in template.
5476 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5480 sub queueable_print {
5483 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5484 or die "invalid customer number: " . $opt{custnum};
5486 #do not backport this change to 3.x
5487 # my $error = $self->print( { 'template' => $opt{template} } );
5488 my $error = $self->print( $opt{'template'} );
5489 die $error if $error;
5493 my ($self, $template) = (shift, shift);
5495 [ $self->print_ps($template) ],
5496 'agentnum' => $self->agentnum,
5500 #these three subs should just go away once agent stuff is all config overrides
5502 sub agent_template {
5504 $self->_agent_plandata('agent_templatename');
5507 sub agent_invoice_from {
5509 $self->_agent_plandata('agent_invoice_from');
5512 sub _agent_plandata {
5513 my( $self, $option ) = @_;
5515 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5516 #agent-specific Conf
5518 use FS::part_event::Condition;
5520 my $agentnum = $self->agentnum;
5522 my $regexp = regexp_sql();
5524 my $part_event_option =
5526 'select' => 'part_event_option.*',
5527 'table' => 'part_event_option',
5529 LEFT JOIN part_event USING ( eventpart )
5530 LEFT JOIN part_event_option AS peo_agentnum
5531 ON ( part_event.eventpart = peo_agentnum.eventpart
5532 AND peo_agentnum.optionname = 'agentnum'
5533 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5535 LEFT JOIN part_event_condition
5536 ON ( part_event.eventpart = part_event_condition.eventpart
5537 AND part_event_condition.conditionname = 'cust_bill_age'
5539 LEFT JOIN part_event_condition_option
5540 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5541 AND part_event_condition_option.optionname = 'age'
5544 #'hashref' => { 'optionname' => $option },
5545 #'hashref' => { 'part_event_option.optionname' => $option },
5547 " WHERE part_event_option.optionname = ". dbh->quote($option).
5548 " AND action = 'cust_bill_send_agent' ".
5549 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5550 " AND peo_agentnum.optionname = 'agentnum' ".
5551 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5553 CASE WHEN part_event_condition_option.optionname IS NULL
5555 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5557 , part_event.weight".
5561 unless ( $part_event_option ) {
5562 return $self->agent->invoice_template || ''
5563 if $option eq 'agent_templatename';
5567 $part_event_option->optionvalue;
5571 sub process_o2m_qsearch {
5574 return qsearch($table, @_) unless $table eq 'contact';
5576 my $hashref = shift;
5577 my %hash = %$hashref;
5578 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5579 or die 'guru meditation #4343';
5581 qsearch({ 'table' => 'contact',
5582 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5583 'hashref' => \%hash,
5584 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5585 " cust_contact.custnum = $custnum "
5589 sub process_o2m_qsearchs {
5592 return qsearchs($table, @_) unless $table eq 'contact';
5594 my $hashref = shift;
5595 my %hash = %$hashref;
5596 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5597 or die 'guru meditation #2121';
5599 qsearchs({ 'table' => 'contact',
5600 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5601 'hashref' => \%hash,
5602 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5603 " cust_contact.custnum = $custnum "
5607 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5609 Subroutine (not a method), designed to be called from the queue.
5611 Takes a list of options and values.
5613 Pulls up the customer record via the custnum option and calls bill_and_collect.
5618 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5620 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5621 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5623 #without this errors don't get rolled back
5624 $args{'fatal'} = 1; # runs from job queue, will be caught
5626 $cust_main->bill_and_collect( %args );
5629 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5631 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5632 C<collect> part. This is used in batch tax calculation, where invoice
5633 generation and collection events have to be completely separated.
5637 sub queued_collect {
5639 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5641 $cust_main->collect(%args);
5644 sub process_bill_and_collect {
5647 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5648 or die "custnum '$param->{custnum}' not found!\n";
5649 $param->{'job'} = $job;
5650 $param->{'fatal'} = 1; # runs from job queue, will be caught
5651 $param->{'retry'} = 1;
5653 $cust_main->bill_and_collect( %$param );
5656 #starting to take quite a while for big dbs
5657 # (JRNL: journaled so it only happens once per database)
5658 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5659 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5660 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5661 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5662 # JRNL leading/trailing spaces in first, last, company
5663 # JRNL migrate to cust_payby
5664 # - otaker upgrade? journal and call it good? (double check to make sure
5665 # we're not still setting otaker here)
5667 #only going to get worse with new location stuff...
5669 sub _upgrade_data { #class method
5670 my ($class, %opts) = @_;
5673 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5676 #this seems to be the only expensive one.. why does it take so long?
5677 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5679 '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';
5680 FS::upgrade_journal->set_done('cust_main__signupdate');
5683 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5685 # fix yyyy-m-dd formatted paydates
5686 if ( driver_name =~ /^mysql/i ) {
5688 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5689 } else { # the SQL standard
5691 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5693 FS::upgrade_journal->set_done('cust_main__paydate');
5696 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5698 push @statements, #fix the weird BILL with a cc# in payinfo problem
5700 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5702 FS::upgrade_journal->set_done('cust_main__payinfo');
5707 foreach my $sql ( @statements ) {
5708 my $sth = dbh->prepare($sql) or die dbh->errstr;
5709 $sth->execute or die $sth->errstr;
5710 #warn ( (time - $t). " seconds\n" );
5714 local($ignore_expired_card) = 1;
5715 local($ignore_banned_card) = 1;
5716 local($skip_fuzzyfiles) = 1;
5717 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5719 unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5721 #we don't want to decrypt them, just stuff them as-is into cust_payby
5722 local(@encrypted_fields) = ();
5724 local($FS::cust_payby::ignore_expired_card) = 1;
5725 local($FS::cust_payby::ignore_banned_card) = 1;
5726 local($FS::cust_payby::ignore_cardtype) = 1;
5728 my @payfields = qw( payby payinfo paycvv paymask
5729 paydate paystart_month paystart_year payissue
5730 payname paystate paytype payip
5733 my $search = new FS::Cursor {
5734 'table' => 'cust_main',
5735 'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5738 while (my $cust_main = $search->fetch) {
5740 unless ( $cust_main->payby =~ /^(BILL|COMP)$/ ) {
5742 my $cust_payby = new FS::cust_payby {
5743 'custnum' => $cust_main->custnum,
5745 map { $_ => $cust_main->$_(); } @payfields
5748 my $error = $cust_payby->insert;
5749 die $error if $error;
5753 # at the time we do this, also migrate paytype into cust_pay_batch
5754 # so that batches that are open before the migration can still be
5756 my @cust_pay_batch = qsearch('cust_pay_batch', {
5757 'custnum' => $cust_main->custnum,
5761 foreach my $cust_pay_batch (@cust_pay_batch) {
5762 $cust_pay_batch->set('paytype', $cust_main->get('paytype'));
5763 my $error = $cust_pay_batch->replace;
5764 die "$error (setting cust_pay_batch.paytype)" if $error;
5767 $cust_main->complimentary('Y') if $cust_main->payby eq 'COMP';
5769 $cust_main->invoice_attn( $cust_main->payname )
5770 if $cust_main->payby eq 'BILL' && $cust_main->payname;
5771 $cust_main->po_number( $cust_main->payinfo )
5772 if $cust_main->payby eq 'BILL' && $cust_main->payinfo;
5774 $cust_main->setfield($_, '') foreach @payfields;
5775 my $error = $cust_main->replace;
5776 die "Error upgradging payment information for custnum ".
5777 $cust_main->custnum. ": $error"
5782 FS::upgrade_journal->set_done('cust_main__cust_payby');
5785 FS::cust_main::Location->_upgrade_data(%opts);
5787 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5789 foreach my $cust_main ( qsearch({
5790 'table' => 'cust_main',
5792 'extra_sql' => 'WHERE '.
5794 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5795 qw( first last company )
5798 my $error = $cust_main->replace;
5799 die $error if $error;
5802 FS::upgrade_journal->set_done('cust_main__trimspaces');
5806 $class->_upgrade_otaker(%opts);
5808 # turn on encryption as part of regular upgrade, so all new records are immediately encrypted
5809 # existing records will be encrypted in queueable_upgrade (below)
5810 unless ($conf->exists('encryptionpublickey') || $conf->exists('encryptionprivatekey')) {
5811 eval "use FS::Setup";
5813 FS::Setup::enable_encryption();
5818 sub queueable_upgrade {
5821 ### encryption gets turned on in _upgrade_data, above
5823 eval "use FS::upgrade_journal";
5826 # prior to 2013 (commit f16665c9) payinfo was stored in history if not encrypted,
5827 # clear that out before encrypting/tokenizing anything else
5828 if (!FS::upgrade_journal->is_done('clear_payinfo_history')) {
5829 foreach my $table ('cust_payby','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
5830 my $sql = 'UPDATE h_'.$table.' SET payinfo = NULL WHERE payinfo IS NOT NULL';
5831 my $sth = dbh->prepare($sql) or die dbh->errstr;
5832 $sth->execute or die $sth->errstr;
5834 FS::upgrade_journal->set_done('clear_payinfo_history');
5837 # fix Tokenized paycardtype and encrypt old records
5838 if ( ! FS::upgrade_journal->is_done('paycardtype_Tokenized')
5839 || ! FS::upgrade_journal->is_done('encryption_check')
5843 # allow replacement of closed cust_pay/cust_refund records
5844 local $FS::payinfo_Mixin::allow_closed_replace = 1;
5846 # because it looks like nothing's changing
5847 local $FS::Record::no_update_diff = 1;
5849 # commit everything immediately
5850 local $FS::UID::AutoCommit = 1;
5852 # encrypt what's there
5853 foreach my $table ('cust_payby','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
5854 my $tclass = 'FS::'.$table;
5857 while (my $recnum = _upgrade_next_recnum(dbh,$table,\$lastrecnum,\@recnums)) {
5858 my $record = $tclass->by_key($recnum);
5859 next unless $record; # small chance it's been deleted, that's ok
5860 next unless grep { $record->payby eq $_ } @FS::Record::encrypt_payby;
5861 # window for possible conflict is practically nonexistant,
5862 # but just in case...
5863 $record = $record->select_for_update;
5864 if (!$record->custnum && $table eq 'cust_pay_pending') {
5865 $record->set('custnum_pending',1);
5867 $record->paycardtype('') if $record->paycardtype eq 'Tokenized';
5869 local($ignore_expired_card) = 1;
5870 local($ignore_banned_card) = 1;
5871 local($skip_fuzzyfiles) = 1;
5872 local($import) = 1;#prevent automatic geocoding (need its own variable?)
5874 my $error = $record->replace;
5875 die "Error replacing $table ".$record->get($record->primary_key).": $error" if $error;
5879 FS::upgrade_journal->set_done('paycardtype_Tokenized');
5880 FS::upgrade_journal->set_done('encryption_check') if $conf->exists('encryption');
5883 # now that everything's encrypted, tokenize...
5884 FS::cust_main::Billing_Realtime::token_check(@_);
5887 # not entirely false laziness w/ Billing_Realtime::_token_check_next_recnum
5888 # cust_payby might get deleted while this runs
5890 sub _upgrade_next_recnum {
5891 my ($dbh,$table,$lastrecnum,$recnums) = @_;
5892 my $recnum = shift @$recnums;
5893 return $recnum if $recnum;
5894 my $tclass = 'FS::'.$table;
5895 my $paycardtypecheck = ($table ne 'cust_pay_pending') ? q( OR paycardtype = 'Tokenized') : '';
5896 my $sql = 'SELECT '.$tclass->primary_key.
5898 ' WHERE '.$tclass->primary_key.' > '.$$lastrecnum.
5899 " AND payby IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
5900 " AND ( length(payinfo) < 80$paycardtypecheck ) ".
5901 ' ORDER BY '.$tclass->primary_key.' LIMIT 500';
5902 my $sth = $dbh->prepare($sql) or die $dbh->errstr;
5903 $sth->execute() or die $sth->errstr;
5905 while (my $rec = $sth->fetchrow_hashref) {
5906 push @$recnums, $rec->{$tclass->primary_key};
5909 $$lastrecnum = $$recnums[-1];
5910 return shift @$recnums;
5919 The delete method should possibly take an FS::cust_main object reference
5920 instead of a scalar customer number.
5922 Bill and collect options should probably be passed as references instead of a
5925 There should probably be a configuration file with a list of allowed credit
5928 No multiple currency support (probably a larger project than just this module).
5930 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5932 Birthdates rely on negative epoch values.
5934 The payby for card/check batches is broken. With mixed batching, bad
5937 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5941 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5942 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5943 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.