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
23 use Scalar::Util qw( blessed );
24 use Time::Local qw(timelocal);
29 use File::Temp; #qw( tempfile );
30 use Business::CreditCard 0.28;
31 use List::Util qw(min);
32 use FS::UID qw( dbh driver_name );
33 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
35 use FS::Misc qw( generate_ps do_print money_pretty card_types );
36 use FS::Msgcat qw(gettext);
43 use FS::cust_bill_void;
44 use FS::legacy_cust_bill;
46 use FS::cust_pay_pending;
47 use FS::cust_pay_void;
48 use FS::cust_pay_batch;
51 use FS::part_referral;
52 use FS::cust_main_county;
53 use FS::cust_location;
56 use FS::cust_main_exemption;
57 use FS::cust_tax_adjustment;
58 use FS::cust_tax_location;
59 use FS::agent_currency;
60 use FS::cust_main_invoice;
62 use FS::prepay_credit;
68 use FS::payment_gateway;
69 use FS::agent_payment_gateway;
71 use FS::cust_main_note;
72 use FS::cust_attachment;
75 use FS::upgrade_journal;
80 # 1 is mostly method/subroutine entry and options
81 # 2 traces progress of some operations
82 # 3 is even more information including possibly sensitive data
84 our $me = '[FS::cust_main]';
87 our $ignore_expired_card = 0;
88 our $ignore_banned_card = 0;
89 our $ignore_invalid_card = 0;
91 our $skip_fuzzyfiles = 0;
93 our $ucfirst_nowarn = 0;
95 #this info is in cust_payby as of 4.x
96 #this and the fields themselves can be removed in 5.x
97 our @encrypted_fields = ('payinfo', 'paycvv');
98 sub nohistory_fields { ('payinfo', 'paycvv'); }
101 our $default_agent_custid;
102 our $custnum_display_length;
103 #ask FS::UID to run this stuff for us later
104 #$FS::UID::callback{'FS::cust_main'} = sub {
105 install_callback FS::UID sub {
106 $conf = new FS::Conf;
107 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
108 $default_agent_custid = $conf->exists('cust_main-default_agent_custid');
109 $custnum_display_length = $conf->config('cust_main-custnum-display_length');
114 my ( $hashref, $cache ) = @_;
115 if ( exists $hashref->{'pkgnum'} ) {
116 #@{ $self->{'_pkgnum'} } = ();
117 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
118 $self->{'_pkgnum'} = $subcache;
119 #push @{ $self->{'_pkgnum'} },
120 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
126 FS::cust_main - Object methods for cust_main records
132 $record = new FS::cust_main \%hash;
133 $record = new FS::cust_main { 'column' => 'value' };
135 $error = $record->insert;
137 $error = $new_record->replace($old_record);
139 $error = $record->delete;
141 $error = $record->check;
143 @cust_pkg = $record->all_pkgs;
145 @cust_pkg = $record->ncancelled_pkgs;
147 @cust_pkg = $record->suspended_pkgs;
149 $error = $record->bill;
150 $error = $record->bill %options;
151 $error = $record->bill 'time' => $time;
153 $error = $record->collect;
154 $error = $record->collect %options;
155 $error = $record->collect 'invoice_time' => $time,
160 An FS::cust_main object represents a customer. FS::cust_main inherits from
161 FS::Record. The following fields are currently supported:
167 Primary key (assigned automatically for new customers)
171 Agent (see L<FS::agent>)
175 Advertising source (see L<FS::part_referral>)
187 Cocial security number (optional)
211 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
215 Payment Information (See L<FS::payinfo_Mixin> for data format)
219 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
223 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
227 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
231 Start date month (maestro/solo cards only)
235 Start date year (maestro/solo cards only)
239 Issue number (maestro/solo cards only)
243 Name on card or billing name
247 IP address from which payment information was received
251 Tax exempt, empty or `Y'
255 Order taker (see L<FS::access_user>)
261 =item referral_custnum
263 Referring customer number
267 Enable individual CDR spooling, empty or `Y'
271 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
275 Discourage individual CDR printing, empty or `Y'
279 Allow self-service editing of ticket subjects, empty or 'Y'
281 =item calling_list_exempt
283 Do not call, empty or 'Y'
285 =item invoice_ship_address
287 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
297 Creates a new customer. To add the customer to the database, see L<"insert">.
299 Note that this stores the hash reference, not a distinct copy of the hash it
300 points to. You can ask the object for a copy with the I<hash> method.
304 sub table { 'cust_main'; }
306 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
308 Adds this customer to the database. If there is an error, returns the error,
309 otherwise returns false.
311 Usually the customer's location will not yet exist in the database, and
312 the C<bill_location> and C<ship_location> pseudo-fields must be set to
313 uninserted L<FS::cust_location> objects. These will be inserted and linked
314 (in both directions) to the new customer record. If they're references
315 to the same object, they will become the same location.
317 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
318 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
319 are inserted atomicly, or the transaction is rolled back. Passing an empty
320 hash reference is equivalent to not supplying this parameter. There should be
321 a better explanation of this, but until then, here's an example:
324 tie %hash, 'Tie::RefHash'; #this part is important
326 $cust_pkg => [ $svc_acct ],
329 $cust_main->insert( \%hash );
331 INVOICING_LIST_ARYREF: No longer supported.
333 Currently available options are: I<depend_jobnum>, I<noexport>,
334 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
336 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
337 on the supplied jobnum (they will not run until the specific job completes).
338 This can be used to defer provisioning until some action completes (such
339 as running the customer's credit card successfully).
341 The I<noexport> option is deprecated. If I<noexport> is set true, no
342 provisioning jobs (exports) are scheduled. (You can schedule them later with
343 the B<reexport> method.)
345 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
346 of tax names and exemption numbers. FS::cust_main_exemption records will be
347 created and inserted.
349 If I<prospectnum> is set, moves contacts and locations from that prospect.
351 If I<contact> is set to an arrayref of FS::contact objects, those will be
354 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
355 unset), inserts those new contacts with this new customer. Handles CGI
356 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
358 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
359 new stored payment records with this new customer. Handles CGI parameters
360 for an "m2" multiple entry field as passed by edit/cust_main.cgi
366 my $cust_pkgs = @_ ? shift : {};
368 if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
369 warn "cust_main::insert using deprecated invoicing list argument";
370 $invoicing_list = shift;
373 warn "$me insert called with options ".
374 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
377 local $SIG{HUP} = 'IGNORE';
378 local $SIG{INT} = 'IGNORE';
379 local $SIG{QUIT} = 'IGNORE';
380 local $SIG{TERM} = 'IGNORE';
381 local $SIG{TSTP} = 'IGNORE';
382 local $SIG{PIPE} = 'IGNORE';
384 my $oldAutoCommit = $FS::UID::AutoCommit;
385 local $FS::UID::AutoCommit = 0;
388 my $prepay_identifier = '';
389 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
391 if ( $self->payby eq 'PREPAY' ) {
393 $self->payby(''); #'BILL');
394 $prepay_identifier = $self->payinfo;
397 warn " looking up prepaid card $prepay_identifier\n"
400 my $error = $self->get_prepay( $prepay_identifier,
401 'amount_ref' => \$amount,
402 'seconds_ref' => \$seconds,
403 'upbytes_ref' => \$upbytes,
404 'downbytes_ref' => \$downbytes,
405 'totalbytes_ref' => \$totalbytes,
408 $dbh->rollback if $oldAutoCommit;
409 #return "error applying prepaid card (transaction rolled back): $error";
413 $payby = 'PREP' if $amount;
415 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
418 $self->payby(''); #'BILL');
419 $amount = $self->paid;
424 foreach my $l (qw(bill_location ship_location)) {
426 my $loc = delete $self->hashref->{$l} or next;
428 if ( !$loc->locationnum ) {
429 # warn the location that we're going to insert it with no custnum
430 $loc->set(custnum_pending => 1);
431 warn " inserting $l\n"
433 my $error = $loc->insert;
435 $dbh->rollback if $oldAutoCommit;
436 my $label = $l eq 'ship_location' ? 'service' : 'billing';
437 return "$error (in $label location)";
440 } elsif ( $loc->prospectnum ) {
442 $loc->prospectnum('');
443 $loc->set(custnum_pending => 1);
444 my $error = $loc->replace;
446 $dbh->rollback if $oldAutoCommit;
447 my $label = $l eq 'ship_location' ? 'service' : 'billing';
448 return "$error (moving $label location)";
451 } elsif ( ($loc->custnum || 0) > 0 ) {
452 # then it somehow belongs to another customer--shouldn't happen
453 $dbh->rollback if $oldAutoCommit;
454 return "$l belongs to customer ".$loc->custnum;
456 # else it already belongs to this customer
457 # (happens when ship_location is identical to bill_location)
459 $self->set($l.'num', $loc->locationnum);
461 if ( $self->get($l.'num') eq '' ) {
462 $dbh->rollback if $oldAutoCommit;
467 warn " inserting $self\n"
470 $self->signupdate(time) unless $self->signupdate;
472 $self->auto_agent_custid()
473 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
475 my $error = $self->check_payinfo_cardtype
476 || $self->SUPER::insert;
478 $dbh->rollback if $oldAutoCommit;
479 #return "inserting cust_main record (transaction rolled back): $error";
483 # now set cust_location.custnum
484 foreach my $l (qw(bill_location ship_location)) {
485 warn " setting $l.custnum\n"
487 my $loc = $self->$l or next;
488 unless ( $loc->custnum ) {
489 $loc->set(custnum => $self->custnum);
490 $error ||= $loc->replace;
494 $dbh->rollback if $oldAutoCommit;
495 return "error setting $l custnum: $error";
499 warn " setting customer tags\n"
502 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
503 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
504 'custnum' => $self->custnum };
505 my $error = $cust_tag->insert;
507 $dbh->rollback if $oldAutoCommit;
512 my $prospectnum = delete $options{'prospectnum'};
513 if ( $prospectnum ) {
515 warn " moving contacts and locations from prospect $prospectnum\n"
519 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
520 unless ( $prospect_main ) {
521 $dbh->rollback if $oldAutoCommit;
522 return "Unknown prospectnum $prospectnum";
524 $prospect_main->custnum($self->custnum);
525 $prospect_main->disabled('Y');
526 my $error = $prospect_main->replace;
528 $dbh->rollback if $oldAutoCommit;
532 foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
533 my $cust_contact = new FS::cust_contact {
534 'custnum' => $self->custnum,
535 map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
537 my $error = $cust_contact->insert
538 || $prospect_contact->delete;
540 $dbh->rollback if $oldAutoCommit;
545 my @cust_location = $prospect_main->cust_location;
546 my @qual = $prospect_main->qual;
548 foreach my $r ( @cust_location, @qual ) {
550 $r->custnum($self->custnum);
551 my $error = $r->replace;
553 $dbh->rollback if $oldAutoCommit;
560 warn " setting contacts\n"
563 $invoicing_list ||= $options{'invoicing_list'};
564 if ( $invoicing_list ) {
566 $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
569 foreach my $dest (@$invoicing_list ) {
570 if ($dest eq 'POST') {
571 $self->set('postal_invoice', 'Y');
574 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
575 if ( $contact_email ) {
576 my $cust_contact = FS::cust_contact->new({
577 contactnum => $contact_email->contactnum,
578 custnum => $self->custnum,
580 $cust_contact->set('invoice_dest', 'Y');
581 my $error = $cust_contact->contactnum ?
582 $cust_contact->replace : $cust_contact->insert;
584 $dbh->rollback if $oldAutoCommit;
585 return "$error (linking to email address $dest)";
589 # this email address is not yet linked to any contact
590 $email .= ',' if length($email);
596 my $contact = FS::contact->new({
597 'custnum' => $self->get('custnum'),
598 'last' => $self->get('last'),
599 'first' => $self->get('first'),
600 'emailaddress' => $email,
601 'invoice_dest' => 'Y', # yes, you can set this via the contact
603 my $error = $contact->insert;
605 $dbh->rollback if $oldAutoCommit;
611 if ( my $contact = delete $options{'contact'} ) {
613 foreach my $c ( @$contact ) {
614 $c->custnum($self->custnum);
615 my $error = $c->insert;
617 $dbh->rollback if $oldAutoCommit;
623 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
625 my $error = $self->process_o2m( 'table' => 'contact',
626 'fields' => FS::contact->cgi_contact_fields,
627 'params' => $contact_params,
630 $dbh->rollback if $oldAutoCommit;
635 warn " setting cust_payby\n"
638 if ( $options{cust_payby} ) {
640 foreach my $cust_payby ( @{ $options{cust_payby} } ) {
641 $cust_payby->custnum($self->custnum);
642 my $error = $cust_payby->insert;
644 $dbh->rollback if $oldAutoCommit;
649 } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
651 my $error = $self->process_o2m(
652 'table' => 'cust_payby',
653 'fields' => FS::cust_payby->cgi_cust_payby_fields,
654 'params' => $cust_payby_params,
655 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
658 $dbh->rollback if $oldAutoCommit;
664 warn " setting cust_main_exemption\n"
667 my $tax_exemption = delete $options{'tax_exemption'};
668 if ( $tax_exemption ) {
670 $tax_exemption = { map { $_ => '' } @$tax_exemption }
671 if ref($tax_exemption) eq 'ARRAY';
673 foreach my $taxname ( keys %$tax_exemption ) {
674 my $cust_main_exemption = new FS::cust_main_exemption {
675 'custnum' => $self->custnum,
676 'taxname' => $taxname,
677 'exempt_number' => $tax_exemption->{$taxname},
679 my $error = $cust_main_exemption->insert;
681 $dbh->rollback if $oldAutoCommit;
682 return "inserting cust_main_exemption (transaction rolled back): $error";
687 warn " ordering packages\n"
690 $error = $self->order_pkgs( $cust_pkgs,
692 'seconds_ref' => \$seconds,
693 'upbytes_ref' => \$upbytes,
694 'downbytes_ref' => \$downbytes,
695 'totalbytes_ref' => \$totalbytes,
698 $dbh->rollback if $oldAutoCommit;
703 $dbh->rollback if $oldAutoCommit;
704 return "No svc_acct record to apply pre-paid time";
706 if ( $upbytes || $downbytes || $totalbytes ) {
707 $dbh->rollback if $oldAutoCommit;
708 return "No svc_acct record to apply pre-paid data";
712 warn " inserting initial $payby payment of $amount\n"
714 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
716 $dbh->rollback if $oldAutoCommit;
717 return "inserting payment (transaction rolled back): $error";
721 unless ( $import || $skip_fuzzyfiles ) {
722 warn " queueing fuzzyfiles update\n"
724 $error = $self->queue_fuzzyfiles_update;
726 $dbh->rollback if $oldAutoCommit;
727 return "updating fuzzy search cache: $error";
731 # FS::geocode_Mixin::after_insert or something?
732 if ( $conf->config('tax_district_method') and !$import ) {
733 # if anything non-empty, try to look it up
734 my $queue = new FS::queue {
735 'job' => 'FS::geocode_Mixin::process_district_update',
736 'custnum' => $self->custnum,
738 my $error = $queue->insert( ref($self), $self->custnum );
740 $dbh->rollback if $oldAutoCommit;
741 return "queueing tax district update: $error";
746 warn " exporting\n" if $DEBUG > 1;
748 my $export_args = $options{'export_args'} || [];
751 map qsearch( 'part_export', {exportnum=>$_} ),
752 $conf->config('cust_main-exports'); #, $agentnum
754 foreach my $part_export ( @part_export ) {
755 my $error = $part_export->export_insert($self, @$export_args);
757 $dbh->rollback if $oldAutoCommit;
758 return "exporting to ". $part_export->exporttype.
759 " (transaction rolled back): $error";
763 #foreach my $depend_jobnum ( @$depend_jobnums ) {
764 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
766 # foreach my $jobnum ( @jobnums ) {
767 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
768 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
770 # my $error = $queue->depend_insert($depend_jobnum);
772 # $dbh->rollback if $oldAutoCommit;
773 # return "error queuing job dependancy: $error";
780 #if ( exists $options{'jobnums'} ) {
781 # push @{ $options{'jobnums'} }, @jobnums;
784 warn " insert complete; committing transaction\n"
787 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
792 use File::CounterFile;
793 sub auto_agent_custid {
796 my $format = $conf->config('cust_main-auto_agent_custid');
798 if ( $format eq '1YMMXXXXXXXX' ) {
800 my $counter = new File::CounterFile 'cust_main.agent_custid';
803 my $ym = 100000000000 + time2str('%y%m00000000', time);
804 if ( $ym > $counter->value ) {
805 $counter->{'value'} = $agent_custid = $ym;
806 $counter->{'updated'} = 1;
808 $agent_custid = $counter->inc;
814 die "Unknown cust_main-auto_agent_custid format: $format";
817 $self->agent_custid($agent_custid);
821 =item PACKAGE METHODS
823 Documentation on customer package methods has been moved to
824 L<FS::cust_main::Packages>.
826 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
828 Recharges this (existing) customer with the specified prepaid card (see
829 L<FS::prepay_credit>), specified either by I<identifier> or as an
830 FS::prepay_credit object. If there is an error, returns the error, otherwise
833 Optionally, five scalar references can be passed as well. They will have their
834 values filled in with the amount, number of seconds, and number of upload,
835 download, and total bytes applied by this prepaid card.
839 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
840 #the only place that uses these args
841 sub recharge_prepay {
842 my( $self, $prepay_credit, $amountref, $secondsref,
843 $upbytesref, $downbytesref, $totalbytesref ) = @_;
845 local $SIG{HUP} = 'IGNORE';
846 local $SIG{INT} = 'IGNORE';
847 local $SIG{QUIT} = 'IGNORE';
848 local $SIG{TERM} = 'IGNORE';
849 local $SIG{TSTP} = 'IGNORE';
850 local $SIG{PIPE} = 'IGNORE';
852 my $oldAutoCommit = $FS::UID::AutoCommit;
853 local $FS::UID::AutoCommit = 0;
856 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
858 my $error = $self->get_prepay( $prepay_credit,
859 'amount_ref' => \$amount,
860 'seconds_ref' => \$seconds,
861 'upbytes_ref' => \$upbytes,
862 'downbytes_ref' => \$downbytes,
863 'totalbytes_ref' => \$totalbytes,
865 || $self->increment_seconds($seconds)
866 || $self->increment_upbytes($upbytes)
867 || $self->increment_downbytes($downbytes)
868 || $self->increment_totalbytes($totalbytes)
869 || $self->insert_cust_pay_prepay( $amount,
871 ? $prepay_credit->identifier
876 $dbh->rollback if $oldAutoCommit;
880 if ( defined($amountref) ) { $$amountref = $amount; }
881 if ( defined($secondsref) ) { $$secondsref = $seconds; }
882 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
883 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
884 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
886 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
891 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
893 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
894 specified either by I<identifier> or as an FS::prepay_credit object.
896 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
897 incremented by the values of the prepaid card.
899 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
900 check or set this customer's I<agentnum>.
902 If there is an error, returns the error, otherwise returns false.
908 my( $self, $prepay_credit, %opt ) = @_;
910 local $SIG{HUP} = 'IGNORE';
911 local $SIG{INT} = 'IGNORE';
912 local $SIG{QUIT} = 'IGNORE';
913 local $SIG{TERM} = 'IGNORE';
914 local $SIG{TSTP} = 'IGNORE';
915 local $SIG{PIPE} = 'IGNORE';
917 my $oldAutoCommit = $FS::UID::AutoCommit;
918 local $FS::UID::AutoCommit = 0;
921 unless ( ref($prepay_credit) ) {
923 my $identifier = $prepay_credit;
925 $prepay_credit = qsearchs(
927 { 'identifier' => $identifier },
932 unless ( $prepay_credit ) {
933 $dbh->rollback if $oldAutoCommit;
934 return "Invalid prepaid card: ". $identifier;
939 if ( $prepay_credit->agentnum ) {
940 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
941 $dbh->rollback if $oldAutoCommit;
942 return "prepaid card not valid for agent ". $self->agentnum;
944 $self->agentnum($prepay_credit->agentnum);
947 my $error = $prepay_credit->delete;
949 $dbh->rollback if $oldAutoCommit;
950 return "removing prepay_credit (transaction rolled back): $error";
953 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
954 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
956 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
961 =item increment_upbytes SECONDS
963 Updates this customer's single or primary account (see L<FS::svc_acct>) by
964 the specified number of upbytes. If there is an error, returns the error,
965 otherwise returns false.
969 sub increment_upbytes {
970 _increment_column( shift, 'upbytes', @_);
973 =item increment_downbytes SECONDS
975 Updates this customer's single or primary account (see L<FS::svc_acct>) by
976 the specified number of downbytes. If there is an error, returns the error,
977 otherwise returns false.
981 sub increment_downbytes {
982 _increment_column( shift, 'downbytes', @_);
985 =item increment_totalbytes SECONDS
987 Updates this customer's single or primary account (see L<FS::svc_acct>) by
988 the specified number of totalbytes. If there is an error, returns the error,
989 otherwise returns false.
993 sub increment_totalbytes {
994 _increment_column( shift, 'totalbytes', @_);
997 =item increment_seconds SECONDS
999 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1000 the specified number of seconds. If there is an error, returns the error,
1001 otherwise returns false.
1005 sub increment_seconds {
1006 _increment_column( shift, 'seconds', @_);
1009 =item _increment_column AMOUNT
1011 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1012 the specified number of seconds or bytes. If there is an error, returns
1013 the error, otherwise returns false.
1017 sub _increment_column {
1018 my( $self, $column, $amount ) = @_;
1019 warn "$me increment_column called: $column, $amount\n"
1022 return '' unless $amount;
1024 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1025 $self->ncancelled_pkgs;
1027 if ( ! @cust_pkg ) {
1028 return 'No packages with primary or single services found'.
1029 ' to apply pre-paid time';
1030 } elsif ( scalar(@cust_pkg) > 1 ) {
1031 #maybe have a way to specify the package/account?
1032 return 'Multiple packages found to apply pre-paid time';
1035 my $cust_pkg = $cust_pkg[0];
1036 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1040 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1042 if ( ! @cust_svc ) {
1043 return 'No account found to apply pre-paid time';
1044 } elsif ( scalar(@cust_svc) > 1 ) {
1045 return 'Multiple accounts found to apply pre-paid time';
1048 my $svc_acct = $cust_svc[0]->svc_x;
1049 warn " found service svcnum ". $svc_acct->pkgnum.
1050 ' ('. $svc_acct->email. ")\n"
1053 $column = "increment_$column";
1054 $svc_acct->$column($amount);
1058 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1060 Inserts a prepayment in the specified amount for this customer. An optional
1061 second argument can specify the prepayment identifier for tracking purposes.
1062 If there is an error, returns the error, otherwise returns false.
1066 sub insert_cust_pay_prepay {
1067 shift->insert_cust_pay('PREP', @_);
1070 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1072 Inserts a cash payment in the specified amount for this customer. An optional
1073 second argument can specify the payment identifier for tracking purposes.
1074 If there is an error, returns the error, otherwise returns false.
1078 sub insert_cust_pay_cash {
1079 shift->insert_cust_pay('CASH', @_);
1082 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1084 Inserts a Western Union payment in the specified amount for this customer. An
1085 optional second argument can specify the prepayment identifier for tracking
1086 purposes. If there is an error, returns the error, otherwise returns false.
1090 sub insert_cust_pay_west {
1091 shift->insert_cust_pay('WEST', @_);
1094 sub insert_cust_pay {
1095 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1096 my $payinfo = scalar(@_) ? shift : '';
1098 my $cust_pay = new FS::cust_pay {
1099 'custnum' => $self->custnum,
1100 'paid' => sprintf('%.2f', $amount),
1101 #'_date' => #date the prepaid card was purchased???
1103 'payinfo' => $payinfo,
1109 =item delete [ OPTION => VALUE ... ]
1111 This deletes the customer. If there is an error, returns the error, otherwise
1114 This will completely remove all traces of the customer record. This is not
1115 what you want when a customer cancels service; for that, cancel all of the
1116 customer's packages (see L</cancel>).
1118 If the customer has any uncancelled packages, you need to pass a new (valid)
1119 customer number for those packages to be transferred to, as the "new_customer"
1120 option. Cancelled packages will be deleted. Did I mention that this is NOT
1121 what you want when a customer cancels service and that you really should be
1122 looking at L<FS::cust_pkg/cancel>?
1124 You can't delete a customer with invoices (see L<FS::cust_bill>),
1125 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1126 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1127 set the "delete_financials" option to a true value.
1132 my( $self, %opt ) = @_;
1134 local $SIG{HUP} = 'IGNORE';
1135 local $SIG{INT} = 'IGNORE';
1136 local $SIG{QUIT} = 'IGNORE';
1137 local $SIG{TERM} = 'IGNORE';
1138 local $SIG{TSTP} = 'IGNORE';
1139 local $SIG{PIPE} = 'IGNORE';
1141 my $oldAutoCommit = $FS::UID::AutoCommit;
1142 local $FS::UID::AutoCommit = 0;
1145 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1146 $dbh->rollback if $oldAutoCommit;
1147 return "Can't delete a master agent customer";
1150 #use FS::access_user
1151 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1152 $dbh->rollback if $oldAutoCommit;
1153 return "Can't delete a master employee customer";
1156 tie my %financial_tables, 'Tie::IxHash',
1157 'cust_bill' => 'invoices',
1158 'cust_statement' => 'statements',
1159 'cust_credit' => 'credits',
1160 'cust_pay' => 'payments',
1161 'cust_refund' => 'refunds',
1164 foreach my $table ( keys %financial_tables ) {
1166 my @records = $self->$table();
1168 if ( @records && ! $opt{'delete_financials'} ) {
1169 $dbh->rollback if $oldAutoCommit;
1170 return "Can't delete a customer with ". $financial_tables{$table};
1173 foreach my $record ( @records ) {
1174 my $error = $record->delete;
1176 $dbh->rollback if $oldAutoCommit;
1177 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1183 my @cust_pkg = $self->ncancelled_pkgs;
1185 my $new_custnum = $opt{'new_custnum'};
1186 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1187 $dbh->rollback if $oldAutoCommit;
1188 return "Invalid new customer number: $new_custnum";
1190 foreach my $cust_pkg ( @cust_pkg ) {
1191 my %hash = $cust_pkg->hash;
1192 $hash{'custnum'} = $new_custnum;
1193 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1194 my $error = $new_cust_pkg->replace($cust_pkg,
1195 options => { $cust_pkg->options },
1198 $dbh->rollback if $oldAutoCommit;
1203 my @cancelled_cust_pkg = $self->all_pkgs;
1204 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1205 my $error = $cust_pkg->delete;
1207 $dbh->rollback if $oldAutoCommit;
1212 #cust_tax_adjustment in financials?
1213 #cust_pay_pending? ouch
1214 foreach my $table (qw(
1215 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1216 cust_payby cust_location cust_main_note cust_tax_adjustment
1217 cust_pay_void cust_pay_batch queue cust_tax_exempt
1219 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1220 my $error = $record->delete;
1222 $dbh->rollback if $oldAutoCommit;
1228 my $sth = $dbh->prepare(
1229 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1231 my $errstr = $dbh->errstr;
1232 $dbh->rollback if $oldAutoCommit;
1235 $sth->execute($self->custnum) or do {
1236 my $errstr = $sth->errstr;
1237 $dbh->rollback if $oldAutoCommit;
1243 my $ticket_dbh = '';
1244 if ($conf->config('ticket_system') eq 'RT_Internal') {
1246 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1247 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1248 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1249 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1252 if ( $ticket_dbh ) {
1254 my $ticket_sth = $ticket_dbh->prepare(
1255 'DELETE FROM Links WHERE Target = ?'
1257 my $errstr = $ticket_dbh->errstr;
1258 $dbh->rollback if $oldAutoCommit;
1261 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1263 my $errstr = $ticket_sth->errstr;
1264 $dbh->rollback if $oldAutoCommit;
1268 #check and see if the customer is the only link on the ticket, and
1269 #if so, set the ticket to deleted status in RT?
1270 #maybe someday, for now this will at least fix tickets not displaying
1274 #delete the customer record
1276 my $error = $self->SUPER::delete;
1278 $dbh->rollback if $oldAutoCommit;
1282 # cust_main exports!
1284 #my $export_args = $options{'export_args'} || [];
1287 map qsearch( 'part_export', {exportnum=>$_} ),
1288 $conf->config('cust_main-exports'); #, $agentnum
1290 foreach my $part_export ( @part_export ) {
1291 my $error = $part_export->export_delete( $self ); #, @$export_args);
1293 $dbh->rollback if $oldAutoCommit;
1294 return "exporting to ". $part_export->exporttype.
1295 " (transaction rolled back): $error";
1299 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1304 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1306 Replaces the OLD_RECORD with this one in the database. If there is an error,
1307 returns the error, otherwise returns false.
1309 To change the customer's address, set the pseudo-fields C<bill_location> and
1310 C<ship_location>. The address will still only change if at least one of the
1311 address fields differs from the existing values.
1313 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1314 set as the contact email address for a default contact with the same name as
1317 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1318 I<contact_params>, I<invoicing_list>.
1320 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1321 of tax names and exemption numbers. FS::cust_main_exemption records will be
1322 deleted and inserted as appropriate.
1324 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1325 groups (describing the customer's payment methods and contacts, respectively)
1326 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1327 and L<FS::contact> for the fields these can contain.
1329 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1330 should be used instead if possible.
1337 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1339 : $self->replace_old;
1343 warn "$me replace called\n"
1346 my $curuser = $FS::CurrentUser::CurrentUser;
1347 return "You are not permitted to create complimentary accounts."
1348 if $self->complimentary eq 'Y'
1349 && $self->complimentary ne $old->complimentary
1350 && ! $curuser->access_right('Complimentary customer');
1352 local($ignore_expired_card) = 1
1353 if $old->payby =~ /^(CARD|DCRD)$/
1354 && $self->payby =~ /^(CARD|DCRD)$/
1355 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1357 local($ignore_banned_card) = 1
1358 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1359 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1360 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1362 if ( $self->payby =~ /^(CARD|DCRD)$/
1363 && $old->payinfo ne $self->payinfo
1364 && $old->paymask ne $self->paymask )
1366 my $error = $self->check_payinfo_cardtype;
1367 return $error if $error;
1370 return "Invoicing locale is required"
1373 && $conf->exists('cust_main-require_locale');
1375 local $SIG{HUP} = 'IGNORE';
1376 local $SIG{INT} = 'IGNORE';
1377 local $SIG{QUIT} = 'IGNORE';
1378 local $SIG{TERM} = 'IGNORE';
1379 local $SIG{TSTP} = 'IGNORE';
1380 local $SIG{PIPE} = 'IGNORE';
1382 my $oldAutoCommit = $FS::UID::AutoCommit;
1383 local $FS::UID::AutoCommit = 0;
1386 for my $l (qw(bill_location ship_location)) {
1387 #my $old_loc = $old->$l;
1388 my $new_loc = $self->$l or next;
1390 # find the existing location if there is one
1391 $new_loc->set('custnum' => $self->custnum);
1392 my $error = $new_loc->find_or_insert;
1394 $dbh->rollback if $oldAutoCommit;
1397 $self->set($l.'num', $new_loc->locationnum);
1401 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1402 warn "cust_main::replace: using deprecated invoicing list argument";
1403 $invoicing_list = shift @param;
1406 my %options = @param;
1408 $invoicing_list ||= $options{invoicing_list};
1410 my @contacts = map { $_->contact } $self->cust_contact;
1411 # find a contact that matches the customer's name
1412 my ($implicit_contact) = grep { $_->first eq $old->get('first')
1413 and $_->last eq $old->get('last') }
1415 $implicit_contact ||= FS::contact->new({
1416 'custnum' => $self->custnum,
1417 'locationnum' => $self->get('bill_locationnum'),
1420 # for any of these that are already contact emails, link to the existing
1422 if ( $invoicing_list ) {
1425 # kind of like process_m2m on these, except:
1426 # - the other side is two tables in a join
1427 # - and we might have to create new contact_emails
1428 # - and possibly a new contact
1430 # Find existing invoice emails that aren't on the implicit contact.
1431 # Any of these that are not on the new invoicing list will be removed.
1432 my %old_email_cust_contact;
1433 foreach my $cust_contact ($self->cust_contact) {
1434 next if !$cust_contact->invoice_dest;
1435 next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1437 foreach my $contact_email ($cust_contact->contact->contact_email) {
1438 $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1442 foreach my $dest (@$invoicing_list) {
1444 if ($dest eq 'POST') {
1446 $self->set('postal_invoice', 'Y');
1448 } elsif ( exists($old_email_cust_contact{$dest}) ) {
1450 delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1454 # See if it belongs to some other contact; if so, link it.
1455 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1457 and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1458 my $cust_contact = qsearchs('cust_contact', {
1459 contactnum => $contact_email->contactnum,
1460 custnum => $self->custnum,
1461 }) || FS::cust_contact->new({
1462 contactnum => $contact_email->contactnum,
1463 custnum => $self->custnum,
1465 $cust_contact->set('invoice_dest', 'Y');
1466 my $error = $cust_contact->custcontactnum ?
1467 $cust_contact->replace : $cust_contact->insert;
1469 $dbh->rollback if $oldAutoCommit;
1470 return "$error (linking to email address $dest)";
1474 # This email address is not yet linked to any contact, so it will
1475 # be added to the implicit contact.
1476 $email .= ',' if length($email);
1482 foreach my $remove_dest (keys %old_email_cust_contact) {
1483 my $cust_contact = $old_email_cust_contact{$remove_dest};
1484 # These were not in the list of requested destinations, so take them off.
1485 $cust_contact->set('invoice_dest', '');
1486 my $error = $cust_contact->replace;
1488 $dbh->rollback if $oldAutoCommit;
1489 return "$error (unlinking email address $remove_dest)";
1493 # make sure it keeps up with the changed customer name, if any
1494 $implicit_contact->set('last', $self->get('last'));
1495 $implicit_contact->set('first', $self->get('first'));
1496 $implicit_contact->set('emailaddress', $email);
1497 $implicit_contact->set('invoice_dest', 'Y');
1498 $implicit_contact->set('custnum', $self->custnum);
1501 if ( $implicit_contact->contactnum ) {
1502 $error = $implicit_contact->replace;
1503 } elsif ( length($email) ) { # don't create a new contact if not needed
1504 $error = $implicit_contact->insert;
1508 $dbh->rollback if $oldAutoCommit;
1509 return "$error (adding email address $email)";
1514 # replace the customer record
1515 my $error = $self->SUPER::replace($old);
1518 $dbh->rollback if $oldAutoCommit;
1522 # now move packages to the new service location
1523 $self->set('ship_location', ''); #flush cache
1524 if ( $old->ship_locationnum and # should only be null during upgrade...
1525 $old->ship_locationnum != $self->ship_locationnum ) {
1526 $error = $old->ship_location->move_to($self->ship_location);
1528 $dbh->rollback if $oldAutoCommit;
1532 # don't move packages based on the billing location, but
1533 # disable it if it's no longer in use
1534 if ( $old->bill_locationnum and
1535 $old->bill_locationnum != $self->bill_locationnum ) {
1536 $error = $old->bill_location->disable_if_unused;
1538 $dbh->rollback if $oldAutoCommit;
1543 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1545 #this could be more efficient than deleting and re-inserting, if it matters
1546 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1547 my $error = $cust_tag->delete;
1549 $dbh->rollback if $oldAutoCommit;
1553 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1554 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1555 'custnum' => $self->custnum };
1556 my $error = $cust_tag->insert;
1558 $dbh->rollback if $oldAutoCommit;
1565 my $tax_exemption = delete $options{'tax_exemption'};
1566 if ( $tax_exemption ) {
1568 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1569 if ref($tax_exemption) eq 'ARRAY';
1571 my %cust_main_exemption =
1572 map { $_->taxname => $_ }
1573 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1575 foreach my $taxname ( keys %$tax_exemption ) {
1577 if ( $cust_main_exemption{$taxname} &&
1578 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1581 delete $cust_main_exemption{$taxname};
1585 my $cust_main_exemption = new FS::cust_main_exemption {
1586 'custnum' => $self->custnum,
1587 'taxname' => $taxname,
1588 'exempt_number' => $tax_exemption->{$taxname},
1590 my $error = $cust_main_exemption->insert;
1592 $dbh->rollback if $oldAutoCommit;
1593 return "inserting cust_main_exemption (transaction rolled back): $error";
1597 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1598 my $error = $cust_main_exemption->delete;
1600 $dbh->rollback if $oldAutoCommit;
1601 return "deleting cust_main_exemption (transaction rolled back): $error";
1607 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1609 my $error = $self->process_o2m(
1610 'table' => 'cust_payby',
1611 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1612 'params' => $cust_payby_params,
1613 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1616 $dbh->rollback if $oldAutoCommit;
1622 if ( my $contact_params = delete $options{'contact_params'} ) {
1624 # this can potentially replace contacts that were created by the
1625 # invoicing list argument, but the UI shouldn't allow both of them
1628 my $error = $self->process_o2m(
1629 'table' => 'contact',
1630 'fields' => FS::contact->cgi_contact_fields,
1631 'params' => $contact_params,
1634 $dbh->rollback if $oldAutoCommit;
1640 unless ( $import || $skip_fuzzyfiles ) {
1641 $error = $self->queue_fuzzyfiles_update;
1643 $dbh->rollback if $oldAutoCommit;
1644 return "updating fuzzy search cache: $error";
1648 # tax district update in cust_location
1650 # cust_main exports!
1652 my $export_args = $options{'export_args'} || [];
1655 map qsearch( 'part_export', {exportnum=>$_} ),
1656 $conf->config('cust_main-exports'); #, $agentnum
1658 foreach my $part_export ( @part_export ) {
1659 my $error = $part_export->export_replace( $self, $old, @$export_args);
1661 $dbh->rollback if $oldAutoCommit;
1662 return "exporting to ". $part_export->exporttype.
1663 " (transaction rolled back): $error";
1667 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1672 =item queue_fuzzyfiles_update
1674 Used by insert & replace to update the fuzzy search cache
1678 use FS::cust_main::Search;
1679 sub queue_fuzzyfiles_update {
1682 local $SIG{HUP} = 'IGNORE';
1683 local $SIG{INT} = 'IGNORE';
1684 local $SIG{QUIT} = 'IGNORE';
1685 local $SIG{TERM} = 'IGNORE';
1686 local $SIG{TSTP} = 'IGNORE';
1687 local $SIG{PIPE} = 'IGNORE';
1689 my $oldAutoCommit = $FS::UID::AutoCommit;
1690 local $FS::UID::AutoCommit = 0;
1693 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1694 my $queue = new FS::queue {
1695 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1697 my @args = "cust_main.$field", $self->get($field);
1698 my $error = $queue->insert( @args );
1700 $dbh->rollback if $oldAutoCommit;
1701 return "queueing job (transaction rolled back): $error";
1706 push @locations, $self->bill_location if $self->bill_locationnum;
1707 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1708 foreach my $location (@locations) {
1709 my $queue = new FS::queue {
1710 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1712 my @args = 'cust_location.address1', $location->address1;
1713 my $error = $queue->insert( @args );
1715 $dbh->rollback if $oldAutoCommit;
1716 return "queueing job (transaction rolled back): $error";
1720 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1727 Checks all fields to make sure this is a valid customer record. If there is
1728 an error, returns the error, otherwise returns false. Called by the insert
1729 and replace methods.
1736 warn "$me check BEFORE: \n". $self->_dump
1740 $self->ut_numbern('custnum')
1741 || $self->ut_number('agentnum')
1742 || $self->ut_textn('agent_custid')
1743 || $self->ut_number('refnum')
1744 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1745 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1746 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1747 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1748 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1749 || $self->ut_textn('custbatch')
1750 || $self->ut_name('last')
1751 || $self->ut_name('first')
1752 || $self->ut_snumbern('signupdate')
1753 || $self->ut_snumbern('birthdate')
1754 || $self->ut_namen('spouse_last')
1755 || $self->ut_namen('spouse_first')
1756 || $self->ut_snumbern('spouse_birthdate')
1757 || $self->ut_snumbern('anniversary_date')
1758 || $self->ut_textn('company')
1759 || $self->ut_textn('ship_company')
1760 || $self->ut_anything('comments')
1761 || $self->ut_numbern('referral_custnum')
1762 || $self->ut_textn('stateid')
1763 || $self->ut_textn('stateid_state')
1764 || $self->ut_textn('invoice_terms')
1765 || $self->ut_floatn('cdr_termination_percentage')
1766 || $self->ut_floatn('credit_limit')
1767 || $self->ut_numbern('billday')
1768 || $self->ut_numbern('prorate_day')
1769 || $self->ut_flag('edit_subject')
1770 || $self->ut_flag('calling_list_exempt')
1771 || $self->ut_flag('invoice_noemail')
1772 || $self->ut_flag('message_noemail')
1773 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1774 || $self->ut_currencyn('currency')
1775 || $self->ut_alphan('po_number')
1776 || $self->ut_enum('complimentary', [ '', 'Y' ])
1777 || $self->ut_flag('invoice_ship_address')
1778 || $self->ut_flag('invoice_dest')
1781 foreach (qw(company ship_company)) {
1782 my $company = $self->get($_);
1783 $company =~ s/^\s+//;
1784 $company =~ s/\s+$//;
1785 $company =~ s/\s+/ /g;
1786 $self->set($_, $company);
1789 #barf. need message catalogs. i18n. etc.
1790 $error .= "Please select an advertising source."
1791 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1792 return $error if $error;
1794 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1795 or return "Unknown agent";
1797 if ( $self->currency ) {
1798 my $agent_currency = qsearchs( 'agent_currency', {
1799 'agentnum' => $agent->agentnum,
1800 'currency' => $self->currency,
1802 or return "Agent ". $agent->agent.
1803 " not permitted to offer ". $self->currency. " invoicing";
1806 return "Unknown refnum"
1807 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1809 return "Unknown referring custnum: ". $self->referral_custnum
1810 unless ! $self->referral_custnum
1811 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1813 if ( $self->ss eq '' ) {
1818 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1819 or return "Illegal social security number: ". $self->ss;
1820 $self->ss("$1-$2-$3");
1823 #turn off invoice_ship_address if ship & bill are the same
1824 if ($self->bill_locationnum eq $self->ship_locationnum) {
1825 $self->invoice_ship_address('');
1828 # cust_main_county verification now handled by cust_location check
1831 $self->ut_phonen('daytime', $self->country)
1832 || $self->ut_phonen('night', $self->country)
1833 || $self->ut_phonen('fax', $self->country)
1834 || $self->ut_phonen('mobile', $self->country)
1836 return $error if $error;
1838 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1840 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1843 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1845 : FS::Msgcat::_gettext('daytime');
1846 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1848 : FS::Msgcat::_gettext('night');
1850 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1852 : FS::Msgcat::_gettext('mobile');
1854 return "$daytime_label, $night_label or $mobile_label is required"
1858 ### start of stuff moved to cust_payby
1859 # then mostly kept here to support upgrades (can remove in 5.x)
1860 # but modified to allow everything to be empty
1862 if ( $self->payby ) {
1863 FS::payby->can_payby($self->table, $self->payby)
1864 or return "Illegal payby: ". $self->payby;
1869 $error = $self->ut_numbern('paystart_month')
1870 || $self->ut_numbern('paystart_year')
1871 || $self->ut_numbern('payissue')
1872 || $self->ut_textn('paytype')
1874 return $error if $error;
1876 if ( $self->payip eq '' ) {
1879 $error = $self->ut_ip('payip');
1880 return $error if $error;
1883 # If it is encrypted and the private key is not availaible then we can't
1884 # check the credit card.
1885 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1887 # Need some kind of global flag to accept invalid cards, for testing
1889 if ( !$import && !$ignore_invalid_card && $check_payinfo &&
1890 $self->payby =~ /^(CARD|DCRD)$/ ) {
1892 my $payinfo = $self->payinfo;
1893 $payinfo =~ s/\D//g;
1894 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1895 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1897 $self->payinfo($payinfo);
1899 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1901 return gettext('unknown_card_type')
1902 if $self->payinfo !~ /^99\d{14}$/ #token
1903 && cardtype($self->payinfo) eq "Unknown";
1905 unless ( $ignore_banned_card ) {
1906 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1908 if ( $ban->bantype eq 'warn' ) {
1909 #or others depending on value of $ban->reason ?
1910 return '_duplicate_card'.
1911 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1912 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1913 ' (ban# '. $ban->bannum. ')'
1914 unless $self->override_ban_warn;
1916 return 'Banned credit card: banned on '.
1917 time2str('%a %h %o at %r', $ban->_date).
1918 ' by '. $ban->otaker.
1919 ' (ban# '. $ban->bannum. ')';
1924 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1925 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1926 $self->paycvv =~ /^(\d{4})$/
1927 or return "CVV2 (CID) for American Express cards is four digits.";
1930 $self->paycvv =~ /^(\d{3})$/
1931 or return "CVV2 (CVC2/CID) is three digits.";
1938 my $cardtype = cardtype($payinfo);
1939 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1941 return "Start date or issue number is required for $cardtype cards"
1942 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1944 return "Start month must be between 1 and 12"
1945 if $self->paystart_month
1946 and $self->paystart_month < 1 || $self->paystart_month > 12;
1948 return "Start year must be 1990 or later"
1949 if $self->paystart_year
1950 and $self->paystart_year < 1990;
1952 return "Issue number must be beween 1 and 99"
1954 and $self->payissue < 1 || $self->payissue > 99;
1957 $self->paystart_month('');
1958 $self->paystart_year('');
1959 $self->payissue('');
1962 } elsif ( !$ignore_invalid_card && $check_payinfo &&
1963 $self->payby =~ /^(CHEK|DCHK)$/ ) {
1965 my $payinfo = $self->payinfo;
1966 $payinfo =~ s/[^\d\@\.]//g;
1967 if ( $conf->config('echeck-country') eq 'CA' ) {
1968 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1969 or return 'invalid echeck account@branch.bank';
1970 $payinfo = "$1\@$2.$3";
1971 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1972 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1973 $payinfo = "$1\@$2";
1975 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1976 $payinfo = "$1\@$2";
1978 $self->payinfo($payinfo);
1981 unless ( $ignore_banned_card ) {
1982 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1984 if ( $ban->bantype eq 'warn' ) {
1985 #or others depending on value of $ban->reason ?
1986 return '_duplicate_ach' unless $self->override_ban_warn;
1988 return 'Banned ACH account: banned on '.
1989 time2str('%a %h %o at %r', $ban->_date).
1990 ' by '. $ban->otaker.
1991 ' (ban# '. $ban->bannum. ')';
1996 } elsif ( $self->payby eq 'LECB' ) {
1998 my $payinfo = $self->payinfo;
1999 $payinfo =~ s/\D//g;
2000 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2002 $self->payinfo($payinfo);
2005 } elsif ( $self->payby eq 'BILL' ) {
2007 $error = $self->ut_textn('payinfo');
2008 return "Illegal P.O. number: ". $self->payinfo if $error;
2011 } elsif ( $self->payby eq 'COMP' ) {
2013 my $curuser = $FS::CurrentUser::CurrentUser;
2014 if ( ! $self->custnum
2015 && ! $curuser->access_right('Complimentary customer')
2018 return "You are not permitted to create complimentary accounts."
2021 $error = $self->ut_textn('payinfo');
2022 return "Illegal comp account issuer: ". $self->payinfo if $error;
2025 } elsif ( $self->payby eq 'PREPAY' ) {
2027 my $payinfo = $self->payinfo;
2028 $payinfo =~ s/\W//g; #anything else would just confuse things
2029 $self->payinfo($payinfo);
2030 $error = $self->ut_alpha('payinfo');
2031 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2032 return "Unknown prepayment identifier"
2033 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2038 return "You are not permitted to create complimentary accounts."
2040 && $self->complimentary eq 'Y'
2041 && ! $FS::CurrentUser::CurrentUser->access_right('Complimentary customer');
2043 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2044 return "Expiration date required"
2045 # shouldn't payinfo_check do this?
2046 unless ! $self->payby
2047 || $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2051 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2052 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2053 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2054 ( $m, $y ) = ( $2, "19$1" );
2055 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2056 ( $m, $y ) = ( $3, "20$2" );
2058 return "Illegal expiration date: ". $self->paydate;
2060 $m = sprintf('%02d',$m);
2061 $self->paydate("$y-$m-01");
2062 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2063 return gettext('expired_card')
2065 && !$ignore_expired_card
2066 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2069 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2070 ( ! $conf->exists('require_cardname')
2071 || $self->payby !~ /^(CARD|DCRD)$/ )
2073 $self->payname( $self->first. " ". $self->getfield('last') );
2076 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2077 $self->payname =~ /^([\w \,\.\-\']*)$/
2078 or return gettext('illegal_name'). " payname: ". $self->payname;
2081 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2082 or return gettext('illegal_name'). " payname: ". $self->payname;
2088 ### end of stuff moved to cust_payby
2090 return "Please select an invoicing locale"
2093 && $conf->exists('cust_main-require_locale');
2095 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2096 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2100 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2102 warn "$me check AFTER: \n". $self->_dump
2105 $self->SUPER::check;
2108 sub check_payinfo_cardtype {
2111 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
2113 my $payinfo = $self->payinfo;
2114 $payinfo =~ s/\D//g;
2116 return '' if $payinfo =~ /^99\d{14}$/; #token
2118 my %bop_card_types = map { $_=>1 } values %{ card_types() };
2119 my $cardtype = cardtype($payinfo);
2121 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
2129 Additional checks for replace only.
2134 my ($new,$old) = @_;
2135 #preserve old value if global config is set
2136 if ($old && $conf->exists('invoice-ship_address')) {
2137 $new->invoice_ship_address($old->invoice_ship_address);
2144 Returns a list of fields which have ship_ duplicates.
2149 qw( last first company
2151 address1 address2 city county state zip country
2153 daytime night fax mobile
2157 =item has_ship_address
2159 Returns true if this customer record has a separate shipping address.
2163 sub has_ship_address {
2165 $self->bill_locationnum != $self->ship_locationnum;
2170 Returns a list of key/value pairs, with the following keys: address1,
2171 adddress2, city, county, state, zip, country, district, and geocode. The
2172 shipping address is used if present.
2178 $self->ship_location->location_hash;
2183 Returns all locations (see L<FS::cust_location>) for this customer.
2190 'table' => 'cust_location',
2191 'hashref' => { 'custnum' => $self->custnum,
2192 'prospectnum' => '',
2194 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
2200 Returns all contact associations (see L<FS::cust_contact>) for this customer.
2206 qsearch('cust_contact', { 'custnum' => $self->custnum } );
2209 =item cust_payby PAYBY
2211 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2213 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
2214 Does not validate PAYBY.
2222 'table' => 'cust_payby',
2223 'hashref' => { 'custnum' => $self->custnum },
2224 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
2226 $search->{'extra_sql'} = ' AND payby IN ( ' . join(',', map { dbh->quote($_) } @payby) . ' ) '
2232 =item has_cust_payby_auto
2234 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2238 sub has_cust_payby_auto {
2241 'table' => 'cust_payby',
2242 'hashref' => { 'custnum' => $self->custnum, },
2243 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2244 'order_by' => 'LIMIT 1',
2251 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2252 and L<FS::cust_pkg>) for this customer, except those on hold.
2254 Returns a list: an empty list on success or a list of errors.
2260 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2265 Unsuspends all suspended packages in the on-hold state (those without setup
2266 dates) for this customer.
2272 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2277 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2279 Returns a list: an empty list on success or a list of errors.
2285 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2288 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2290 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2291 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2292 of a list of pkgparts; the hashref has the following keys:
2296 =item pkgparts - listref of pkgparts
2298 =item (other options are passed to the suspend method)
2303 Returns a list: an empty list on success or a list of errors.
2307 sub suspend_if_pkgpart {
2309 my (@pkgparts, %opt);
2310 if (ref($_[0]) eq 'HASH'){
2311 @pkgparts = @{$_[0]{pkgparts}};
2316 grep { $_->suspend(%opt) }
2317 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2318 $self->unsuspended_pkgs;
2321 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2323 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2324 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2325 instead of a list of pkgparts; the hashref has the following keys:
2329 =item pkgparts - listref of pkgparts
2331 =item (other options are passed to the suspend method)
2335 Returns a list: an empty list on success or a list of errors.
2339 sub suspend_unless_pkgpart {
2341 my (@pkgparts, %opt);
2342 if (ref($_[0]) eq 'HASH'){
2343 @pkgparts = @{$_[0]{pkgparts}};
2348 grep { $_->suspend(%opt) }
2349 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2350 $self->unsuspended_pkgs;
2353 =item cancel [ OPTION => VALUE ... ]
2355 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2357 Available options are:
2361 =item quiet - can be set true to supress email cancellation notices.
2363 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
2365 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2367 =item nobill - can be set true to skip billing if it might otherwise be done.
2371 Always returns a list: an empty list on success or a list of errors.
2375 # nb that dates are not specified as valid options to this method
2378 my( $self, %opt ) = @_;
2380 warn "$me cancel called on customer ". $self->custnum. " with options ".
2381 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2384 return ( 'access denied' )
2385 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2387 if ( $opt{'ban'} ) {
2389 foreach my $cust_payby ( $self->cust_payby ) {
2391 #well, if they didn't get decrypted on search, then we don't have to
2392 # try again... queue a job for the server that does have decryption
2393 # capability if we're in a paranoid multi-server implementation?
2394 return ( "Can't (yet) ban encrypted credit cards" )
2395 if $cust_payby->is_encrypted($cust_payby->payinfo);
2397 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2398 my $error = $ban->insert;
2399 return ( $error ) if $error;
2405 my @pkgs = $self->ncancelled_pkgs;
2407 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2409 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2410 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2414 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2415 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2418 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2421 sub _banned_pay_hashref {
2432 'payby' => $payby2ban{$self->payby},
2433 'payinfo' => $self->payinfo,
2434 #don't ever *search* on reason! #'reason' =>
2440 Returns all notes (see L<FS::cust_main_note>) for this customer.
2445 my($self,$orderby_classnum) = (shift,shift);
2446 my $orderby = "sticky DESC, _date DESC";
2447 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2448 qsearch( 'cust_main_note',
2449 { 'custnum' => $self->custnum },
2451 "ORDER BY $orderby",
2457 Returns the agent (see L<FS::agent>) for this customer.
2461 Returns the agent name (see L<FS::agent>) for this customer.
2467 $self->agent->agent;
2472 Returns any tags associated with this customer, as FS::cust_tag objects,
2473 or an empty list if there are no tags.
2477 Returns any tags associated with this customer, as FS::part_tag objects,
2478 or an empty list if there are no tags.
2484 map $_->part_tag, $self->cust_tag;
2490 Returns the customer class, as an FS::cust_class object, or the empty string
2491 if there is no customer class.
2495 Returns the customer category name, or the empty string if there is no customer
2502 my $cust_class = $self->cust_class;
2504 ? $cust_class->categoryname
2510 Returns the customer class name, or the empty string if there is no customer
2517 my $cust_class = $self->cust_class;
2519 ? $cust_class->classname
2525 Returns the external tax status, as an FS::tax_status object, or the empty
2526 string if there is no tax status.
2532 if ( $self->taxstatusnum ) {
2533 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2541 Returns the tax status code if there is one.
2547 my $tax_status = $self->tax_status;
2549 ? $tax_status->taxstatus
2553 =item BILLING METHODS
2555 Documentation on billing methods has been moved to
2556 L<FS::cust_main::Billing>.
2558 =item REALTIME BILLING METHODS
2560 Documentation on realtime billing methods has been moved to
2561 L<FS::cust_main::Billing_Realtime>.
2565 Removes the I<paycvv> field from the database directly.
2567 If there is an error, returns the error, otherwise returns false.
2573 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2574 or return dbh->errstr;
2575 $sth->execute($self->custnum)
2576 or return $sth->errstr;
2583 Returns the total owed for this customer on all invoices
2584 (see L<FS::cust_bill/owed>).
2590 $self->total_owed_date(2145859200); #12/31/2037
2593 =item total_owed_date TIME
2595 Returns the total owed for this customer on all invoices with date earlier than
2596 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2597 see L<Time::Local> and L<Date::Parse> for conversion functions.
2601 sub total_owed_date {
2605 my $custnum = $self->custnum;
2607 my $owed_sql = FS::cust_bill->owed_sql;
2610 SELECT SUM($owed_sql) FROM cust_bill
2611 WHERE custnum = $custnum
2615 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2619 =item total_owed_pkgnum PKGNUM
2621 Returns the total owed on all invoices for this customer's specific package
2622 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2626 sub total_owed_pkgnum {
2627 my( $self, $pkgnum ) = @_;
2628 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2631 =item total_owed_date_pkgnum TIME PKGNUM
2633 Returns the total owed for this customer's specific package when using
2634 experimental package balances on all invoices with date earlier than
2635 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2636 see L<Time::Local> and L<Date::Parse> for conversion functions.
2640 sub total_owed_date_pkgnum {
2641 my( $self, $time, $pkgnum ) = @_;
2644 foreach my $cust_bill (
2645 grep { $_->_date <= $time }
2646 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2648 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2650 sprintf( "%.2f", $total_bill );
2656 Returns the total amount of all payments.
2663 $total += $_->paid foreach $self->cust_pay;
2664 sprintf( "%.2f", $total );
2667 =item total_unapplied_credits
2669 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2670 customer. See L<FS::cust_credit/credited>.
2672 =item total_credited
2674 Old name for total_unapplied_credits. Don't use.
2678 sub total_credited {
2679 #carp "total_credited deprecated, use total_unapplied_credits";
2680 shift->total_unapplied_credits(@_);
2683 sub total_unapplied_credits {
2686 my $custnum = $self->custnum;
2688 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2691 SELECT SUM($unapplied_sql) FROM cust_credit
2692 WHERE custnum = $custnum
2695 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2699 =item total_unapplied_credits_pkgnum PKGNUM
2701 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2702 customer. See L<FS::cust_credit/credited>.
2706 sub total_unapplied_credits_pkgnum {
2707 my( $self, $pkgnum ) = @_;
2708 my $total_credit = 0;
2709 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2710 sprintf( "%.2f", $total_credit );
2714 =item total_unapplied_payments
2716 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2717 See L<FS::cust_pay/unapplied>.
2721 sub total_unapplied_payments {
2724 my $custnum = $self->custnum;
2726 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2729 SELECT SUM($unapplied_sql) FROM cust_pay
2730 WHERE custnum = $custnum
2733 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2737 =item total_unapplied_payments_pkgnum PKGNUM
2739 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2740 specific package when using experimental package balances. See
2741 L<FS::cust_pay/unapplied>.
2745 sub total_unapplied_payments_pkgnum {
2746 my( $self, $pkgnum ) = @_;
2747 my $total_unapplied = 0;
2748 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2749 sprintf( "%.2f", $total_unapplied );
2753 =item total_unapplied_refunds
2755 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2756 customer. See L<FS::cust_refund/unapplied>.
2760 sub total_unapplied_refunds {
2762 my $custnum = $self->custnum;
2764 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2767 SELECT SUM($unapplied_sql) FROM cust_refund
2768 WHERE custnum = $custnum
2771 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2777 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2778 total_unapplied_credits minus total_unapplied_payments).
2784 $self->balance_date_range;
2787 =item balance_date TIME
2789 Returns the balance for this customer, only considering invoices with date
2790 earlier than TIME (total_owed_date minus total_credited minus
2791 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2792 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2799 $self->balance_date_range(shift);
2802 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2804 Returns the balance for this customer, optionally considering invoices with
2805 date earlier than START_TIME, and not later than END_TIME
2806 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2808 Times are specified as SQL fragments or numeric
2809 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2810 L<Date::Parse> for conversion functions. The empty string can be passed
2811 to disable that time constraint completely.
2813 Accepts the same options as L<balance_date_sql>:
2817 =item unapplied_date
2819 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)
2823 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2824 time will be ignored. Note that START_TIME and END_TIME only limit the date
2825 range for invoices and I<unapplied> payments, credits, and refunds.
2831 sub balance_date_range {
2833 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2834 ') FROM cust_main WHERE custnum='. $self->custnum;
2835 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2838 =item balance_pkgnum PKGNUM
2840 Returns the balance for this customer's specific package when using
2841 experimental package balances (total_owed plus total_unrefunded, minus
2842 total_unapplied_credits minus total_unapplied_payments)
2846 sub balance_pkgnum {
2847 my( $self, $pkgnum ) = @_;
2850 $self->total_owed_pkgnum($pkgnum)
2851 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2852 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2853 - $self->total_unapplied_credits_pkgnum($pkgnum)
2854 - $self->total_unapplied_payments_pkgnum($pkgnum)
2860 Returns a hash of useful information for making a payment.
2870 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2871 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2872 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2876 For credit card transactions:
2888 For electronic check transactions:
2903 $return{balance} = $self->balance;
2905 $return{payname} = $self->payname
2906 || ( $self->first. ' '. $self->get('last') );
2908 $return{$_} = $self->bill_location->$_
2909 for qw(address1 address2 city state zip);
2911 $return{payby} = $self->payby;
2912 $return{stateid_state} = $self->stateid_state;
2914 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2915 $return{card_type} = cardtype($self->payinfo);
2916 $return{payinfo} = $self->paymask;
2918 @return{'month', 'year'} = $self->paydate_monthyear;
2922 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2923 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2924 $return{payinfo1} = $payinfo1;
2925 $return{payinfo2} = $payinfo2;
2926 $return{paytype} = $self->paytype;
2927 $return{paystate} = $self->paystate;
2931 #doubleclick protection
2933 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2941 Returns the next payment expiration date for this customer. If they have no
2942 payment methods that will expire, returns 0.
2948 # filter out the ones that individually return 0, but then return 0 if
2949 # there are no results
2950 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
2951 min( @epochs ) || 0;
2954 =item paydate_epoch_sql
2956 Returns an SQL expression to get the next payment expiration date for a
2957 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
2958 dates, so that it's safe to test for "will it expire before date X" for any
2963 sub paydate_epoch_sql {
2965 my $paydate = FS::cust_payby->paydate_epoch_sql;
2966 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
2970 my( $self, $taxname ) = @_;
2972 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2973 'taxname' => $taxname,
2978 =item cust_main_exemption
2980 =item invoicing_list
2982 Returns a list of email addresses (with svcnum entries expanded), and the word
2983 'POST' if the customer receives postal invoices.
2987 sub invoicing_list {
2988 my( $self, $arrayref ) = @_;
2991 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
2994 my @emails = $self->invoicing_list_emailonly;
2995 push @emails, 'POST' if $self->get('postal_invoice');
3000 =item check_invoicing_list ARRAYREF
3002 Checks these arguements as valid input for the invoicing_list method. If there
3003 is an error, returns the error, otherwise returns false.
3007 sub check_invoicing_list {
3008 my( $self, $arrayref ) = @_;
3010 foreach my $address ( @$arrayref ) {
3012 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3013 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3016 my $cust_main_invoice = new FS::cust_main_invoice ( {
3017 'custnum' => $self->custnum,
3020 my $error = $self->custnum
3021 ? $cust_main_invoice->check
3022 : $cust_main_invoice->checkdest
3024 return $error if $error;
3028 return "Email address required"
3029 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3030 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3037 Returns the email addresses of all accounts provisioned for this customer.
3044 foreach my $cust_pkg ( $self->all_pkgs ) {
3045 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3047 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3048 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3050 $list{$_}=1 foreach map { $_->email } @svc_acct;
3055 =item invoicing_list_addpost
3057 Adds postal invoicing to this customer. If this customer is already configured
3058 to receive postal invoices, does nothing.
3062 sub invoicing_list_addpost {
3064 if ( $self->get('postal_invoice') eq '' ) {
3065 $self->set('postal_invoice', 'Y');
3066 my $error = $self->replace;
3067 warn $error if $error; # should fail harder, but this is traditional
3071 =item invoicing_list_emailonly
3073 Returns the list of email invoice recipients (invoicing_list without non-email
3074 destinations such as POST and FAX).
3078 sub invoicing_list_emailonly {
3080 warn "$me invoicing_list_emailonly called"
3082 return () if !$self->custnum; # not yet inserted
3083 return map { $_->emailaddress }
3085 table => 'cust_contact',
3086 select => 'emailaddress',
3087 addl_from => ' JOIN contact USING (contactnum) '.
3088 ' JOIN contact_email USING (contactnum)',
3089 hashref => { 'custnum' => $self->custnum, },
3090 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
3094 =item invoicing_list_emailonly_scalar
3096 Returns the list of email invoice recipients (invoicing_list without non-email
3097 destinations such as POST and FAX) as a comma-separated scalar.
3101 sub invoicing_list_emailonly_scalar {
3103 warn "$me invoicing_list_emailonly_scalar called"
3105 join(', ', $self->invoicing_list_emailonly);
3108 =item referral_custnum_cust_main
3110 Returns the customer who referred this customer (or the empty string, if
3111 this customer was not referred).
3113 Note the difference with referral_cust_main method: This method,
3114 referral_custnum_cust_main returns the single customer (if any) who referred
3115 this customer, while referral_cust_main returns an array of customers referred
3120 sub referral_custnum_cust_main {
3122 return '' unless $self->referral_custnum;
3123 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3126 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3128 Returns an array of customers referred by this customer (referral_custnum set
3129 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3130 customers referred by customers referred by this customer and so on, inclusive.
3131 The default behavior is DEPTH 1 (no recursion).
3133 Note the difference with referral_custnum_cust_main method: This method,
3134 referral_cust_main, returns an array of customers referred BY this customer,
3135 while referral_custnum_cust_main returns the single customer (if any) who
3136 referred this customer.
3140 sub referral_cust_main {
3142 my $depth = @_ ? shift : 1;
3143 my $exclude = @_ ? shift : {};
3146 map { $exclude->{$_->custnum}++; $_; }
3147 grep { ! $exclude->{ $_->custnum } }
3148 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3152 map { $_->referral_cust_main($depth-1, $exclude) }
3159 =item referral_cust_main_ncancelled
3161 Same as referral_cust_main, except only returns customers with uncancelled
3166 sub referral_cust_main_ncancelled {
3168 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3171 =item referral_cust_pkg [ DEPTH ]
3173 Like referral_cust_main, except returns a flat list of all unsuspended (and
3174 uncancelled) packages for each customer. The number of items in this list may
3175 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3179 sub referral_cust_pkg {
3181 my $depth = @_ ? shift : 1;
3183 map { $_->unsuspended_pkgs }
3184 grep { $_->unsuspended_pkgs }
3185 $self->referral_cust_main($depth);
3188 =item referring_cust_main
3190 Returns the single cust_main record for the customer who referred this customer
3191 (referral_custnum), or false.
3195 sub referring_cust_main {
3197 return '' unless $self->referral_custnum;
3198 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3201 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3203 Applies a credit to this customer. If there is an error, returns the error,
3204 otherwise returns false.
3206 REASON can be a text string, an FS::reason object, or a scalar reference to
3207 a reasonnum. If a text string, it will be automatically inserted as a new
3208 reason, and a 'reason_type' option must be passed to indicate the
3209 FS::reason_type for the new reason.
3211 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3212 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3213 I<commission_pkgnum>.
3215 Any other options are passed to FS::cust_credit::insert.
3220 my( $self, $amount, $reason, %options ) = @_;
3222 my $cust_credit = new FS::cust_credit {
3223 'custnum' => $self->custnum,
3224 'amount' => $amount,
3227 if ( ref($reason) ) {
3229 if ( ref($reason) eq 'SCALAR' ) {
3230 $cust_credit->reasonnum( $$reason );
3232 $cust_credit->reasonnum( $reason->reasonnum );
3236 $cust_credit->set('reason', $reason)
3239 $cust_credit->$_( delete $options{$_} )
3240 foreach grep exists($options{$_}),
3241 qw( addlinfo eventnum ),
3242 map "commission_$_", qw( agentnum salesnum pkgnum );
3244 $cust_credit->insert(%options);
3248 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3250 Creates a one-time charge for this customer. If there is an error, returns
3251 the error, otherwise returns false.
3253 New-style, with a hashref of options:
3255 my $error = $cust_main->charge(
3259 'start_date' => str2time('7/4/2009'),
3260 'pkg' => 'Description',
3261 'comment' => 'Comment',
3262 'additional' => [], #extra invoice detail
3263 'classnum' => 1, #pkg_class
3265 'setuptax' => '', # or 'Y' for tax exempt
3267 'locationnum'=> 1234, # optional
3270 'taxclass' => 'Tax class',
3273 'taxproduct' => 2, #part_pkg_taxproduct
3274 'override' => {}, #XXX describe
3276 #will be filled in with the new object
3277 'cust_pkg_ref' => \$cust_pkg,
3279 #generate an invoice immediately
3281 'invoice_terms' => '', #with these terms
3287 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3291 #super false laziness w/quotation::charge
3294 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3295 my ( $pkg, $comment, $additional );
3296 my ( $setuptax, $taxclass ); #internal taxes
3297 my ( $taxproduct, $override ); #vendor (CCH) taxes
3299 my $separate_bill = '';
3300 my $cust_pkg_ref = '';
3301 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3303 if ( ref( $_[0] ) ) {
3304 $amount = $_[0]->{amount};
3305 $setup_cost = $_[0]->{setup_cost};
3306 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3307 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3308 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3309 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3310 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3311 : '$'. sprintf("%.2f",$amount);
3312 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3313 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3314 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3315 $additional = $_[0]->{additional} || [];
3316 $taxproduct = $_[0]->{taxproductnum};
3317 $override = { '' => $_[0]->{tax_override} };
3318 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3319 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3320 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3321 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3322 $separate_bill = $_[0]->{separate_bill} || '';
3328 $pkg = @_ ? shift : 'One-time charge';
3329 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3331 $taxclass = @_ ? shift : '';
3335 local $SIG{HUP} = 'IGNORE';
3336 local $SIG{INT} = 'IGNORE';
3337 local $SIG{QUIT} = 'IGNORE';
3338 local $SIG{TERM} = 'IGNORE';
3339 local $SIG{TSTP} = 'IGNORE';
3340 local $SIG{PIPE} = 'IGNORE';
3342 my $oldAutoCommit = $FS::UID::AutoCommit;
3343 local $FS::UID::AutoCommit = 0;
3346 my $part_pkg = new FS::part_pkg ( {
3348 'comment' => $comment,
3352 'classnum' => ( $classnum ? $classnum : '' ),
3353 'setuptax' => $setuptax,
3354 'taxclass' => $taxclass,
3355 'taxproductnum' => $taxproduct,
3356 'setup_cost' => $setup_cost,
3359 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3360 ( 0 .. @$additional - 1 )
3362 'additional_count' => scalar(@$additional),
3363 'setup_fee' => $amount,
3366 my $error = $part_pkg->insert( options => \%options,
3367 tax_overrides => $override,
3370 $dbh->rollback if $oldAutoCommit;
3374 my $pkgpart = $part_pkg->pkgpart;
3375 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3376 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3377 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3378 $error = $type_pkgs->insert;
3380 $dbh->rollback if $oldAutoCommit;
3385 my $cust_pkg = new FS::cust_pkg ( {
3386 'custnum' => $self->custnum,
3387 'pkgpart' => $pkgpart,
3388 'quantity' => $quantity,
3389 'start_date' => $start_date,
3390 'no_auto' => $no_auto,
3391 'separate_bill' => $separate_bill,
3392 'locationnum'=> $locationnum,
3395 $error = $cust_pkg->insert;
3397 $dbh->rollback if $oldAutoCommit;
3399 } elsif ( $cust_pkg_ref ) {
3400 ${$cust_pkg_ref} = $cust_pkg;
3404 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3405 'pkg_list' => [ $cust_pkg ],
3408 $dbh->rollback if $oldAutoCommit;
3413 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3418 #=item charge_postal_fee
3420 #Applies a one time charge this customer. If there is an error,
3421 #returns the error, returns the cust_pkg charge object or false
3422 #if there was no charge.
3426 # This should be a customer event. For that to work requires that bill
3427 # also be a customer event.
3429 sub charge_postal_fee {
3432 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3433 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3435 my $cust_pkg = new FS::cust_pkg ( {
3436 'custnum' => $self->custnum,
3437 'pkgpart' => $pkgpart,
3441 my $error = $cust_pkg->insert;
3442 $error ? $error : $cust_pkg;
3445 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3447 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3449 Optionally, a list or hashref of additional arguments to the qsearch call can
3456 my $opt = ref($_[0]) ? shift : { @_ };
3458 #return $self->num_cust_bill unless wantarray || keys %$opt;
3460 $opt->{'table'} = 'cust_bill';
3461 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3462 $opt->{'hashref'}{'custnum'} = $self->custnum;
3463 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3465 map { $_ } #behavior of sort undefined in scalar context
3466 sort { $a->_date <=> $b->_date }
3470 =item open_cust_bill
3472 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3477 sub open_cust_bill {
3481 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3487 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3489 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3493 sub legacy_cust_bill {
3496 #return $self->num_legacy_cust_bill unless wantarray;
3498 map { $_ } #behavior of sort undefined in scalar context
3499 sort { $a->_date <=> $b->_date }
3500 qsearch({ 'table' => 'legacy_cust_bill',
3501 'hashref' => { 'custnum' => $self->custnum, },
3502 'order_by' => 'ORDER BY _date ASC',
3506 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3508 Returns all the statements (see L<FS::cust_statement>) for this customer.
3510 Optionally, a list or hashref of additional arguments to the qsearch call can
3515 =item cust_bill_void
3517 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3521 sub cust_bill_void {
3524 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3525 sort { $a->_date <=> $b->_date }
3526 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3529 sub cust_statement {
3531 my $opt = ref($_[0]) ? shift : { @_ };
3533 #return $self->num_cust_statement unless wantarray || keys %$opt;
3535 $opt->{'table'} = 'cust_statement';
3536 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3537 $opt->{'hashref'}{'custnum'} = $self->custnum;
3538 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3540 map { $_ } #behavior of sort undefined in scalar context
3541 sort { $a->_date <=> $b->_date }
3545 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3547 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3549 Optionally, a list or hashref of additional arguments to the qsearch call can
3550 be passed following the SVCDB.
3557 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3558 warn "$me svc_x requires a svcdb";
3561 my $opt = ref($_[0]) ? shift : { @_ };
3563 $opt->{'table'} = $svcdb;
3564 $opt->{'addl_from'} =
3565 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3566 ($opt->{'addl_from'} || '');
3568 my $custnum = $self->custnum;
3569 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3570 my $where = "cust_pkg.custnum = $custnum";
3572 my $extra_sql = $opt->{'extra_sql'} || '';
3573 if ( keys %{ $opt->{'hashref'} } ) {
3574 $extra_sql = " AND $where $extra_sql";
3577 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3578 $extra_sql = "WHERE $where AND $1";
3581 $extra_sql = "WHERE $where $extra_sql";
3584 $opt->{'extra_sql'} = $extra_sql;
3589 # required for use as an eventtable;
3592 $self->svc_x('svc_acct', @_);
3597 Returns all the credits (see L<FS::cust_credit>) for this customer.
3604 #return $self->num_cust_credit unless wantarray;
3606 map { $_ } #behavior of sort undefined in scalar context
3607 sort { $a->_date <=> $b->_date }
3608 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3611 =item cust_credit_pkgnum
3613 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3614 package when using experimental package balances.
3618 sub cust_credit_pkgnum {
3619 my( $self, $pkgnum ) = @_;
3620 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3621 sort { $a->_date <=> $b->_date }
3622 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3623 'pkgnum' => $pkgnum,
3628 =item cust_credit_void
3630 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3634 sub cust_credit_void {
3637 sort { $a->_date <=> $b->_date }
3638 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3643 Returns all the payments (see L<FS::cust_pay>) for this customer.
3649 my $opt = ref($_[0]) ? shift : { @_ };
3651 return $self->num_cust_pay unless wantarray || keys %$opt;
3653 $opt->{'table'} = 'cust_pay';
3654 $opt->{'hashref'}{'custnum'} = $self->custnum;
3656 map { $_ } #behavior of sort undefined in scalar context
3657 sort { $a->_date <=> $b->_date }
3664 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3665 called automatically when the cust_pay method is used in a scalar context.
3671 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3672 my $sth = dbh->prepare($sql) or die dbh->errstr;
3673 $sth->execute($self->custnum) or die $sth->errstr;
3674 $sth->fetchrow_arrayref->[0];
3677 =item unapplied_cust_pay
3679 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3683 sub unapplied_cust_pay {
3687 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3693 =item cust_pay_pkgnum
3695 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3696 package when using experimental package balances.
3700 sub cust_pay_pkgnum {
3701 my( $self, $pkgnum ) = @_;
3702 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3703 sort { $a->_date <=> $b->_date }
3704 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3705 'pkgnum' => $pkgnum,
3712 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3718 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3719 sort { $a->_date <=> $b->_date }
3720 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3723 =item cust_pay_pending
3725 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3726 (without status "done").
3730 sub cust_pay_pending {
3732 return $self->num_cust_pay_pending unless wantarray;
3733 sort { $a->_date <=> $b->_date }
3734 qsearch( 'cust_pay_pending', {
3735 'custnum' => $self->custnum,
3736 'status' => { op=>'!=', value=>'done' },
3741 =item cust_pay_pending_attempt
3743 Returns all payment attempts / declined payments for this customer, as pending
3744 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3745 a corresponding payment (see L<FS::cust_pay>).
3749 sub cust_pay_pending_attempt {
3751 return $self->num_cust_pay_pending_attempt unless wantarray;
3752 sort { $a->_date <=> $b->_date }
3753 qsearch( 'cust_pay_pending', {
3754 'custnum' => $self->custnum,
3761 =item num_cust_pay_pending
3763 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3764 customer (without status "done"). Also called automatically when the
3765 cust_pay_pending method is used in a scalar context.
3769 sub num_cust_pay_pending {
3772 " SELECT COUNT(*) FROM cust_pay_pending ".
3773 " WHERE custnum = ? AND status != 'done' ",
3778 =item num_cust_pay_pending_attempt
3780 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3781 customer, with status "done" but without a corresp. Also called automatically when the
3782 cust_pay_pending method is used in a scalar context.
3786 sub num_cust_pay_pending_attempt {
3789 " SELECT COUNT(*) FROM cust_pay_pending ".
3790 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3797 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3803 map { $_ } #return $self->num_cust_refund unless wantarray;
3804 sort { $a->_date <=> $b->_date }
3805 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3808 =item display_custnum
3810 Returns the displayed customer number for this customer: agent_custid if
3811 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3815 sub display_custnum {
3818 return $self->agent_custid
3819 if $default_agent_custid && $self->agent_custid;
3821 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3825 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
3826 } elsif ( $custnum_display_length ) {
3827 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
3829 return $self->custnum;
3835 Returns a name string for this customer, either "Company (Last, First)" or
3842 my $name = $self->contact;
3843 $name = $self->company. " ($name)" if $self->company;
3847 =item service_contact
3849 Returns the L<FS::contact> object for this customer that has the 'Service'
3850 contact class, or undef if there is no such contact. Deprecated; don't use
3855 sub service_contact {
3857 if ( !exists($self->{service_contact}) ) {
3858 my $classnum = $self->scalar_sql(
3859 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3860 ) || 0; #if it's zero, qsearchs will return nothing
3861 my $cust_contact = qsearchs('cust_contact', {
3862 'classnum' => $classnum,
3863 'custnum' => $self->custnum,
3865 $self->{service_contact} = $cust_contact->contact if $cust_contact;
3867 $self->{service_contact};
3872 Returns a name string for this (service/shipping) contact, either
3873 "Company (Last, First)" or "Last, First".
3880 my $name = $self->ship_contact;
3881 $name = $self->company. " ($name)" if $self->company;
3887 Returns a name string for this customer, either "Company" or "First Last".
3893 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3896 =item ship_name_short
3898 Returns a name string for this (service/shipping) contact, either "Company"
3903 sub ship_name_short {
3905 $self->service_contact
3906 ? $self->ship_contact_firstlast
3912 Returns this customer's full (billing) contact name only, "Last, First"
3918 $self->get('last'). ', '. $self->first;
3923 Returns this customer's full (shipping) contact name only, "Last, First"
3929 my $contact = $self->service_contact || $self;
3930 $contact->get('last') . ', ' . $contact->get('first');
3933 =item contact_firstlast
3935 Returns this customers full (billing) contact name only, "First Last".
3939 sub contact_firstlast {
3941 $self->first. ' '. $self->get('last');
3944 =item ship_contact_firstlast
3946 Returns this customer's full (shipping) contact name only, "First Last".
3950 sub ship_contact_firstlast {
3952 my $contact = $self->service_contact || $self;
3953 $contact->get('first') . ' '. $contact->get('last');
3956 sub bill_country_full {
3958 $self->bill_location->country_full;
3961 sub ship_country_full {
3963 $self->ship_location->country_full;
3966 =item county_state_county [ PREFIX ]
3968 Returns a string consisting of just the county, state and country.
3972 sub county_state_country {
3975 if ( @_ && $_[0] && $self->has_ship_address ) {
3976 $locationnum = $self->ship_locationnum;
3978 $locationnum = $self->bill_locationnum;
3980 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
3981 $cust_location->county_state_country;
3984 =item geocode DATA_VENDOR
3986 Returns a value for the customer location as encoded by DATA_VENDOR.
3987 Currently this only makes sense for "CCH" as DATA_VENDOR.
3995 Returns a status string for this customer, currently:
4001 No packages have ever been ordered. Displayed as "No packages".
4005 Recurring packages all are new (not yet billed).
4009 One or more recurring packages is active.
4013 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
4017 All non-cancelled recurring packages are suspended.
4021 All recurring packages are cancelled.
4025 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4026 cust_main-status_module configuration option.
4030 sub status { shift->cust_status(@_); }
4034 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4035 for my $status ( FS::cust_main->statuses() ) {
4036 my $method = $status.'_sql';
4037 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4038 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4039 $sth->execute( ($self->custnum) x $numnum )
4040 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4041 if ( $sth->fetchrow_arrayref->[0] ) {
4042 $self->hashref->{cust_status} = $status;
4048 =item is_status_delay_cancel
4050 Returns true if customer status is 'suspended'
4051 and all suspended cust_pkg return true for
4052 cust_pkg->is_status_delay_cancel.
4054 This is not a real status, this only meant for hacking display
4055 values, because otherwise treating the customer as suspended is
4056 really the whole point of the delay_cancel option.
4060 sub is_status_delay_cancel {
4062 return 0 unless $self->status eq 'suspended';
4063 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4064 return 0 unless $cust_pkg->is_status_delay_cancel;
4069 =item ucfirst_cust_status
4071 =item ucfirst_status
4073 Deprecated, use the cust_status_label method instead.
4075 Returns the status with the first character capitalized.
4079 sub ucfirst_status {
4080 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4081 local($ucfirst_nowarn) = 1;
4082 shift->ucfirst_cust_status(@_);
4085 sub ucfirst_cust_status {
4086 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4088 ucfirst($self->cust_status);
4091 =item cust_status_label
4095 Returns the display label for this status.
4099 sub status_label { shift->cust_status_label(@_); }
4101 sub cust_status_label {
4103 __PACKAGE__->statuslabels->{$self->cust_status};
4108 Returns a hex triplet color string for this customer's status.
4112 sub statuscolor { shift->cust_statuscolor(@_); }
4114 sub cust_statuscolor {
4116 __PACKAGE__->statuscolors->{$self->cust_status};
4119 =item tickets [ STATUS ]
4121 Returns an array of hashes representing the customer's RT tickets.
4123 An optional status (or arrayref or hashref of statuses) may be specified.
4129 my $status = ( @_ && $_[0] ) ? shift : '';
4131 my $num = $conf->config('cust_main-max_tickets') || 10;
4134 if ( $conf->config('ticket_system') ) {
4135 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4137 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4146 foreach my $priority (
4147 $conf->config('ticket_system-custom_priority_field-values'), ''
4149 last if scalar(@tickets) >= $num;
4151 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4152 $num - scalar(@tickets),
4163 =item appointments [ STATUS ]
4165 Returns an array of hashes representing the customer's RT tickets which
4172 my $status = ( @_ && $_[0] ) ? shift : '';
4174 return () unless $conf->config('ticket_system');
4176 my $queueid = $conf->config('ticket_system-appointment-queueid');
4178 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4187 # Return services representing svc_accts in customer support packages
4188 sub support_services {
4190 my %packages = map { $_ => 1 } $conf->config('support_packages');
4192 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4193 grep { $_->part_svc->svcdb eq 'svc_acct' }
4194 map { $_->cust_svc }
4195 grep { exists $packages{ $_->pkgpart } }
4196 $self->ncancelled_pkgs;
4200 # Return a list of latitude/longitude for one of the services (if any)
4201 sub service_coordinates {
4205 grep { $_->latitude && $_->longitude }
4207 map { $_->cust_svc }
4208 $self->ncancelled_pkgs;
4210 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4215 Returns a masked version of the named field
4220 my ($self,$field) = @_;
4224 'x'x(length($self->getfield($field))-4).
4225 substr($self->getfield($field), (length($self->getfield($field))-4));
4229 =item payment_history
4231 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4232 cust_credit and cust_refund objects. Each hashref has the following fields:
4234 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4236 I<date> - value of _date field, unix timestamp
4238 I<date_pretty> - user-friendly date
4240 I<description> - user-friendly description of item
4242 I<amount> - impact of item on user's balance
4243 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4244 Not to be confused with the native 'amount' field in cust_credit, see below.
4246 I<amount_pretty> - includes money char
4248 I<balance> - customer balance, chronologically as of this item
4250 I<balance_pretty> - includes money char
4252 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4254 I<paid> - amount paid for cust_pay records, undef for other types
4256 I<credit> - amount credited for cust_credit records, undef for other types.
4257 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4259 I<refund> - amount refunded for cust_refund records, undef for other types
4261 The four table-specific keys always have positive values, whether they reflect charges or payments.
4263 The following options may be passed to this method:
4265 I<line_items> - if true, returns charges ('Line item') rather than invoices
4267 I<start_date> - unix timestamp, only include records on or after.
4268 If specified, an item of type 'Previous' will also be included.
4269 It does not have table-specific fields.
4271 I<end_date> - unix timestamp, only include records before
4273 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4275 I<conf> - optional already-loaded FS::Conf object.
4279 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4280 # and also for sending customer statements, which should both be kept customer-friendly.
4281 # If you add anything that shouldn't be passed on through the API or exposed
4282 # to customers, add a new option to include it, don't include it by default
4283 sub payment_history {
4285 my $opt = ref($_[0]) ? $_[0] : { @_ };
4287 my $conf = $$opt{'conf'} || new FS::Conf;
4288 my $money_char = $conf->config("money_char") || '$',
4290 #first load entire history,
4291 #need previous to calculate previous balance
4292 #loading after end_date shouldn't hurt too much?
4294 if ( $$opt{'line_items'} ) {
4296 foreach my $cust_bill ( $self->cust_bill ) {
4299 'type' => 'Line item',
4300 'description' => $_->desc( $self->locale ).
4301 ( $_->sdate && $_->edate
4302 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4303 ' To '. time2str('%d-%b-%Y', $_->edate)
4306 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4307 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4308 'date' => $cust_bill->_date,
4309 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4311 foreach $cust_bill->cust_bill_pkg;
4318 'type' => 'Invoice',
4319 'description' => 'Invoice #'. $_->display_invnum,
4320 'amount' => sprintf('%.2f', $_->charged ),
4321 'charged' => sprintf('%.2f', $_->charged ),
4322 'date' => $_->_date,
4323 'date_pretty' => $self->time2str_local('short', $_->_date ),
4325 foreach $self->cust_bill;
4330 'type' => 'Payment',
4331 'description' => 'Payment', #XXX type
4332 'amount' => sprintf('%.2f', 0 - $_->paid ),
4333 'paid' => sprintf('%.2f', $_->paid ),
4334 'date' => $_->_date,
4335 'date_pretty' => $self->time2str_local('short', $_->_date ),
4337 foreach $self->cust_pay;
4341 'description' => 'Credit', #more info?
4342 'amount' => sprintf('%.2f', 0 -$_->amount ),
4343 'credit' => sprintf('%.2f', $_->amount ),
4344 'date' => $_->_date,
4345 'date_pretty' => $self->time2str_local('short', $_->_date ),
4347 foreach $self->cust_credit;
4351 'description' => 'Refund', #more info? type, like payment?
4352 'amount' => $_->refund,
4353 'refund' => $_->refund,
4354 'date' => $_->_date,
4355 'date_pretty' => $self->time2str_local('short', $_->_date ),
4357 foreach $self->cust_refund;
4359 #put it all in chronological order
4360 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4362 #calculate balance, filter items outside date range
4366 foreach my $item (@history) {
4367 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4368 $balance += $$item{'amount'};
4369 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4370 $previous += $$item{'amount'};
4373 $$item{'balance'} = sprintf("%.2f",$balance);
4374 foreach my $key ( qw(amount balance) ) {
4375 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4380 # start with previous balance, if there was one
4383 'type' => 'Previous',
4384 'description' => 'Previous balance',
4385 'amount' => sprintf("%.2f",$previous),
4386 'balance' => sprintf("%.2f",$previous),
4387 'date' => $$opt{'start_date'},
4388 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4390 #false laziness with above
4391 foreach my $key ( qw(amount balance) ) {
4392 $$item{$key.'_pretty'} = $$item{$key};
4393 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4395 unshift(@out,$item);
4398 @out = reverse @history if $$opt{'reverse_sort'};
4403 =item save_cust_payby
4405 Saves a new cust_payby for this customer, replacing an existing entry only
4406 in select circumstances. Does not validate input.
4408 If auto is specified, marks this as the customer's primary method, or the
4409 specified weight. Existing payment methods have their weight incremented as
4412 If bill_location is specified with auto, also sets location in cust_main.
4414 Will not insert complete duplicates of existing records, or records in which the
4415 only difference from an existing record is to turn off automatic payment (will
4416 return without error.) Will replace existing records in which the only difference
4417 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4418 Fields marked as preserved are optional, and existing values will not be overwritten with
4419 blanks when replacing.
4421 Accepts the following named parameters:
4431 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4435 optional, set higher than 1 for secondary, etc.
4443 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4451 optional, will be preserved when replacing
4459 CARD only, required, FS::cust_location object
4461 =item paystart_month
4463 CARD only, optional, will be preserved when replacing
4467 CARD only, optional, will be preserved when replacing
4471 CARD only, optional, will be preserved when replacing
4475 CARD only, only used if conf cvv-save is set appropriately
4489 #The code for this option is in place, but it's not currently used
4493 # existing cust_payby object to be replaced (must match custnum)
4495 # stateid/stateid_state/ss are not currently supported in cust_payby,
4496 # might not even work properly in 4.x, but will need to work here if ever added
4498 sub save_cust_payby {
4502 my $old = $opt{'replace'};
4503 my $new = new FS::cust_payby { $old ? $old->hash : () };
4504 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4505 $new->set( 'custnum' => $self->custnum );
4507 my $payby = $opt{'payment_payby'};
4508 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4510 # don't allow turning off auto when replacing
4511 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4513 my @check_existing; # payby relevant to this payment_payby
4515 # set payby based on auto
4516 if ( $payby eq 'CARD' ) {
4517 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4518 @check_existing = qw( CARD DCRD );
4519 } elsif ( $payby eq 'CHEK' ) {
4520 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4521 @check_existing = qw( CHEK DCHK );
4524 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4527 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4528 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4529 $new->set( 'payname' => $opt{'payname'} );
4530 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4532 my $conf = new FS::Conf;
4534 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4535 if ( $payby eq 'CARD' &&
4536 grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save') ) {
4537 $new->set( 'paycvv' => $opt{'paycvv'} );
4539 $new->set( 'paycvv' => '');
4542 local $SIG{HUP} = 'IGNORE';
4543 local $SIG{INT} = 'IGNORE';
4544 local $SIG{QUIT} = 'IGNORE';
4545 local $SIG{TERM} = 'IGNORE';
4546 local $SIG{TSTP} = 'IGNORE';
4547 local $SIG{PIPE} = 'IGNORE';
4549 my $oldAutoCommit = $FS::UID::AutoCommit;
4550 local $FS::UID::AutoCommit = 0;
4553 # set fields specific to payment_payby
4554 if ( $payby eq 'CARD' ) {
4555 if ($opt{'bill_location'}) {
4556 $opt{'bill_location'}->set('custnum' => $self->custnum);
4557 my $error = $opt{'bill_location'}->find_or_insert;
4559 $dbh->rollback if $oldAutoCommit;
4562 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4564 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4565 $new->set( $field => $opt{$field} );
4568 foreach my $field ( qw(paytype paystate) ) {
4569 $new->set( $field => $opt{$field} );
4573 # other cust_payby to compare this to
4574 my @existing = $self->cust_payby(@check_existing);
4576 # fields that can overwrite blanks with values, but not values with blanks
4577 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4579 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4581 # generally, we don't want to overwrite existing cust_payby with this,
4582 # but we can replace if we're only marking it auto or adding a preserved field
4583 # and we can avoid saving a total duplicate or merely turning off auto
4585 foreach my $cust_payby (@existing) {
4586 # check fields that absolutely should not change
4587 foreach my $field ($new->fields) {
4588 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4589 next if grep(/^$field$/, @preserve );
4590 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4592 # now check fields that can replace if one value is blank
4594 foreach my $field (@preserve) {
4596 ( $new->get($field) and !$cust_payby->get($field) ) or
4597 ( $cust_payby->get($field) and !$new->get($field) )
4599 # prevention of overwriting values with blanks happens farther below
4601 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4605 unless ( $replace ) {
4606 # nearly identical, now check weight
4607 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4608 # ignore identical cust_payby, and ignore attempts to turn off auto
4609 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4610 $skip_cust_payby = 1;
4613 # otherwise, only change is to mark this as primary
4615 # if we got this far, we're definitely replacing
4622 $new->set( 'custpaybynum' => $old->custpaybynum );
4623 # don't turn off automatic payment (but allow it to be turned on)
4624 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4626 $new->set( 'payby' => $old->payby );
4627 $new->set( 'weight' => 1 );
4629 # make sure we're not overwriting values with blanks
4630 foreach my $field (@preserve) {
4631 if ( $old->get($field) and !$new->get($field) ) {
4632 $new->set( $field => $old->get($field) );
4637 # only overwrite cust_main bill_location if auto
4638 if ($opt{'auto'} && $opt{'bill_location'}) {
4639 $self->set('bill_location' => $opt{'bill_location'});
4640 my $error = $self->replace;
4642 $dbh->rollback if $oldAutoCommit;
4647 # done with everything except reweighting and saving cust_payby
4648 # still need to commit changes to cust_main and cust_location
4649 if ($skip_cust_payby) {
4650 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4654 # re-weight existing primary cust_pay for this payby
4656 foreach my $cust_payby (@existing) {
4657 # relies on cust_payby return order
4658 last unless $cust_payby->payby !~ /^D/;
4659 last if $cust_payby->weight > 1;
4660 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4661 next if $cust_payby->weight < ($opt{'weight'} || 1);
4662 $cust_payby->weight( $cust_payby->weight + 1 );
4663 my $error = $cust_payby->replace;
4665 $dbh->rollback if $oldAutoCommit;
4666 return "Error reweighting cust_payby: $error";
4671 # finally, save cust_payby
4672 my $error = $old ? $new->replace($old) : $new->insert;
4674 $dbh->rollback if $oldAutoCommit;
4678 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4685 =head1 CLASS METHODS
4691 Class method that returns the list of possible status strings for customers
4692 (see L<the status method|/status>). For example:
4694 @statuses = FS::cust_main->statuses();
4700 keys %{ $self->statuscolors };
4703 =item cust_status_sql
4705 Returns an SQL fragment to determine the status of a cust_main record, as a
4710 sub cust_status_sql {
4712 for my $status ( FS::cust_main->statuses() ) {
4713 my $method = $status.'_sql';
4714 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4723 Returns an SQL expression identifying prospective cust_main records (customers
4724 with no packages ever ordered)
4728 use vars qw($select_count_pkgs);
4729 $select_count_pkgs =
4730 "SELECT COUNT(*) FROM cust_pkg
4731 WHERE cust_pkg.custnum = cust_main.custnum";
4733 sub select_count_pkgs_sql {
4738 " 0 = ( $select_count_pkgs ) ";
4743 Returns an SQL expression identifying ordered cust_main records (customers with
4744 no active packages, but recurring packages not yet setup or one time charges
4750 FS::cust_main->none_active_sql.
4751 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4756 Returns an SQL expression identifying active cust_main records (customers with
4757 active recurring packages).
4762 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4765 =item none_active_sql
4767 Returns an SQL expression identifying cust_main records with no active
4768 recurring packages. This includes customers of status prospect, ordered,
4769 inactive, and suspended.
4773 sub none_active_sql {
4774 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4779 Returns an SQL expression identifying inactive cust_main records (customers with
4780 no active recurring packages, but otherwise unsuspended/uncancelled).
4785 FS::cust_main->none_active_sql.
4786 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4792 Returns an SQL expression identifying suspended cust_main records.
4797 sub suspended_sql { susp_sql(@_); }
4799 FS::cust_main->none_active_sql.
4800 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4806 Returns an SQL expression identifying cancelled cust_main records.
4810 sub cancel_sql { shift->cancelled_sql(@_); }
4813 =item uncancelled_sql
4815 Returns an SQL expression identifying un-cancelled cust_main records.
4819 sub uncancelled_sql { uncancel_sql(@_); }
4820 sub uncancel_sql { "
4821 ( 0 < ( $select_count_pkgs
4822 AND ( cust_pkg.cancel IS NULL
4823 OR cust_pkg.cancel = 0
4826 OR 0 = ( $select_count_pkgs )
4832 Returns an SQL fragment to retreive the balance.
4837 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4838 WHERE cust_bill.custnum = cust_main.custnum )
4839 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4840 WHERE cust_pay.custnum = cust_main.custnum )
4841 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4842 WHERE cust_credit.custnum = cust_main.custnum )
4843 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4844 WHERE cust_refund.custnum = cust_main.custnum )
4847 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4849 Returns an SQL fragment to retreive the balance for this customer, optionally
4850 considering invoices with date earlier than START_TIME, and not
4851 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4852 total_unapplied_payments).
4854 Times are specified as SQL fragments or numeric
4855 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4856 L<Date::Parse> for conversion functions. The empty string can be passed
4857 to disable that time constraint completely.
4859 Available options are:
4863 =item unapplied_date
4865 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)
4870 set to true to remove all customer comparison clauses, for totals
4875 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4880 JOIN clause (typically used with the total option)
4884 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4885 time will be ignored. Note that START_TIME and END_TIME only limit the date
4886 range for invoices and I<unapplied> payments, credits, and refunds.
4892 sub balance_date_sql {
4893 my( $class, $start, $end, %opt ) = @_;
4895 my $cutoff = $opt{'cutoff'};
4897 my $owed = FS::cust_bill->owed_sql($cutoff);
4898 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4899 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4900 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4902 my $j = $opt{'join'} || '';
4904 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4905 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4906 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4907 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4909 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4910 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4911 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4912 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4917 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4919 Returns an SQL fragment to retreive the total unapplied payments for this
4920 customer, only considering payments with date earlier than START_TIME, and
4921 optionally not later than END_TIME.
4923 Times are specified as SQL fragments or numeric
4924 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4925 L<Date::Parse> for conversion functions. The empty string can be passed
4926 to disable that time constraint completely.
4928 Available options are:
4932 sub unapplied_payments_date_sql {
4933 my( $class, $start, $end, %opt ) = @_;
4935 my $cutoff = $opt{'cutoff'};
4937 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4939 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4940 'unapplied_date'=>1 );
4942 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4945 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4947 Helper method for balance_date_sql; name (and usage) subject to change
4948 (suggestions welcome).
4950 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4951 cust_refund, cust_credit or cust_pay).
4953 If TABLE is "cust_bill" or the unapplied_date option is true, only
4954 considers records with date earlier than START_TIME, and optionally not
4955 later than END_TIME .
4959 sub _money_table_where {
4960 my( $class, $table, $start, $end, %opt ) = @_;
4963 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4964 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4965 push @where, "$table._date <= $start" if defined($start) && length($start);
4966 push @where, "$table._date > $end" if defined($end) && length($end);
4968 push @where, @{$opt{'where'}} if $opt{'where'};
4969 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4975 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4976 use FS::cust_main::Search;
4979 FS::cust_main::Search->search(@_);
4988 #=item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4990 #Deprecated. Use event notification and message templates
4991 #(L<FS::msg_template>) instead.
4993 #Sends a templated email notification to the customer (see L<Text::Template>).
4995 #OPTIONS is a hash and may include
4997 #I<from> - the email sender (default is invoice_from)
4999 #I<to> - comma-separated scalar or arrayref of recipients
5000 # (default is invoicing_list)
5002 #I<subject> - The subject line of the sent email notification
5003 # (default is "Notice from company_name")
5005 #I<extra_fields> - a hashref of name/value pairs which will be substituted
5008 #The following variables are vavailable in the template.
5010 #I<$first> - the customer first name
5011 #I<$last> - the customer last name
5012 #I<$company> - the customer company
5013 #I<$payby> - a description of the method of payment for the customer
5014 # # would be nice to use FS::payby::shortname
5015 #I<$payinfo> - the account information used to collect for this customer
5016 #I<$expdate> - the expiration of the customer payment in seconds from epoch
5021 # my ($self, $template, %options) = @_;
5023 # return unless $conf->exists($template);
5025 # my $from = $conf->invoice_from_full($self->agentnum)
5026 # if $conf->exists('invoice_from', $self->agentnum);
5027 # $from = $options{from} if exists($options{from});
5029 # my $to = join(',', $self->invoicing_list_emailonly);
5030 # $to = $options{to} if exists($options{to});
5032 # my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
5033 # if $conf->exists('company_name', $self->agentnum);
5034 # $subject = $options{subject} if exists($options{subject});
5036 # my $notify_template = new Text::Template (TYPE => 'ARRAY',
5037 # SOURCE => [ map "$_\n",
5038 # $conf->config($template)]
5040 # or die "can't create new Text::Template object: Text::Template::ERROR";
5041 # $notify_template->compile()
5042 # or die "can't compile template: Text::Template::ERROR";
5044 # $FS::notify_template::_template::company_name =
5045 # $conf->config('company_name', $self->agentnum);
5046 # $FS::notify_template::_template::company_address =
5047 # join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
5049 # my $paydate = $self->paydate || '2037-12-31';
5050 # $FS::notify_template::_template::first = $self->first;
5051 # $FS::notify_template::_template::last = $self->last;
5052 # $FS::notify_template::_template::company = $self->company;
5053 # $FS::notify_template::_template::payinfo = $self->mask_payinfo;
5054 # my $payby = $self->payby;
5055 # my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5056 # my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5058 # #credit cards expire at the end of the month/year of their exp date
5059 # if ($payby eq 'CARD' || $payby eq 'DCRD') {
5060 # $FS::notify_template::_template::payby = 'credit card';
5061 # ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5062 # $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5064 # }elsif ($payby eq 'COMP') {
5065 # $FS::notify_template::_template::payby = 'complimentary account';
5067 # $FS::notify_template::_template::payby = 'current method';
5069 # $FS::notify_template::_template::expdate = $expire_time;
5071 # for (keys %{$options{extra_fields}}){
5073 # ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5076 # send_email(from => $from,
5078 # subject => $subject,
5079 # body => $notify_template->fill_in( PACKAGE =>
5080 # 'FS::notify_template::_template' ),
5085 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5087 Generates a templated notification to the customer (see L<Text::Template>).
5089 OPTIONS is a hash and may include
5091 I<extra_fields> - a hashref of name/value pairs which will be substituted
5092 into the template. These values may override values mentioned below
5093 and those from the customer record.
5095 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5097 The following variables are available in the template instead of or in addition
5098 to the fields of the customer record.
5100 I<$payby> - a description of the method of payment for the customer
5101 # would be nice to use FS::payby::shortname
5102 I<$payinfo> - the masked account information used to collect for this customer
5103 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5104 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5108 # a lot like cust_bill::print_latex
5109 sub generate_letter {
5110 my ($self, $template, %options) = @_;
5112 warn "Template $template does not exist" && return
5113 unless $conf->exists($template) || $options{'template_text'};
5115 my $template_source = $options{'template_text'}
5116 ? [ $options{'template_text'} ]
5117 : [ map "$_\n", $conf->config($template) ];
5119 my $letter_template = new Text::Template
5121 SOURCE => $template_source,
5122 DELIMITERS => [ '[@--', '--@]' ],
5124 or die "can't create new Text::Template object: Text::Template::ERROR";
5126 $letter_template->compile()
5127 or die "can't compile template: Text::Template::ERROR";
5129 my %letter_data = map { $_ => $self->$_ } $self->fields;
5130 $letter_data{payinfo} = $self->mask_payinfo;
5132 #my $paydate = $self->paydate || '2037-12-31';
5133 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
5135 my $payby = $self->payby;
5136 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5137 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5139 #credit cards expire at the end of the month/year of their exp date
5140 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5141 $letter_data{payby} = 'credit card';
5142 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5143 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5145 }elsif ($payby eq 'COMP') {
5146 $letter_data{payby} = 'complimentary account';
5148 $letter_data{payby} = 'current method';
5150 $letter_data{expdate} = $expire_time;
5152 for (keys %{$options{extra_fields}}){
5153 $letter_data{$_} = $options{extra_fields}->{$_};
5156 unless(exists($letter_data{returnaddress})){
5157 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5158 $self->agent_template)
5160 if ( length($retadd) ) {
5161 $letter_data{returnaddress} = $retadd;
5162 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5163 $letter_data{returnaddress} =
5164 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5168 ( $conf->config('company_name', $self->agentnum),
5169 $conf->config('company_address', $self->agentnum),
5173 $letter_data{returnaddress} = '~';
5177 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5179 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5181 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5183 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5187 ) or die "can't open temp file: $!\n";
5188 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5189 or die "can't write temp file: $!\n";
5191 $letter_data{'logo_file'} = $lh->filename;
5193 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5197 ) or die "can't open temp file: $!\n";
5199 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5201 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5202 return ($1, $letter_data{'logo_file'});
5206 =item print_ps TEMPLATE
5208 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5214 my($file, $lfile) = $self->generate_letter(@_);
5215 my $ps = FS::Misc::generate_ps($file);
5216 unlink($file.'.tex');
5222 =item print TEMPLATE
5224 Prints the filled in template.
5226 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5230 sub queueable_print {
5233 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5234 or die "invalid customer number: " . $opt{custnum};
5236 #do not backport this change to 3.x
5237 # my $error = $self->print( { 'template' => $opt{template} } );
5238 my $error = $self->print( $opt{'template'} );
5239 die $error if $error;
5243 my ($self, $template) = (shift, shift);
5245 [ $self->print_ps($template) ],
5246 'agentnum' => $self->agentnum,
5250 #these three subs should just go away once agent stuff is all config overrides
5252 sub agent_template {
5254 $self->_agent_plandata('agent_templatename');
5257 sub agent_invoice_from {
5259 $self->_agent_plandata('agent_invoice_from');
5262 sub _agent_plandata {
5263 my( $self, $option ) = @_;
5265 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5266 #agent-specific Conf
5268 use FS::part_event::Condition;
5270 my $agentnum = $self->agentnum;
5272 my $regexp = regexp_sql();
5274 my $part_event_option =
5276 'select' => 'part_event_option.*',
5277 'table' => 'part_event_option',
5279 LEFT JOIN part_event USING ( eventpart )
5280 LEFT JOIN part_event_option AS peo_agentnum
5281 ON ( part_event.eventpart = peo_agentnum.eventpart
5282 AND peo_agentnum.optionname = 'agentnum'
5283 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5285 LEFT JOIN part_event_condition
5286 ON ( part_event.eventpart = part_event_condition.eventpart
5287 AND part_event_condition.conditionname = 'cust_bill_age'
5289 LEFT JOIN part_event_condition_option
5290 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5291 AND part_event_condition_option.optionname = 'age'
5294 #'hashref' => { 'optionname' => $option },
5295 #'hashref' => { 'part_event_option.optionname' => $option },
5297 " WHERE part_event_option.optionname = ". dbh->quote($option).
5298 " AND action = 'cust_bill_send_agent' ".
5299 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5300 " AND peo_agentnum.optionname = 'agentnum' ".
5301 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5303 CASE WHEN part_event_condition_option.optionname IS NULL
5305 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5307 , part_event.weight".
5311 unless ( $part_event_option ) {
5312 return $self->agent->invoice_template || ''
5313 if $option eq 'agent_templatename';
5317 $part_event_option->optionvalue;
5321 sub process_o2m_qsearch {
5324 return qsearch($table, @_) unless $table eq 'contact';
5326 my $hashref = shift;
5327 my %hash = %$hashref;
5328 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5329 or die 'guru meditation #4343';
5331 qsearch({ 'table' => 'contact',
5332 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5333 'hashref' => \%hash,
5334 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5335 " cust_contact.custnum = $custnum "
5339 sub process_o2m_qsearchs {
5342 return qsearchs($table, @_) unless $table eq 'contact';
5344 my $hashref = shift;
5345 my %hash = %$hashref;
5346 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5347 or die 'guru meditation #2121';
5349 qsearchs({ 'table' => 'contact',
5350 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5351 'hashref' => \%hash,
5352 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5353 " cust_contact.custnum = $custnum "
5357 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5359 Subroutine (not a method), designed to be called from the queue.
5361 Takes a list of options and values.
5363 Pulls up the customer record via the custnum option and calls bill_and_collect.
5368 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5370 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5371 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5373 #without this errors don't get rolled back
5374 $args{'fatal'} = 1; # runs from job queue, will be caught
5376 $cust_main->bill_and_collect( %args );
5379 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5381 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5382 C<collect> part. This is used in batch tax calculation, where invoice
5383 generation and collection events have to be completely separated.
5387 sub queued_collect {
5389 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5391 $cust_main->collect(%args);
5394 sub process_bill_and_collect {
5397 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5398 or die "custnum '$param->{custnum}' not found!\n";
5399 $param->{'job'} = $job;
5400 $param->{'fatal'} = 1; # runs from job queue, will be caught
5401 $param->{'retry'} = 1;
5403 $cust_main->bill_and_collect( %$param );
5406 #starting to take quite a while for big dbs
5407 # (JRNL: journaled so it only happens once per database)
5408 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5409 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5410 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5411 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5412 # JRNL leading/trailing spaces in first, last, company
5413 # JRNL migrate to cust_payby
5414 # - otaker upgrade? journal and call it good? (double check to make sure
5415 # we're not still setting otaker here)
5417 #only going to get worse with new location stuff...
5419 sub _upgrade_data { #class method
5420 my ($class, %opts) = @_;
5423 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5426 #this seems to be the only expensive one.. why does it take so long?
5427 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5429 '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';
5430 FS::upgrade_journal->set_done('cust_main__signupdate');
5433 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5435 # fix yyyy-m-dd formatted paydates
5436 if ( driver_name =~ /^mysql/i ) {
5438 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5439 } else { # the SQL standard
5441 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5443 FS::upgrade_journal->set_done('cust_main__paydate');
5446 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5448 push @statements, #fix the weird BILL with a cc# in payinfo problem
5450 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5452 FS::upgrade_journal->set_done('cust_main__payinfo');
5457 foreach my $sql ( @statements ) {
5458 my $sth = dbh->prepare($sql) or die dbh->errstr;
5459 $sth->execute or die $sth->errstr;
5460 #warn ( (time - $t). " seconds\n" );
5464 local($ignore_expired_card) = 1;
5465 local($ignore_banned_card) = 1;
5466 local($skip_fuzzyfiles) = 1;
5467 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5469 unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5471 #we don't want to decrypt them, just stuff them as-is into cust_payby
5472 local(@encrypted_fields) = ();
5474 local($FS::cust_payby::ignore_expired_card) = 1;
5475 local($FS::cust_payby::ignore_banned_card) = 1;
5476 local($FS::cust_payby::ignore_cardtype) = 1;
5478 my @payfields = qw( payby payinfo paycvv paymask
5479 paydate paystart_month paystart_year payissue
5480 payname paystate paytype payip
5483 my $search = new FS::Cursor {
5484 'table' => 'cust_main',
5485 'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5488 while (my $cust_main = $search->fetch) {
5490 unless ( $cust_main->payby =~ /^(BILL|COMP)$/ ) {
5492 my $cust_payby = new FS::cust_payby {
5493 'custnum' => $cust_main->custnum,
5495 map { $_ => $cust_main->$_(); } @payfields
5498 my $error = $cust_payby->insert;
5499 die $error if $error;
5503 # at the time we do this, also migrate paytype into cust_pay_batch
5504 # so that batches that are open before the migration can still be
5506 my @cust_pay_batch = qsearch('cust_pay_batch', {
5507 'custnum' => $cust_main->custnum,
5511 foreach my $cust_pay_batch (@cust_pay_batch) {
5512 $cust_pay_batch->set('paytype', $cust_main->get('paytype'));
5513 my $error = $cust_pay_batch->replace;
5514 die "$error (setting cust_pay_batch.paytype)" if $error;
5517 $cust_main->complimentary('Y') if $cust_main->payby eq 'COMP';
5519 $cust_main->invoice_attn( $cust_main->payname )
5520 if $cust_main->payby eq 'BILL' && $cust_main->payname;
5521 $cust_main->po_number( $cust_main->payinfo )
5522 if $cust_main->payby eq 'BILL' && $cust_main->payinfo;
5524 $cust_main->setfield($_, '') foreach @payfields;
5525 my $error = $cust_main->replace;
5526 die "Error upgradging payment information for custnum ".
5527 $cust_main->custnum. ": $error"
5532 FS::upgrade_journal->set_done('cust_main__cust_payby');
5535 FS::cust_main::Location->_upgrade_data(%opts);
5537 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5539 foreach my $cust_main ( qsearch({
5540 'table' => 'cust_main',
5542 'extra_sql' => 'WHERE '.
5544 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5545 qw( first last company )
5548 my $error = $cust_main->replace;
5549 die $error if $error;
5552 FS::upgrade_journal->set_done('cust_main__trimspaces');
5556 $class->_upgrade_otaker(%opts);
5566 The delete method should possibly take an FS::cust_main object reference
5567 instead of a scalar customer number.
5569 Bill and collect options should probably be passed as references instead of a
5572 There should probably be a configuration file with a list of allowed credit
5575 No multiple currency support (probably a larger project than just this module).
5577 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5579 Birthdates rely on negative epoch values.
5581 The payby for card/check batches is broken. With mixed batching, bad
5584 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5588 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5589 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5590 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.