5 use base qw( FS::cust_main::Packages FS::cust_main::Status
6 FS::cust_main::NationalID
7 FS::cust_main::Billing FS::cust_main::Billing_Realtime
8 FS::cust_main::Billing_Discount
9 FS::cust_main::Location
10 FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
11 FS::geocode_Mixin FS::Quotable_Mixin
15 use vars qw( $DEBUG $me $conf
18 $ignore_expired_card $ignore_banned_card $ignore_illegal_zip
23 use Scalar::Util qw( blessed );
24 use Time::Local qw(timelocal);
25 use Storable qw(thaw);
29 use Digest::MD5 qw(md5_base64);
32 use File::Temp; #qw( tempfile );
33 use Business::CreditCard 0.28;
35 use FS::UID qw( getotaker dbh driver_name );
36 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
37 use FS::Misc qw( generate_email send_email generate_ps do_print );
38 use FS::Msgcat qw(gettext);
45 use FS::cust_bill_void;
46 use FS::legacy_cust_bill;
48 use FS::cust_pay_pending;
49 use FS::cust_pay_void;
50 use FS::cust_pay_batch;
53 use FS::part_referral;
54 use FS::cust_main_county;
55 use FS::cust_location;
57 use FS::cust_main_exemption;
58 use FS::cust_tax_adjustment;
59 use FS::cust_tax_location;
61 use FS::cust_main_invoice;
63 use FS::prepay_credit;
69 use FS::payment_gateway;
70 use FS::agent_payment_gateway;
72 use FS::cust_main_note;
73 use FS::cust_attachment;
76 use FS::upgrade_journal;
78 # 1 is mostly method/subroutine entry and options
79 # 2 traces progress of some operations
80 # 3 is even more information including possibly sensitive data
82 $me = '[FS::cust_main]';
85 $ignore_expired_card = 0;
86 $ignore_banned_card = 0;
90 @encrypted_fields = ('payinfo', 'paycvv');
91 sub nohistory_fields { ('payinfo', 'paycvv'); }
93 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
95 #ask FS::UID to run this stuff for us later
96 #$FS::UID::callback{'FS::cust_main'} = sub {
97 install_callback FS::UID sub {
99 #yes, need it for stuff below (prolly should be cached)
104 my ( $hashref, $cache ) = @_;
105 if ( exists $hashref->{'pkgnum'} ) {
106 #@{ $self->{'_pkgnum'} } = ();
107 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
108 $self->{'_pkgnum'} = $subcache;
109 #push @{ $self->{'_pkgnum'} },
110 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
116 FS::cust_main - Object methods for cust_main records
122 $record = new FS::cust_main \%hash;
123 $record = new FS::cust_main { 'column' => 'value' };
125 $error = $record->insert;
127 $error = $new_record->replace($old_record);
129 $error = $record->delete;
131 $error = $record->check;
133 @cust_pkg = $record->all_pkgs;
135 @cust_pkg = $record->ncancelled_pkgs;
137 @cust_pkg = $record->suspended_pkgs;
139 $error = $record->bill;
140 $error = $record->bill %options;
141 $error = $record->bill 'time' => $time;
143 $error = $record->collect;
144 $error = $record->collect %options;
145 $error = $record->collect 'invoice_time' => $time,
150 An FS::cust_main object represents a customer. FS::cust_main inherits from
151 FS::Record. The following fields are currently supported:
157 Primary key (assigned automatically for new customers)
161 Agent (see L<FS::agent>)
165 Advertising source (see L<FS::part_referral>)
177 Cocial security number (optional)
201 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
205 Payment Information (See L<FS::payinfo_Mixin> for data format)
209 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
213 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
217 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
221 Start date month (maestro/solo cards only)
225 Start date year (maestro/solo cards only)
229 Issue number (maestro/solo cards only)
233 Name on card or billing name
237 IP address from which payment information was received
241 Tax exempt, empty or `Y'
245 Order taker (see L<FS::access_user>)
251 =item referral_custnum
253 Referring customer number
257 Enable individual CDR spooling, empty or `Y'
261 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
265 Discourage individual CDR printing, empty or `Y'
269 Allow self-service editing of ticket subjects, empty or 'Y'
271 =item calling_list_exempt
273 Do not call, empty or 'Y'
283 Creates a new customer. To add the customer to the database, see L<"insert">.
285 Note that this stores the hash reference, not a distinct copy of the hash it
286 points to. You can ask the object for a copy with the I<hash> method.
290 sub table { 'cust_main'; }
292 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
294 Adds this customer to the database. If there is an error, returns the error,
295 otherwise returns false.
297 Usually the customer's location will not yet exist in the database, and
298 the C<bill_location> and C<ship_location> pseudo-fields must be set to
299 uninserted L<FS::cust_location> objects. These will be inserted and linked
300 (in both directions) to the new customer record. If they're references
301 to the same object, they will become the same location.
303 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
304 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
305 are inserted atomicly, or the transaction is rolled back. Passing an empty
306 hash reference is equivalent to not supplying this parameter. There should be
307 a better explanation of this, but until then, here's an example:
310 tie %hash, 'Tie::RefHash'; #this part is important
312 $cust_pkg => [ $svc_acct ],
315 $cust_main->insert( \%hash );
317 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
318 be set as the invoicing list (see L<"invoicing_list">). Errors return as
319 expected and rollback the entire transaction; it is not necessary to call
320 check_invoicing_list first. The invoicing_list is set after the records in the
321 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
322 invoicing_list destination to the newly-created svc_acct. Here's an example:
324 $cust_main->insert( {}, [ $email, 'POST' ] );
326 Currently available options are: I<depend_jobnum>, I<noexport>,
327 I<tax_exemption> and I<prospectnum>.
329 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
330 on the supplied jobnum (they will not run until the specific job completes).
331 This can be used to defer provisioning until some action completes (such
332 as running the customer's credit card successfully).
334 The I<noexport> option is deprecated. If I<noexport> is set true, no
335 provisioning jobs (exports) are scheduled. (You can schedule them later with
336 the B<reexport> method.)
338 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
339 of tax names and exemption numbers. FS::cust_main_exemption records will be
340 created and inserted.
342 If I<prospectnum> is set, moves contacts and locations from that prospect.
348 my $cust_pkgs = @_ ? shift : {};
349 my $invoicing_list = @_ ? shift : '';
351 warn "$me insert called with options ".
352 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
355 local $SIG{HUP} = 'IGNORE';
356 local $SIG{INT} = 'IGNORE';
357 local $SIG{QUIT} = 'IGNORE';
358 local $SIG{TERM} = 'IGNORE';
359 local $SIG{TSTP} = 'IGNORE';
360 local $SIG{PIPE} = 'IGNORE';
362 my $oldAutoCommit = $FS::UID::AutoCommit;
363 local $FS::UID::AutoCommit = 0;
366 my $prepay_identifier = '';
367 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
369 if ( $self->payby eq 'PREPAY' ) {
371 $self->payby('BILL');
372 $prepay_identifier = $self->payinfo;
375 warn " looking up prepaid card $prepay_identifier\n"
378 my $error = $self->get_prepay( $prepay_identifier,
379 'amount_ref' => \$amount,
380 'seconds_ref' => \$seconds,
381 'upbytes_ref' => \$upbytes,
382 'downbytes_ref' => \$downbytes,
383 'totalbytes_ref' => \$totalbytes,
386 $dbh->rollback if $oldAutoCommit;
387 #return "error applying prepaid card (transaction rolled back): $error";
391 $payby = 'PREP' if $amount;
393 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
396 $self->payby('BILL');
397 $amount = $self->paid;
402 foreach my $l (qw(bill_location ship_location)) {
403 my $loc = delete $self->hashref->{$l};
404 # XXX if we're moving a prospect's locations, do that here
409 if ( !$loc->locationnum ) {
410 # warn the location that we're going to insert it with no custnum
411 $loc->set(custnum_pending => 1);
412 warn " inserting $l\n"
414 my $error = $loc->insert;
416 $dbh->rollback if $oldAutoCommit;
417 my $label = $l eq 'ship_location' ? 'service' : 'billing';
418 return "$error (in $label location)";
421 elsif ( ($loc->custnum || 0) > 0 or $loc->prospectnum ) {
422 # then it somehow belongs to another customer--shouldn't happen
423 $dbh->rollback if $oldAutoCommit;
424 return "$l belongs to customer ".$loc->custnum;
426 # else it already belongs to this customer
427 # (happens when ship_location is identical to bill_location)
429 $self->set($l.'num', $loc->locationnum);
431 if ( $self->get($l.'num') eq '' ) {
432 $dbh->rollback if $oldAutoCommit;
437 warn " inserting $self\n"
440 $self->signupdate(time) unless $self->signupdate;
442 $self->auto_agent_custid()
443 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
445 my $error = $self->SUPER::insert;
447 $dbh->rollback if $oldAutoCommit;
448 #return "inserting cust_main record (transaction rolled back): $error";
452 # now set cust_location.custnum
453 foreach my $l (qw(bill_location ship_location)) {
454 warn " setting $l.custnum\n"
457 unless ( $loc->custnum ) {
458 $loc->set(custnum => $self->custnum);
459 $error ||= $loc->replace;
463 $dbh->rollback if $oldAutoCommit;
464 return "error setting $l custnum: $error";
468 warn " setting invoicing list\n"
471 if ( $invoicing_list ) {
472 $error = $self->check_invoicing_list( $invoicing_list );
474 $dbh->rollback if $oldAutoCommit;
475 #return "checking invoicing_list (transaction rolled back): $error";
478 $self->invoicing_list( $invoicing_list );
481 warn " setting customer tags\n"
484 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
485 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
486 'custnum' => $self->custnum };
487 my $error = $cust_tag->insert;
489 $dbh->rollback if $oldAutoCommit;
494 my $prospectnum = delete $options{'prospectnum'};
495 if ( $prospectnum ) {
497 warn " moving contacts and locations from prospect $prospectnum\n"
501 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
502 unless ( $prospect_main ) {
503 $dbh->rollback if $oldAutoCommit;
504 return "Unknown prospectnum $prospectnum";
506 $prospect_main->custnum($self->custnum);
507 $prospect_main->disabled('Y');
508 my $error = $prospect_main->replace;
510 $dbh->rollback if $oldAutoCommit;
514 my @contact = $prospect_main->contact;
515 my @cust_location = $prospect_main->cust_location;
516 my @qual = $prospect_main->qual;
518 foreach my $r ( @contact, @cust_location, @qual ) {
520 $r->custnum($self->custnum);
521 my $error = $r->replace;
523 $dbh->rollback if $oldAutoCommit;
530 warn " setting cust_main_exemption\n"
533 my $tax_exemption = delete $options{'tax_exemption'};
534 if ( $tax_exemption ) {
536 $tax_exemption = { map { $_ => '' } @$tax_exemption }
537 if ref($tax_exemption) eq 'ARRAY';
539 foreach my $taxname ( keys %$tax_exemption ) {
540 my $cust_main_exemption = new FS::cust_main_exemption {
541 'custnum' => $self->custnum,
542 'taxname' => $taxname,
543 'exempt_number' => $tax_exemption->{$taxname},
545 my $error = $cust_main_exemption->insert;
547 $dbh->rollback if $oldAutoCommit;
548 return "inserting cust_main_exemption (transaction rolled back): $error";
553 warn " ordering packages\n"
556 $error = $self->order_pkgs( $cust_pkgs,
558 'seconds_ref' => \$seconds,
559 'upbytes_ref' => \$upbytes,
560 'downbytes_ref' => \$downbytes,
561 'totalbytes_ref' => \$totalbytes,
564 $dbh->rollback if $oldAutoCommit;
569 $dbh->rollback if $oldAutoCommit;
570 return "No svc_acct record to apply pre-paid time";
572 if ( $upbytes || $downbytes || $totalbytes ) {
573 $dbh->rollback if $oldAutoCommit;
574 return "No svc_acct record to apply pre-paid data";
578 warn " inserting initial $payby payment of $amount\n"
580 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
582 $dbh->rollback if $oldAutoCommit;
583 return "inserting payment (transaction rolled back): $error";
587 unless ( $import || $skip_fuzzyfiles ) {
588 warn " queueing fuzzyfiles update\n"
590 $error = $self->queue_fuzzyfiles_update;
592 $dbh->rollback if $oldAutoCommit;
593 return "updating fuzzy search cache: $error";
597 # FS::geocode_Mixin::after_insert or something?
598 if ( $conf->config('tax_district_method') and !$import ) {
599 # if anything non-empty, try to look it up
600 my $queue = new FS::queue {
601 'job' => 'FS::geocode_Mixin::process_district_update',
602 'custnum' => $self->custnum,
604 my $error = $queue->insert( ref($self), $self->custnum );
606 $dbh->rollback if $oldAutoCommit;
607 return "queueing tax district update: $error";
612 warn " exporting\n" if $DEBUG > 1;
614 my $export_args = $options{'export_args'} || [];
617 map qsearch( 'part_export', {exportnum=>$_} ),
618 $conf->config('cust_main-exports'); #, $agentnum
620 foreach my $part_export ( @part_export ) {
621 my $error = $part_export->export_insert($self, @$export_args);
623 $dbh->rollback if $oldAutoCommit;
624 return "exporting to ". $part_export->exporttype.
625 " (transaction rolled back): $error";
629 #foreach my $depend_jobnum ( @$depend_jobnums ) {
630 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
632 # foreach my $jobnum ( @jobnums ) {
633 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
634 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
636 # my $error = $queue->depend_insert($depend_jobnum);
638 # $dbh->rollback if $oldAutoCommit;
639 # return "error queuing job dependancy: $error";
646 #if ( exists $options{'jobnums'} ) {
647 # push @{ $options{'jobnums'} }, @jobnums;
650 warn " insert complete; committing transaction\n"
653 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
658 use File::CounterFile;
659 sub auto_agent_custid {
662 my $format = $conf->config('cust_main-auto_agent_custid');
664 if ( $format eq '1YMMXXXXXXXX' ) {
666 my $counter = new File::CounterFile 'cust_main.agent_custid';
669 my $ym = 100000000000 + time2str('%y%m00000000', time);
670 if ( $ym > $counter->value ) {
671 $counter->{'value'} = $agent_custid = $ym;
672 $counter->{'updated'} = 1;
674 $agent_custid = $counter->inc;
680 die "Unknown cust_main-auto_agent_custid format: $format";
683 $self->agent_custid($agent_custid);
687 =item PACKAGE METHODS
689 Documentation on customer package methods has been moved to
690 L<FS::cust_main::Packages>.
692 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
694 Recharges this (existing) customer with the specified prepaid card (see
695 L<FS::prepay_credit>), specified either by I<identifier> or as an
696 FS::prepay_credit object. If there is an error, returns the error, otherwise
699 Optionally, five scalar references can be passed as well. They will have their
700 values filled in with the amount, number of seconds, and number of upload,
701 download, and total bytes applied by this prepaid card.
705 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
706 #the only place that uses these args
707 sub recharge_prepay {
708 my( $self, $prepay_credit, $amountref, $secondsref,
709 $upbytesref, $downbytesref, $totalbytesref ) = @_;
711 local $SIG{HUP} = 'IGNORE';
712 local $SIG{INT} = 'IGNORE';
713 local $SIG{QUIT} = 'IGNORE';
714 local $SIG{TERM} = 'IGNORE';
715 local $SIG{TSTP} = 'IGNORE';
716 local $SIG{PIPE} = 'IGNORE';
718 my $oldAutoCommit = $FS::UID::AutoCommit;
719 local $FS::UID::AutoCommit = 0;
722 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
724 my $error = $self->get_prepay( $prepay_credit,
725 'amount_ref' => \$amount,
726 'seconds_ref' => \$seconds,
727 'upbytes_ref' => \$upbytes,
728 'downbytes_ref' => \$downbytes,
729 'totalbytes_ref' => \$totalbytes,
731 || $self->increment_seconds($seconds)
732 || $self->increment_upbytes($upbytes)
733 || $self->increment_downbytes($downbytes)
734 || $self->increment_totalbytes($totalbytes)
735 || $self->insert_cust_pay_prepay( $amount,
737 ? $prepay_credit->identifier
742 $dbh->rollback if $oldAutoCommit;
746 if ( defined($amountref) ) { $$amountref = $amount; }
747 if ( defined($secondsref) ) { $$secondsref = $seconds; }
748 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
749 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
750 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
752 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
757 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
759 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
760 specified either by I<identifier> or as an FS::prepay_credit object.
762 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
763 incremented by the values of the prepaid card.
765 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
766 check or set this customer's I<agentnum>.
768 If there is an error, returns the error, otherwise returns false.
774 my( $self, $prepay_credit, %opt ) = @_;
776 local $SIG{HUP} = 'IGNORE';
777 local $SIG{INT} = 'IGNORE';
778 local $SIG{QUIT} = 'IGNORE';
779 local $SIG{TERM} = 'IGNORE';
780 local $SIG{TSTP} = 'IGNORE';
781 local $SIG{PIPE} = 'IGNORE';
783 my $oldAutoCommit = $FS::UID::AutoCommit;
784 local $FS::UID::AutoCommit = 0;
787 unless ( ref($prepay_credit) ) {
789 my $identifier = $prepay_credit;
791 $prepay_credit = qsearchs(
793 { 'identifier' => $identifier },
798 unless ( $prepay_credit ) {
799 $dbh->rollback if $oldAutoCommit;
800 return "Invalid prepaid card: ". $identifier;
805 if ( $prepay_credit->agentnum ) {
806 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
807 $dbh->rollback if $oldAutoCommit;
808 return "prepaid card not valid for agent ". $self->agentnum;
810 $self->agentnum($prepay_credit->agentnum);
813 my $error = $prepay_credit->delete;
815 $dbh->rollback if $oldAutoCommit;
816 return "removing prepay_credit (transaction rolled back): $error";
819 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
820 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
822 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
827 =item increment_upbytes SECONDS
829 Updates this customer's single or primary account (see L<FS::svc_acct>) by
830 the specified number of upbytes. If there is an error, returns the error,
831 otherwise returns false.
835 sub increment_upbytes {
836 _increment_column( shift, 'upbytes', @_);
839 =item increment_downbytes SECONDS
841 Updates this customer's single or primary account (see L<FS::svc_acct>) by
842 the specified number of downbytes. If there is an error, returns the error,
843 otherwise returns false.
847 sub increment_downbytes {
848 _increment_column( shift, 'downbytes', @_);
851 =item increment_totalbytes SECONDS
853 Updates this customer's single or primary account (see L<FS::svc_acct>) by
854 the specified number of totalbytes. If there is an error, returns the error,
855 otherwise returns false.
859 sub increment_totalbytes {
860 _increment_column( shift, 'totalbytes', @_);
863 =item increment_seconds SECONDS
865 Updates this customer's single or primary account (see L<FS::svc_acct>) by
866 the specified number of seconds. If there is an error, returns the error,
867 otherwise returns false.
871 sub increment_seconds {
872 _increment_column( shift, 'seconds', @_);
875 =item _increment_column AMOUNT
877 Updates this customer's single or primary account (see L<FS::svc_acct>) by
878 the specified number of seconds or bytes. If there is an error, returns
879 the error, otherwise returns false.
883 sub _increment_column {
884 my( $self, $column, $amount ) = @_;
885 warn "$me increment_column called: $column, $amount\n"
888 return '' unless $amount;
890 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
891 $self->ncancelled_pkgs;
894 return 'No packages with primary or single services found'.
895 ' to apply pre-paid time';
896 } elsif ( scalar(@cust_pkg) > 1 ) {
897 #maybe have a way to specify the package/account?
898 return 'Multiple packages found to apply pre-paid time';
901 my $cust_pkg = $cust_pkg[0];
902 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
906 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
909 return 'No account found to apply pre-paid time';
910 } elsif ( scalar(@cust_svc) > 1 ) {
911 return 'Multiple accounts found to apply pre-paid time';
914 my $svc_acct = $cust_svc[0]->svc_x;
915 warn " found service svcnum ". $svc_acct->pkgnum.
916 ' ('. $svc_acct->email. ")\n"
919 $column = "increment_$column";
920 $svc_acct->$column($amount);
924 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
926 Inserts a prepayment in the specified amount for this customer. An optional
927 second argument can specify the prepayment identifier for tracking purposes.
928 If there is an error, returns the error, otherwise returns false.
932 sub insert_cust_pay_prepay {
933 shift->insert_cust_pay('PREP', @_);
936 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
938 Inserts a cash payment in the specified amount for this customer. An optional
939 second argument can specify the payment identifier for tracking purposes.
940 If there is an error, returns the error, otherwise returns false.
944 sub insert_cust_pay_cash {
945 shift->insert_cust_pay('CASH', @_);
948 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
950 Inserts a Western Union payment in the specified amount for this customer. An
951 optional second argument can specify the prepayment identifier for tracking
952 purposes. If there is an error, returns the error, otherwise returns false.
956 sub insert_cust_pay_west {
957 shift->insert_cust_pay('WEST', @_);
960 sub insert_cust_pay {
961 my( $self, $payby, $amount ) = splice(@_, 0, 3);
962 my $payinfo = scalar(@_) ? shift : '';
964 my $cust_pay = new FS::cust_pay {
965 'custnum' => $self->custnum,
966 'paid' => sprintf('%.2f', $amount),
967 #'_date' => #date the prepaid card was purchased???
969 'payinfo' => $payinfo,
977 This method is deprecated. See the I<depend_jobnum> option to the insert and
978 order_pkgs methods for a better way to defer provisioning.
980 Re-schedules all exports by calling the B<reexport> method of all associated
981 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
982 otherwise returns false.
989 carp "WARNING: FS::cust_main::reexport is deprectated; ".
990 "use the depend_jobnum option to insert or order_pkgs to delay export";
992 local $SIG{HUP} = 'IGNORE';
993 local $SIG{INT} = 'IGNORE';
994 local $SIG{QUIT} = 'IGNORE';
995 local $SIG{TERM} = 'IGNORE';
996 local $SIG{TSTP} = 'IGNORE';
997 local $SIG{PIPE} = 'IGNORE';
999 my $oldAutoCommit = $FS::UID::AutoCommit;
1000 local $FS::UID::AutoCommit = 0;
1003 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1004 my $error = $cust_pkg->reexport;
1006 $dbh->rollback if $oldAutoCommit;
1011 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1016 =item delete [ OPTION => VALUE ... ]
1018 This deletes the customer. If there is an error, returns the error, otherwise
1021 This will completely remove all traces of the customer record. This is not
1022 what you want when a customer cancels service; for that, cancel all of the
1023 customer's packages (see L</cancel>).
1025 If the customer has any uncancelled packages, you need to pass a new (valid)
1026 customer number for those packages to be transferred to, as the "new_customer"
1027 option. Cancelled packages will be deleted. Did I mention that this is NOT
1028 what you want when a customer cancels service and that you really should be
1029 looking at L<FS::cust_pkg/cancel>?
1031 You can't delete a customer with invoices (see L<FS::cust_bill>),
1032 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1033 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1034 set the "delete_financials" option to a true value.
1039 my( $self, %opt ) = @_;
1041 local $SIG{HUP} = 'IGNORE';
1042 local $SIG{INT} = 'IGNORE';
1043 local $SIG{QUIT} = 'IGNORE';
1044 local $SIG{TERM} = 'IGNORE';
1045 local $SIG{TSTP} = 'IGNORE';
1046 local $SIG{PIPE} = 'IGNORE';
1048 my $oldAutoCommit = $FS::UID::AutoCommit;
1049 local $FS::UID::AutoCommit = 0;
1052 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1053 $dbh->rollback if $oldAutoCommit;
1054 return "Can't delete a master agent customer";
1057 #use FS::access_user
1058 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1059 $dbh->rollback if $oldAutoCommit;
1060 return "Can't delete a master employee customer";
1063 tie my %financial_tables, 'Tie::IxHash',
1064 'cust_bill' => 'invoices',
1065 'cust_statement' => 'statements',
1066 'cust_credit' => 'credits',
1067 'cust_pay' => 'payments',
1068 'cust_refund' => 'refunds',
1071 foreach my $table ( keys %financial_tables ) {
1073 my @records = $self->$table();
1075 if ( @records && ! $opt{'delete_financials'} ) {
1076 $dbh->rollback if $oldAutoCommit;
1077 return "Can't delete a customer with ". $financial_tables{$table};
1080 foreach my $record ( @records ) {
1081 my $error = $record->delete;
1083 $dbh->rollback if $oldAutoCommit;
1084 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1090 my @cust_pkg = $self->ncancelled_pkgs;
1092 my $new_custnum = $opt{'new_custnum'};
1093 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1094 $dbh->rollback if $oldAutoCommit;
1095 return "Invalid new customer number: $new_custnum";
1097 foreach my $cust_pkg ( @cust_pkg ) {
1098 my %hash = $cust_pkg->hash;
1099 $hash{'custnum'} = $new_custnum;
1100 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1101 my $error = $new_cust_pkg->replace($cust_pkg,
1102 options => { $cust_pkg->options },
1105 $dbh->rollback if $oldAutoCommit;
1110 my @cancelled_cust_pkg = $self->all_pkgs;
1111 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1112 my $error = $cust_pkg->delete;
1114 $dbh->rollback if $oldAutoCommit;
1119 #cust_tax_adjustment in financials?
1120 #cust_pay_pending? ouch
1122 foreach my $table (qw(
1123 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1124 cust_location cust_main_note cust_tax_adjustment
1125 cust_pay_void cust_pay_batch queue cust_tax_exempt
1127 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1128 my $error = $record->delete;
1130 $dbh->rollback if $oldAutoCommit;
1136 my $sth = $dbh->prepare(
1137 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1139 my $errstr = $dbh->errstr;
1140 $dbh->rollback if $oldAutoCommit;
1143 $sth->execute($self->custnum) or do {
1144 my $errstr = $sth->errstr;
1145 $dbh->rollback if $oldAutoCommit;
1151 my $ticket_dbh = '';
1152 if ($conf->config('ticket_system') eq 'RT_Internal') {
1154 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1155 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1156 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1157 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1160 if ( $ticket_dbh ) {
1162 my $ticket_sth = $ticket_dbh->prepare(
1163 'DELETE FROM Links WHERE Target = ?'
1165 my $errstr = $ticket_dbh->errstr;
1166 $dbh->rollback if $oldAutoCommit;
1169 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1171 my $errstr = $ticket_sth->errstr;
1172 $dbh->rollback if $oldAutoCommit;
1176 #check and see if the customer is the only link on the ticket, and
1177 #if so, set the ticket to deleted status in RT?
1178 #maybe someday, for now this will at least fix tickets not displaying
1182 #delete the customer record
1184 my $error = $self->SUPER::delete;
1186 $dbh->rollback if $oldAutoCommit;
1190 # cust_main exports!
1192 #my $export_args = $options{'export_args'} || [];
1195 map qsearch( 'part_export', {exportnum=>$_} ),
1196 $conf->config('cust_main-exports'); #, $agentnum
1198 foreach my $part_export ( @part_export ) {
1199 my $error = $part_export->export_delete( $self ); #, @$export_args);
1201 $dbh->rollback if $oldAutoCommit;
1202 return "exporting to ". $part_export->exporttype.
1203 " (transaction rolled back): $error";
1207 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1212 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1214 This merges this customer into the provided new custnum, and then deletes the
1215 customer. If there is an error, returns the error, otherwise returns false.
1217 The source customer's name, company name, phone numbers, agent,
1218 referring customer, customer class, advertising source, order taker, and
1219 billing information (except balance) are discarded.
1221 All packages are moved to the target customer. Packages with package locations
1222 are preserved. Packages without package locations are moved to a new package
1223 location with the source customer's service/shipping address.
1225 All invoices, statements, payments, credits and refunds are moved to the target
1226 customer. The source customer's balance is added to the target customer.
1228 All notes, attachments, tickets and customer tags are moved to the target
1231 Change history is not currently moved.
1236 my( $self, $new_custnum, %opt ) = @_;
1238 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1240 my $new_cust_main = qsearchs( 'cust_main', { 'custnum' => $new_custnum } )
1241 or return "Invalid new customer number: $new_custnum";
1243 return 'Access denied: "Merge customer across agents" access right required to merge into a customer of a different agent'
1244 if $self->agentnum != $new_cust_main->agentnum
1245 && ! $FS::CurrentUser::CurrentUser->access_right('Merge customer across agents');
1247 local $SIG{HUP} = 'IGNORE';
1248 local $SIG{INT} = 'IGNORE';
1249 local $SIG{QUIT} = 'IGNORE';
1250 local $SIG{TERM} = 'IGNORE';
1251 local $SIG{TSTP} = 'IGNORE';
1252 local $SIG{PIPE} = 'IGNORE';
1254 my $oldAutoCommit = $FS::UID::AutoCommit;
1255 local $FS::UID::AutoCommit = 0;
1258 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1259 $dbh->rollback if $oldAutoCommit;
1260 return "Can't merge a master agent customer";
1263 #use FS::access_user
1264 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1265 $dbh->rollback if $oldAutoCommit;
1266 return "Can't merge a master employee customer";
1269 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1270 'status' => { op=>'!=', value=>'done' },
1274 $dbh->rollback if $oldAutoCommit;
1275 return "Can't merge a customer with pending payments";
1278 tie my %financial_tables, 'Tie::IxHash',
1279 'cust_bill' => 'invoices',
1280 'cust_bill_void' => 'voided invoices',
1281 'cust_statement' => 'statements',
1282 'cust_credit' => 'credits',
1283 'cust_pay' => 'payments',
1284 'cust_pay_void' => 'voided payments',
1285 'cust_refund' => 'refunds',
1288 foreach my $table ( keys %financial_tables ) {
1290 my @records = $self->$table();
1292 foreach my $record ( @records ) {
1293 $record->custnum($new_custnum);
1294 my $error = $record->replace;
1296 $dbh->rollback if $oldAutoCommit;
1297 return "Error merging ". $financial_tables{$table}. ": $error\n";
1303 my $name = $self->ship_name; #?
1305 my $locationnum = '';
1306 foreach my $cust_pkg ( $self->all_pkgs ) {
1307 $cust_pkg->custnum($new_custnum);
1309 unless ( $cust_pkg->locationnum ) {
1310 unless ( $locationnum ) {
1311 my $cust_location = new FS::cust_location {
1312 $self->location_hash,
1313 'custnum' => $new_custnum,
1315 my $error = $cust_location->insert;
1317 $dbh->rollback if $oldAutoCommit;
1320 $locationnum = $cust_location->locationnum;
1322 $cust_pkg->locationnum($locationnum);
1325 my $error = $cust_pkg->replace;
1327 $dbh->rollback if $oldAutoCommit;
1331 # add customer (ship) name to svc_phone.phone_name if blank
1332 my @cust_svc = $cust_pkg->cust_svc;
1333 foreach my $cust_svc (@cust_svc) {
1334 my($label, $value, $svcdb) = $cust_svc->label;
1335 next unless $svcdb eq 'svc_phone';
1336 my $svc_phone = $cust_svc->svc_x;
1337 next if $svc_phone->phone_name;
1338 $svc_phone->phone_name($name);
1339 my $error = $svc_phone->replace;
1341 $dbh->rollback if $oldAutoCommit;
1349 # cust_tax_exempt (texas tax exemptions)
1350 # cust_recon (some sort of not-well understood thing for OnPac)
1352 #these are moved over
1353 foreach my $table (qw(
1354 cust_tag cust_location contact cust_attachment cust_main_note
1355 cust_tax_adjustment cust_pay_batch queue
1357 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1358 $record->custnum($new_custnum);
1359 my $error = $record->replace;
1361 $dbh->rollback if $oldAutoCommit;
1367 #these aren't preserved
1368 foreach my $table (qw(
1369 cust_main_exemption cust_main_invoice
1371 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1372 my $error = $record->delete;
1374 $dbh->rollback if $oldAutoCommit;
1381 my $sth = $dbh->prepare(
1382 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1384 my $errstr = $dbh->errstr;
1385 $dbh->rollback if $oldAutoCommit;
1388 $sth->execute($new_custnum, $self->custnum) or do {
1389 my $errstr = $sth->errstr;
1390 $dbh->rollback if $oldAutoCommit;
1396 my $ticket_dbh = '';
1397 if ($conf->config('ticket_system') eq 'RT_Internal') {
1399 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1400 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1401 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1402 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1405 if ( $ticket_dbh ) {
1407 my $ticket_sth = $ticket_dbh->prepare(
1408 'UPDATE Links SET Target = ? WHERE Target = ?'
1410 my $errstr = $ticket_dbh->errstr;
1411 $dbh->rollback if $oldAutoCommit;
1414 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1415 'freeside://freeside/cust_main/'.$self->custnum)
1417 my $errstr = $ticket_sth->errstr;
1418 $dbh->rollback if $oldAutoCommit;
1424 #delete the customer record
1426 my $error = $self->delete;
1428 $dbh->rollback if $oldAutoCommit;
1432 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1437 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1439 Replaces the OLD_RECORD with this one in the database. If there is an error,
1440 returns the error, otherwise returns false.
1442 To change the customer's address, set the pseudo-fields C<bill_location> and
1443 C<ship_location>. The address will still only change if at least one of the
1444 address fields differs from the existing values.
1446 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1447 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1448 expected and rollback the entire transaction; it is not necessary to call
1449 check_invoicing_list first. Here's an example:
1451 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1453 Currently available options are: I<tax_exemption>.
1455 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1456 of tax names and exemption numbers. FS::cust_main_exemption records will be
1457 deleted and inserted as appropriate.
1464 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1466 : $self->replace_old;
1470 warn "$me replace called\n"
1473 my $curuser = $FS::CurrentUser::CurrentUser;
1474 if ( $self->payby eq 'COMP'
1475 && $self->payby ne $old->payby
1476 && ! $curuser->access_right('Complimentary customer')
1479 return "You are not permitted to create complimentary accounts.";
1482 local($ignore_expired_card) = 1
1483 if $old->payby =~ /^(CARD|DCRD)$/
1484 && $self->payby =~ /^(CARD|DCRD)$/
1485 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1487 local($ignore_banned_card) = 1
1488 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1489 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1490 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1492 return "Invoicing locale is required"
1495 && $conf->exists('cust_main-require_locale');
1497 local $SIG{HUP} = 'IGNORE';
1498 local $SIG{INT} = 'IGNORE';
1499 local $SIG{QUIT} = 'IGNORE';
1500 local $SIG{TERM} = 'IGNORE';
1501 local $SIG{TSTP} = 'IGNORE';
1502 local $SIG{PIPE} = 'IGNORE';
1504 my $oldAutoCommit = $FS::UID::AutoCommit;
1505 local $FS::UID::AutoCommit = 0;
1508 for my $l (qw(bill_location ship_location)) {
1509 my $old_loc = $old->$l;
1510 my $new_loc = $self->$l;
1512 if ( !$new_loc->locationnum ) {
1514 # If the new location is all empty fields, or if it's identical to
1515 # the old location in all fields, don't replace.
1516 my @nonempty = grep { $new_loc->$_ } $self->location_fields;
1518 my @unlike = grep { $new_loc->$_ ne $old_loc->$_ } $self->location_fields;
1520 if ( @unlike or $old_loc->disabled ) {
1521 warn " changed $l fields: ".join(',',@unlike)."\n"
1523 $new_loc->set(custnum => $self->custnum);
1525 # insert it--the old location will be disabled later
1526 my $error = $new_loc->insert;
1528 $dbh->rollback if $oldAutoCommit;
1533 # no fields have changed and $old_loc isn't disabled, so don't change it
1538 elsif ( $new_loc->custnum ne $self->custnum or $new_loc->prospectnum ) {
1539 $dbh->rollback if $oldAutoCommit;
1540 return "$l belongs to customer ".$new_loc->custnum;
1542 # else the new location belongs to this customer so we're good
1544 # set the foo_locationnum now that we have one.
1545 $self->set($l.'num', $new_loc->locationnum);
1549 my $error = $self->SUPER::replace($old);
1552 $dbh->rollback if $oldAutoCommit;
1556 # now move packages to the new service location
1557 $self->set('ship_location', ''); #flush cache
1558 if ( $old->ship_locationnum and # should only be null during upgrade...
1559 $old->ship_locationnum != $self->ship_locationnum ) {
1560 $error = $old->ship_location->move_to($self->ship_location);
1562 $dbh->rollback if $oldAutoCommit;
1566 # don't move packages based on the billing location, but
1567 # disable it if it's no longer in use
1568 if ( $old->bill_locationnum and
1569 $old->bill_locationnum != $self->bill_locationnum ) {
1570 $error = $old->bill_location->disable_if_unused;
1572 $dbh->rollback if $oldAutoCommit;
1577 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1578 my $invoicing_list = shift @param;
1579 $error = $self->check_invoicing_list( $invoicing_list );
1581 $dbh->rollback if $oldAutoCommit;
1584 $self->invoicing_list( $invoicing_list );
1587 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1589 #this could be more efficient than deleting and re-inserting, if it matters
1590 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1591 my $error = $cust_tag->delete;
1593 $dbh->rollback if $oldAutoCommit;
1597 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1598 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1599 'custnum' => $self->custnum };
1600 my $error = $cust_tag->insert;
1602 $dbh->rollback if $oldAutoCommit;
1609 my %options = @param;
1611 my $tax_exemption = delete $options{'tax_exemption'};
1612 if ( $tax_exemption ) {
1614 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1615 if ref($tax_exemption) eq 'ARRAY';
1617 my %cust_main_exemption =
1618 map { $_->taxname => $_ }
1619 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1621 foreach my $taxname ( keys %$tax_exemption ) {
1623 if ( $cust_main_exemption{$taxname} &&
1624 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1627 delete $cust_main_exemption{$taxname};
1631 my $cust_main_exemption = new FS::cust_main_exemption {
1632 'custnum' => $self->custnum,
1633 'taxname' => $taxname,
1634 'exempt_number' => $tax_exemption->{$taxname},
1636 my $error = $cust_main_exemption->insert;
1638 $dbh->rollback if $oldAutoCommit;
1639 return "inserting cust_main_exemption (transaction rolled back): $error";
1643 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1644 my $error = $cust_main_exemption->delete;
1646 $dbh->rollback if $oldAutoCommit;
1647 return "deleting cust_main_exemption (transaction rolled back): $error";
1653 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1654 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1655 && $self->get('payinfo') !~ /^99\d{14}$/
1657 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1662 # card/check/lec info has changed, want to retry realtime_ invoice events
1663 my $error = $self->retry_realtime;
1665 $dbh->rollback if $oldAutoCommit;
1670 unless ( $import || $skip_fuzzyfiles ) {
1671 $error = $self->queue_fuzzyfiles_update;
1673 $dbh->rollback if $oldAutoCommit;
1674 return "updating fuzzy search cache: $error";
1678 # tax district update in cust_location
1680 # cust_main exports!
1682 my $export_args = $options{'export_args'} || [];
1685 map qsearch( 'part_export', {exportnum=>$_} ),
1686 $conf->config('cust_main-exports'); #, $agentnum
1688 foreach my $part_export ( @part_export ) {
1689 my $error = $part_export->export_replace( $self, $old, @$export_args);
1691 $dbh->rollback if $oldAutoCommit;
1692 return "exporting to ". $part_export->exporttype.
1693 " (transaction rolled back): $error";
1697 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1702 =item queue_fuzzyfiles_update
1704 Used by insert & replace to update the fuzzy search cache
1708 use FS::cust_main::Search;
1709 sub queue_fuzzyfiles_update {
1712 local $SIG{HUP} = 'IGNORE';
1713 local $SIG{INT} = 'IGNORE';
1714 local $SIG{QUIT} = 'IGNORE';
1715 local $SIG{TERM} = 'IGNORE';
1716 local $SIG{TSTP} = 'IGNORE';
1717 local $SIG{PIPE} = 'IGNORE';
1719 my $oldAutoCommit = $FS::UID::AutoCommit;
1720 local $FS::UID::AutoCommit = 0;
1723 my @locations = $self->bill_location;
1724 push @locations, $self->ship_location if $self->has_ship_address;
1725 foreach my $location (@locations) {
1726 my $queue = new FS::queue {
1727 'job' => 'FS::cust_main::Search::append_fuzzyfiles'
1729 my @args = map $location->get($_), @FS::cust_main::Search::fuzzyfields;
1730 my $error = $queue->insert( @args );
1732 $dbh->rollback if $oldAutoCommit;
1733 return "queueing job (transaction rolled back): $error";
1737 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1744 Checks all fields to make sure this is a valid customer record. If there is
1745 an error, returns the error, otherwise returns false. Called by the insert
1746 and replace methods.
1753 warn "$me check BEFORE: \n". $self->_dump
1757 $self->ut_numbern('custnum')
1758 || $self->ut_number('agentnum')
1759 || $self->ut_textn('agent_custid')
1760 || $self->ut_number('refnum')
1761 || $self->ut_foreign_key('bill_locationnum', 'cust_location','locationnum')
1762 || $self->ut_foreign_key('ship_locationnum', 'cust_location','locationnum')
1763 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1764 || $self->ut_textn('custbatch')
1765 || $self->ut_name('last')
1766 || $self->ut_name('first')
1767 || $self->ut_snumbern('signupdate')
1768 || $self->ut_snumbern('birthdate')
1769 || $self->ut_snumbern('spouse_birthdate')
1770 || $self->ut_snumbern('anniversary_date')
1771 || $self->ut_textn('company')
1772 || $self->ut_anything('comments')
1773 || $self->ut_numbern('referral_custnum')
1774 || $self->ut_textn('stateid')
1775 || $self->ut_textn('stateid_state')
1776 || $self->ut_textn('invoice_terms')
1777 || $self->ut_floatn('cdr_termination_percentage')
1778 || $self->ut_floatn('credit_limit')
1779 || $self->ut_numbern('billday')
1780 || $self->ut_numbern('prorate_day')
1781 || $self->ut_flag('edit_subject')
1782 || $self->ut_flag('calling_list_exempt')
1783 || $self->ut_flag('invoice_noemail')
1784 || $self->ut_flag('message_noemail')
1785 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1788 my $company = $self->company;
1789 $company =~ s/^\s+//;
1790 $company =~ s/\s+$//;
1791 $company =~ s/\s+/ /g;
1792 $self->company($company);
1794 #barf. need message catalogs. i18n. etc.
1795 $error .= "Please select an advertising source."
1796 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1797 return $error if $error;
1799 return "Unknown agent"
1800 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1802 return "Unknown refnum"
1803 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1805 return "Unknown referring custnum: ". $self->referral_custnum
1806 unless ! $self->referral_custnum
1807 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1809 if ( $self->ss eq '' ) {
1814 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1815 or return "Illegal social security number: ". $self->ss;
1816 $self->ss("$1-$2-$3");
1819 # cust_main_county verification now handled by cust_location check
1822 $self->ut_phonen('daytime', $self->country)
1823 || $self->ut_phonen('night', $self->country)
1824 || $self->ut_phonen('fax', $self->country)
1825 || $self->ut_phonen('mobile', $self->country)
1827 return $error if $error;
1829 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1831 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1834 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1836 : FS::Msgcat::_gettext('daytime');
1837 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1839 : FS::Msgcat::_gettext('night');
1841 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1843 : FS::Msgcat::_gettext('mobile');
1845 return "$daytime_label, $night_label or $mobile_label is required"
1849 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1850 # or return "Illegal payby: ". $self->payby;
1852 FS::payby->can_payby($self->table, $self->payby)
1853 or return "Illegal payby: ". $self->payby;
1855 $error = $self->ut_numbern('paystart_month')
1856 || $self->ut_numbern('paystart_year')
1857 || $self->ut_numbern('payissue')
1858 || $self->ut_textn('paytype')
1860 return $error if $error;
1862 if ( $self->payip eq '' ) {
1865 $error = $self->ut_ip('payip');
1866 return $error if $error;
1869 # If it is encrypted and the private key is not availaible then we can't
1870 # check the credit card.
1871 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1873 # Need some kind of global flag to accept invalid cards, for testing
1875 if ( !$import && $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1877 my $payinfo = $self->payinfo;
1878 $payinfo =~ s/\D//g;
1879 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1880 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1882 $self->payinfo($payinfo);
1884 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1886 return gettext('unknown_card_type')
1887 if $self->payinfo !~ /^99\d{14}$/ #token
1888 && cardtype($self->payinfo) eq "Unknown";
1890 unless ( $ignore_banned_card ) {
1891 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1893 if ( $ban->bantype eq 'warn' ) {
1894 #or others depending on value of $ban->reason ?
1895 return '_duplicate_card'.
1896 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1897 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1898 ' (ban# '. $ban->bannum. ')'
1899 unless $self->override_ban_warn;
1901 return 'Banned credit card: banned on '.
1902 time2str('%a %h %o at %r', $ban->_date).
1903 ' by '. $ban->otaker.
1904 ' (ban# '. $ban->bannum. ')';
1909 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1910 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1911 $self->paycvv =~ /^(\d{4})$/
1912 or return "CVV2 (CID) for American Express cards is four digits.";
1915 $self->paycvv =~ /^(\d{3})$/
1916 or return "CVV2 (CVC2/CID) is three digits.";
1923 my $cardtype = cardtype($payinfo);
1924 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1926 return "Start date or issue number is required for $cardtype cards"
1927 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1929 return "Start month must be between 1 and 12"
1930 if $self->paystart_month
1931 and $self->paystart_month < 1 || $self->paystart_month > 12;
1933 return "Start year must be 1990 or later"
1934 if $self->paystart_year
1935 and $self->paystart_year < 1990;
1937 return "Issue number must be beween 1 and 99"
1939 and $self->payissue < 1 || $self->payissue > 99;
1942 $self->paystart_month('');
1943 $self->paystart_year('');
1944 $self->payissue('');
1947 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1949 my $payinfo = $self->payinfo;
1950 $payinfo =~ s/[^\d\@\.]//g;
1951 if ( $conf->config('echeck-country') eq 'CA' ) {
1952 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1953 or return 'invalid echeck account@branch.bank';
1954 $payinfo = "$1\@$2.$3";
1955 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1956 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1957 $payinfo = "$1\@$2";
1959 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1960 $payinfo = "$1\@$2";
1962 $self->payinfo($payinfo);
1965 unless ( $ignore_banned_card ) {
1966 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1968 if ( $ban->bantype eq 'warn' ) {
1969 #or others depending on value of $ban->reason ?
1970 return '_duplicate_ach' unless $self->override_ban_warn;
1972 return 'Banned ACH account: banned on '.
1973 time2str('%a %h %o at %r', $ban->_date).
1974 ' by '. $ban->otaker.
1975 ' (ban# '. $ban->bannum. ')';
1980 } elsif ( $self->payby eq 'LECB' ) {
1982 my $payinfo = $self->payinfo;
1983 $payinfo =~ s/\D//g;
1984 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1986 $self->payinfo($payinfo);
1989 } elsif ( $self->payby eq 'BILL' ) {
1991 $error = $self->ut_textn('payinfo');
1992 return "Illegal P.O. number: ". $self->payinfo if $error;
1995 } elsif ( $self->payby eq 'COMP' ) {
1997 my $curuser = $FS::CurrentUser::CurrentUser;
1998 if ( ! $self->custnum
1999 && ! $curuser->access_right('Complimentary customer')
2002 return "You are not permitted to create complimentary accounts."
2005 $error = $self->ut_textn('payinfo');
2006 return "Illegal comp account issuer: ". $self->payinfo if $error;
2009 } elsif ( $self->payby eq 'PREPAY' ) {
2011 my $payinfo = $self->payinfo;
2012 $payinfo =~ s/\W//g; #anything else would just confuse things
2013 $self->payinfo($payinfo);
2014 $error = $self->ut_alpha('payinfo');
2015 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2016 return "Unknown prepayment identifier"
2017 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2022 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2023 return "Expiration date required"
2024 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
2028 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2029 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2030 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2031 ( $m, $y ) = ( $2, "19$1" );
2032 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2033 ( $m, $y ) = ( $3, "20$2" );
2035 return "Illegal expiration date: ". $self->paydate;
2037 $m = sprintf('%02d',$m);
2038 $self->paydate("$y-$m-01");
2039 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2040 return gettext('expired_card')
2042 && !$ignore_expired_card
2043 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2046 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2047 ( ! $conf->exists('require_cardname')
2048 || $self->payby !~ /^(CARD|DCRD)$/ )
2050 $self->payname( $self->first. " ". $self->getfield('last') );
2052 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2053 or return gettext('illegal_name'). " payname: ". $self->payname;
2057 return "Please select an invoicing locale"
2060 && $conf->exists('cust_main-require_locale');
2062 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2063 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2067 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2069 warn "$me check AFTER: \n". $self->_dump
2072 $self->SUPER::check;
2077 Returns a list of fields which have ship_ duplicates.
2082 qw( last first company
2083 address1 address2 city county state zip country
2085 daytime night fax mobile
2089 =item has_ship_address
2091 Returns true if this customer record has a separate shipping address.
2095 sub has_ship_address {
2097 $self->bill_locationnum != $self->ship_locationnum;
2102 Returns a list of key/value pairs, with the following keys: address1,
2103 adddress2, city, county, state, zip, country, district, and geocode. The
2104 shipping address is used if present.
2110 $self->ship_location->location_hash;
2115 Returns all locations (see L<FS::cust_location>) for this customer.
2121 qsearch('cust_location', { 'custnum' => $self->custnum,
2122 'prospectnum' => '' } );
2127 Returns all contacts (see L<FS::contact>) for this customer.
2131 #already used :/ sub contact {
2134 qsearch('contact', { 'custnum' => $self->custnum } );
2139 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2140 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2141 on success or a list of errors.
2147 grep { $_->unsuspend } $self->suspended_pkgs;
2152 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2154 Returns a list: an empty list on success or a list of errors.
2160 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2163 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2165 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2166 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2167 of a list of pkgparts; the hashref has the following keys:
2171 =item pkgparts - listref of pkgparts
2173 =item (other options are passed to the suspend method)
2178 Returns a list: an empty list on success or a list of errors.
2182 sub suspend_if_pkgpart {
2184 my (@pkgparts, %opt);
2185 if (ref($_[0]) eq 'HASH'){
2186 @pkgparts = @{$_[0]{pkgparts}};
2191 grep { $_->suspend(%opt) }
2192 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2193 $self->unsuspended_pkgs;
2196 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2198 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2199 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2200 instead of a list of pkgparts; the hashref has the following keys:
2204 =item pkgparts - listref of pkgparts
2206 =item (other options are passed to the suspend method)
2210 Returns a list: an empty list on success or a list of errors.
2214 sub suspend_unless_pkgpart {
2216 my (@pkgparts, %opt);
2217 if (ref($_[0]) eq 'HASH'){
2218 @pkgparts = @{$_[0]{pkgparts}};
2223 grep { $_->suspend(%opt) }
2224 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2225 $self->unsuspended_pkgs;
2228 =item cancel [ OPTION => VALUE ... ]
2230 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2232 Available options are:
2236 =item quiet - can be set true to supress email cancellation notices.
2238 =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.
2240 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2242 =item nobill - can be set true to skip billing if it might otherwise be done.
2246 Always returns a list: an empty list on success or a list of errors.
2250 # nb that dates are not specified as valid options to this method
2253 my( $self, %opt ) = @_;
2255 warn "$me cancel called on customer ". $self->custnum. " with options ".
2256 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2259 return ( 'access denied' )
2260 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2262 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2264 #should try decryption (we might have the private key)
2265 # and if not maybe queue a job for the server that does?
2266 return ( "Can't (yet) ban encrypted credit cards" )
2267 if $self->is_encrypted($self->payinfo);
2269 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2270 my $error = $ban->insert;
2271 return ( $error ) if $error;
2275 my @pkgs = $self->ncancelled_pkgs;
2277 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2279 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2280 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2284 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2285 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2288 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2291 sub _banned_pay_hashref {
2302 'payby' => $payby2ban{$self->payby},
2303 'payinfo' => $self->payinfo,
2304 #don't ever *search* on reason! #'reason' =>
2308 sub _new_banned_pay_hashref {
2310 my $hr = $self->_banned_pay_hashref;
2311 $hr->{payinfo} = md5_base64($hr->{payinfo});
2317 Returns all notes (see L<FS::cust_main_note>) for this customer.
2322 my($self,$orderby_classnum) = (shift,shift);
2323 my $orderby = "_DATE DESC";
2324 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2325 qsearch( 'cust_main_note',
2326 { 'custnum' => $self->custnum },
2328 "ORDER BY $orderby",
2334 Returns the agent (see L<FS::agent>) for this customer.
2340 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2345 Returns the agent name (see L<FS::agent>) for this customer.
2351 $self->agent->agent;
2356 Returns any tags associated with this customer, as FS::cust_tag objects,
2357 or an empty list if there are no tags.
2363 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2368 Returns any tags associated with this customer, as FS::part_tag objects,
2369 or an empty list if there are no tags.
2375 map $_->part_tag, $self->cust_tag;
2381 Returns the customer class, as an FS::cust_class object, or the empty string
2382 if there is no customer class.
2388 if ( $self->classnum ) {
2389 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2397 Returns the customer category name, or the empty string if there is no customer
2404 my $cust_class = $self->cust_class;
2406 ? $cust_class->categoryname
2412 Returns the customer class name, or the empty string if there is no customer
2419 my $cust_class = $self->cust_class;
2421 ? $cust_class->classname
2425 =item BILLING METHODS
2427 Documentation on billing methods has been moved to
2428 L<FS::cust_main::Billing>.
2430 =item REALTIME BILLING METHODS
2432 Documentation on realtime billing methods has been moved to
2433 L<FS::cust_main::Billing_Realtime>.
2437 Removes the I<paycvv> field from the database directly.
2439 If there is an error, returns the error, otherwise returns false.
2445 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2446 or return dbh->errstr;
2447 $sth->execute($self->custnum)
2448 or return $sth->errstr;
2453 =item batch_card OPTION => VALUE...
2455 Adds a payment for this invoice to the pending credit card batch (see
2456 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2457 runs the payment using a realtime gateway.
2459 Options may include:
2461 B<amount>: the amount to be paid; defaults to the customer's balance minus
2462 any payments in transit.
2464 B<payby>: the payment method; defaults to cust_main.payby
2466 B<realtime>: runs this as a realtime payment instead of adding it to a
2469 B<invnum>: sets cust_pay_batch.invnum.
2471 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2472 the billing address for the payment; defaults to the customer's billing
2475 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2476 date, and name; defaults to those fields in cust_main.
2481 my ($self, %options) = @_;
2484 if (exists($options{amount})) {
2485 $amount = $options{amount};
2487 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2489 return '' unless $amount > 0;
2491 my $invnum = delete $options{invnum};
2492 my $payby = $options{payby} || $self->payby; #still dubious
2494 if ($options{'realtime'}) {
2495 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2501 my $oldAutoCommit = $FS::UID::AutoCommit;
2502 local $FS::UID::AutoCommit = 0;
2505 #this needs to handle mysql as well as Pg, like svc_acct.pm
2506 #(make it into a common function if folks need to do batching with mysql)
2507 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2508 or return "Cannot lock pay_batch: " . $dbh->errstr;
2512 'payby' => FS::payby->payby2payment($payby),
2514 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2516 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2518 unless ( $pay_batch ) {
2519 $pay_batch = new FS::pay_batch \%pay_batch;
2520 my $error = $pay_batch->insert;
2522 $dbh->rollback if $oldAutoCommit;
2523 die "error creating new batch: $error\n";
2527 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2528 'batchnum' => $pay_batch->batchnum,
2529 'custnum' => $self->custnum,
2532 foreach (qw( address1 address2 city state zip country latitude longitude
2533 payby payinfo paydate payname ))
2535 $options{$_} = '' unless exists($options{$_});
2538 my $loc = $self->bill_location;
2540 my $cust_pay_batch = new FS::cust_pay_batch ( {
2541 'batchnum' => $pay_batch->batchnum,
2542 'invnum' => $invnum || 0, # is there a better value?
2543 # this field should be
2545 # cust_bill_pay_batch now
2546 'custnum' => $self->custnum,
2547 'last' => $self->getfield('last'),
2548 'first' => $self->getfield('first'),
2549 'address1' => $options{address1} || $loc->address1,
2550 'address2' => $options{address2} || $loc->address2,
2551 'city' => $options{city} || $loc->city,
2552 'state' => $options{state} || $loc->state,
2553 'zip' => $options{zip} || $loc->zip,
2554 'country' => $options{country} || $loc->country,
2555 'payby' => $options{payby} || $self->payby,
2556 'payinfo' => $options{payinfo} || $self->payinfo,
2557 'exp' => $options{paydate} || $self->paydate,
2558 'payname' => $options{payname} || $self->payname,
2559 'amount' => $amount, # consolidating
2562 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2563 if $old_cust_pay_batch;
2566 if ($old_cust_pay_batch) {
2567 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2569 $error = $cust_pay_batch->insert;
2573 $dbh->rollback if $oldAutoCommit;
2577 my $unapplied = $self->total_unapplied_credits
2578 + $self->total_unapplied_payments
2579 + $self->in_transit_payments;
2580 foreach my $cust_bill ($self->open_cust_bill) {
2581 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2582 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2583 'invnum' => $cust_bill->invnum,
2584 'paybatchnum' => $cust_pay_batch->paybatchnum,
2585 'amount' => $cust_bill->owed,
2588 if ($unapplied >= $cust_bill_pay_batch->amount){
2589 $unapplied -= $cust_bill_pay_batch->amount;
2592 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2593 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2595 $error = $cust_bill_pay_batch->insert;
2597 $dbh->rollback if $oldAutoCommit;
2602 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2608 Returns the total owed for this customer on all invoices
2609 (see L<FS::cust_bill/owed>).
2615 $self->total_owed_date(2145859200); #12/31/2037
2618 =item total_owed_date TIME
2620 Returns the total owed for this customer on all invoices with date earlier than
2621 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2622 see L<Time::Local> and L<Date::Parse> for conversion functions.
2626 sub total_owed_date {
2630 my $custnum = $self->custnum;
2632 my $owed_sql = FS::cust_bill->owed_sql;
2635 SELECT SUM($owed_sql) FROM cust_bill
2636 WHERE custnum = $custnum
2640 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2644 =item total_owed_pkgnum PKGNUM
2646 Returns the total owed on all invoices for this customer's specific package
2647 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2651 sub total_owed_pkgnum {
2652 my( $self, $pkgnum ) = @_;
2653 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2656 =item total_owed_date_pkgnum TIME PKGNUM
2658 Returns the total owed for this customer's specific package when using
2659 experimental package balances on all invoices with date earlier than
2660 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2661 see L<Time::Local> and L<Date::Parse> for conversion functions.
2665 sub total_owed_date_pkgnum {
2666 my( $self, $time, $pkgnum ) = @_;
2669 foreach my $cust_bill (
2670 grep { $_->_date <= $time }
2671 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2673 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2675 sprintf( "%.2f", $total_bill );
2681 Returns the total amount of all payments.
2688 $total += $_->paid foreach $self->cust_pay;
2689 sprintf( "%.2f", $total );
2692 =item total_unapplied_credits
2694 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2695 customer. See L<FS::cust_credit/credited>.
2697 =item total_credited
2699 Old name for total_unapplied_credits. Don't use.
2703 sub total_credited {
2704 #carp "total_credited deprecated, use total_unapplied_credits";
2705 shift->total_unapplied_credits(@_);
2708 sub total_unapplied_credits {
2711 my $custnum = $self->custnum;
2713 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2716 SELECT SUM($unapplied_sql) FROM cust_credit
2717 WHERE custnum = $custnum
2720 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2724 =item total_unapplied_credits_pkgnum PKGNUM
2726 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2727 customer. See L<FS::cust_credit/credited>.
2731 sub total_unapplied_credits_pkgnum {
2732 my( $self, $pkgnum ) = @_;
2733 my $total_credit = 0;
2734 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2735 sprintf( "%.2f", $total_credit );
2739 =item total_unapplied_payments
2741 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2742 See L<FS::cust_pay/unapplied>.
2746 sub total_unapplied_payments {
2749 my $custnum = $self->custnum;
2751 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2754 SELECT SUM($unapplied_sql) FROM cust_pay
2755 WHERE custnum = $custnum
2758 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2762 =item total_unapplied_payments_pkgnum PKGNUM
2764 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2765 specific package when using experimental package balances. See
2766 L<FS::cust_pay/unapplied>.
2770 sub total_unapplied_payments_pkgnum {
2771 my( $self, $pkgnum ) = @_;
2772 my $total_unapplied = 0;
2773 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2774 sprintf( "%.2f", $total_unapplied );
2778 =item total_unapplied_refunds
2780 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2781 customer. See L<FS::cust_refund/unapplied>.
2785 sub total_unapplied_refunds {
2787 my $custnum = $self->custnum;
2789 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2792 SELECT SUM($unapplied_sql) FROM cust_refund
2793 WHERE custnum = $custnum
2796 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2802 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2803 total_unapplied_credits minus total_unapplied_payments).
2809 $self->balance_date_range;
2812 =item balance_date TIME
2814 Returns the balance for this customer, only considering invoices with date
2815 earlier than TIME (total_owed_date minus total_credited minus
2816 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2817 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2824 $self->balance_date_range(shift);
2827 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2829 Returns the balance for this customer, optionally considering invoices with
2830 date earlier than START_TIME, and not later than END_TIME
2831 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2833 Times are specified as SQL fragments or numeric
2834 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2835 L<Date::Parse> for conversion functions. The empty string can be passed
2836 to disable that time constraint completely.
2838 Available options are:
2842 =item unapplied_date
2844 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)
2850 sub balance_date_range {
2852 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2853 ') FROM cust_main WHERE custnum='. $self->custnum;
2854 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2857 =item balance_pkgnum PKGNUM
2859 Returns the balance for this customer's specific package when using
2860 experimental package balances (total_owed plus total_unrefunded, minus
2861 total_unapplied_credits minus total_unapplied_payments)
2865 sub balance_pkgnum {
2866 my( $self, $pkgnum ) = @_;
2869 $self->total_owed_pkgnum($pkgnum)
2870 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2871 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2872 - $self->total_unapplied_credits_pkgnum($pkgnum)
2873 - $self->total_unapplied_payments_pkgnum($pkgnum)
2877 =item in_transit_payments
2879 Returns the total of requests for payments for this customer pending in
2880 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2884 sub in_transit_payments {
2886 my $in_transit_payments = 0;
2887 foreach my $pay_batch ( qsearch('pay_batch', {
2890 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2891 'batchnum' => $pay_batch->batchnum,
2892 'custnum' => $self->custnum,
2894 $in_transit_payments += $cust_pay_batch->amount;
2897 sprintf( "%.2f", $in_transit_payments );
2902 Returns a hash of useful information for making a payment.
2912 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2913 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2914 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2918 For credit card transactions:
2930 For electronic check transactions:
2945 $return{balance} = $self->balance;
2947 $return{payname} = $self->payname
2948 || ( $self->first. ' '. $self->get('last') );
2950 $return{$_} = $self->bill_location->$_
2951 for qw(address1 address2 city state zip);
2953 $return{payby} = $self->payby;
2954 $return{stateid_state} = $self->stateid_state;
2956 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2957 $return{card_type} = cardtype($self->payinfo);
2958 $return{payinfo} = $self->paymask;
2960 @return{'month', 'year'} = $self->paydate_monthyear;
2964 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2965 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2966 $return{payinfo1} = $payinfo1;
2967 $return{payinfo2} = $payinfo2;
2968 $return{paytype} = $self->paytype;
2969 $return{paystate} = $self->paystate;
2973 #doubleclick protection
2975 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2981 =item paydate_monthyear
2983 Returns a two-element list consisting of the month and year of this customer's
2984 paydate (credit card expiration date for CARD customers)
2988 sub paydate_monthyear {
2990 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2992 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3001 Returns the exact time in seconds corresponding to the payment method
3002 expiration date. For CARD/DCRD customers this is the end of the month;
3003 for others (COMP is the only other payby that uses paydate) it's the start.
3004 Returns 0 if the paydate is empty or set to the far future.
3010 my ($month, $year) = $self->paydate_monthyear;
3011 return 0 if !$year or $year >= 2037;
3012 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3014 if ( $month == 13 ) {
3018 return timelocal(0,0,0,1,$month-1,$year) - 1;
3021 return timelocal(0,0,0,1,$month-1,$year);
3025 =item paydate_epoch_sql
3027 Class method. Returns an SQL expression to obtain the payment expiration date
3028 as a number of seconds.
3032 # Special expiration date behavior for non-CARD/DCRD customers has been
3033 # carefully preserved. Do we really use that?
3034 sub paydate_epoch_sql {
3036 my $table = shift || 'cust_main';
3037 my ($case1, $case2);
3038 if ( driver_name eq 'Pg' ) {
3039 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3040 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3042 elsif ( lc(driver_name) eq 'mysql' ) {
3043 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3044 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3047 return "CASE WHEN $table.payby IN('CARD','DCRD')
3053 =item tax_exemption TAXNAME
3058 my( $self, $taxname ) = @_;
3060 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3061 'taxname' => $taxname,
3066 =item cust_main_exemption
3070 sub cust_main_exemption {
3072 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3075 =item invoicing_list [ ARRAYREF ]
3077 If an arguement is given, sets these email addresses as invoice recipients
3078 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3079 (except as warnings), so use check_invoicing_list first.
3081 Returns a list of email addresses (with svcnum entries expanded).
3083 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3084 check it without disturbing anything by passing nothing.
3086 This interface may change in the future.
3090 sub invoicing_list {
3091 my( $self, $arrayref ) = @_;
3094 my @cust_main_invoice;
3095 if ( $self->custnum ) {
3096 @cust_main_invoice =
3097 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3099 @cust_main_invoice = ();
3101 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3102 #warn $cust_main_invoice->destnum;
3103 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3104 #warn $cust_main_invoice->destnum;
3105 my $error = $cust_main_invoice->delete;
3106 warn $error if $error;
3109 if ( $self->custnum ) {
3110 @cust_main_invoice =
3111 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3113 @cust_main_invoice = ();
3115 my %seen = map { $_->address => 1 } @cust_main_invoice;
3116 foreach my $address ( @{$arrayref} ) {
3117 next if exists $seen{$address} && $seen{$address};
3118 $seen{$address} = 1;
3119 my $cust_main_invoice = new FS::cust_main_invoice ( {
3120 'custnum' => $self->custnum,
3123 my $error = $cust_main_invoice->insert;
3124 warn $error if $error;
3128 if ( $self->custnum ) {
3130 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3137 =item check_invoicing_list ARRAYREF
3139 Checks these arguements as valid input for the invoicing_list method. If there
3140 is an error, returns the error, otherwise returns false.
3144 sub check_invoicing_list {
3145 my( $self, $arrayref ) = @_;
3147 foreach my $address ( @$arrayref ) {
3149 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3150 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3153 my $cust_main_invoice = new FS::cust_main_invoice ( {
3154 'custnum' => $self->custnum,
3157 my $error = $self->custnum
3158 ? $cust_main_invoice->check
3159 : $cust_main_invoice->checkdest
3161 return $error if $error;
3165 return "Email address required"
3166 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3167 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3172 =item set_default_invoicing_list
3174 Sets the invoicing list to all accounts associated with this customer,
3175 overwriting any previous invoicing list.
3179 sub set_default_invoicing_list {
3181 $self->invoicing_list($self->all_emails);
3186 Returns the email addresses of all accounts provisioned for this customer.
3193 foreach my $cust_pkg ( $self->all_pkgs ) {
3194 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3196 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3197 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3199 $list{$_}=1 foreach map { $_->email } @svc_acct;
3204 =item invoicing_list_addpost
3206 Adds postal invoicing to this customer. If this customer is already configured
3207 to receive postal invoices, does nothing.
3211 sub invoicing_list_addpost {
3213 return if grep { $_ eq 'POST' } $self->invoicing_list;
3214 my @invoicing_list = $self->invoicing_list;
3215 push @invoicing_list, 'POST';
3216 $self->invoicing_list(\@invoicing_list);
3219 =item invoicing_list_emailonly
3221 Returns the list of email invoice recipients (invoicing_list without non-email
3222 destinations such as POST and FAX).
3226 sub invoicing_list_emailonly {
3228 warn "$me invoicing_list_emailonly called"
3230 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3233 =item invoicing_list_emailonly_scalar
3235 Returns the list of email invoice recipients (invoicing_list without non-email
3236 destinations such as POST and FAX) as a comma-separated scalar.
3240 sub invoicing_list_emailonly_scalar {
3242 warn "$me invoicing_list_emailonly_scalar called"
3244 join(', ', $self->invoicing_list_emailonly);
3247 =item referral_custnum_cust_main
3249 Returns the customer who referred this customer (or the empty string, if
3250 this customer was not referred).
3252 Note the difference with referral_cust_main method: This method,
3253 referral_custnum_cust_main returns the single customer (if any) who referred
3254 this customer, while referral_cust_main returns an array of customers referred
3259 sub referral_custnum_cust_main {
3261 return '' unless $self->referral_custnum;
3262 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3265 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3267 Returns an array of customers referred by this customer (referral_custnum set
3268 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3269 customers referred by customers referred by this customer and so on, inclusive.
3270 The default behavior is DEPTH 1 (no recursion).
3272 Note the difference with referral_custnum_cust_main method: This method,
3273 referral_cust_main, returns an array of customers referred BY this customer,
3274 while referral_custnum_cust_main returns the single customer (if any) who
3275 referred this customer.
3279 sub referral_cust_main {
3281 my $depth = @_ ? shift : 1;
3282 my $exclude = @_ ? shift : {};
3285 map { $exclude->{$_->custnum}++; $_; }
3286 grep { ! $exclude->{ $_->custnum } }
3287 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3291 map { $_->referral_cust_main($depth-1, $exclude) }
3298 =item referral_cust_main_ncancelled
3300 Same as referral_cust_main, except only returns customers with uncancelled
3305 sub referral_cust_main_ncancelled {
3307 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3310 =item referral_cust_pkg [ DEPTH ]
3312 Like referral_cust_main, except returns a flat list of all unsuspended (and
3313 uncancelled) packages for each customer. The number of items in this list may
3314 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3318 sub referral_cust_pkg {
3320 my $depth = @_ ? shift : 1;
3322 map { $_->unsuspended_pkgs }
3323 grep { $_->unsuspended_pkgs }
3324 $self->referral_cust_main($depth);
3327 =item referring_cust_main
3329 Returns the single cust_main record for the customer who referred this customer
3330 (referral_custnum), or false.
3334 sub referring_cust_main {
3336 return '' unless $self->referral_custnum;
3337 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3340 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3342 Applies a credit to this customer. If there is an error, returns the error,
3343 otherwise returns false.
3345 REASON can be a text string, an FS::reason object, or a scalar reference to
3346 a reasonnum. If a text string, it will be automatically inserted as a new
3347 reason, and a 'reason_type' option must be passed to indicate the
3348 FS::reason_type for the new reason.
3350 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3352 Any other options are passed to FS::cust_credit::insert.
3357 my( $self, $amount, $reason, %options ) = @_;
3359 my $cust_credit = new FS::cust_credit {
3360 'custnum' => $self->custnum,
3361 'amount' => $amount,
3364 if ( ref($reason) ) {
3366 if ( ref($reason) eq 'SCALAR' ) {
3367 $cust_credit->reasonnum( $$reason );
3369 $cust_credit->reasonnum( $reason->reasonnum );
3373 $cust_credit->set('reason', $reason)
3376 for (qw( addlinfo eventnum )) {
3377 $cust_credit->$_( delete $options{$_} )
3378 if exists($options{$_});
3381 $cust_credit->insert(%options);
3385 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3387 Creates a one-time charge for this customer. If there is an error, returns
3388 the error, otherwise returns false.
3390 New-style, with a hashref of options:
3392 my $error = $cust_main->charge(
3396 'start_date' => str2time('7/4/2009'),
3397 'pkg' => 'Description',
3398 'comment' => 'Comment',
3399 'additional' => [], #extra invoice detail
3400 'classnum' => 1, #pkg_class
3402 'setuptax' => '', # or 'Y' for tax exempt
3404 'locationnum'=> 1234, # optional
3407 'taxclass' => 'Tax class',
3410 'taxproduct' => 2, #part_pkg_taxproduct
3411 'override' => {}, #XXX describe
3413 #will be filled in with the new object
3414 'cust_pkg_ref' => \$cust_pkg,
3416 #generate an invoice immediately
3418 'invoice_terms' => '', #with these terms
3424 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3430 my ( $amount, $quantity, $start_date, $classnum );
3431 my ( $pkg, $comment, $additional );
3432 my ( $setuptax, $taxclass ); #internal taxes
3433 my ( $taxproduct, $override ); #vendor (CCH) taxes
3435 my $cust_pkg_ref = '';
3436 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3438 if ( ref( $_[0] ) ) {
3439 $amount = $_[0]->{amount};
3440 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3441 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3442 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3443 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3444 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3445 : '$'. sprintf("%.2f",$amount);
3446 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3447 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3448 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3449 $additional = $_[0]->{additional} || [];
3450 $taxproduct = $_[0]->{taxproductnum};
3451 $override = { '' => $_[0]->{tax_override} };
3452 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3453 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3454 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3455 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3460 $pkg = @_ ? shift : 'One-time charge';
3461 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3463 $taxclass = @_ ? shift : '';
3467 local $SIG{HUP} = 'IGNORE';
3468 local $SIG{INT} = 'IGNORE';
3469 local $SIG{QUIT} = 'IGNORE';
3470 local $SIG{TERM} = 'IGNORE';
3471 local $SIG{TSTP} = 'IGNORE';
3472 local $SIG{PIPE} = 'IGNORE';
3474 my $oldAutoCommit = $FS::UID::AutoCommit;
3475 local $FS::UID::AutoCommit = 0;
3478 my $part_pkg = new FS::part_pkg ( {
3480 'comment' => $comment,
3484 'classnum' => ( $classnum ? $classnum : '' ),
3485 'setuptax' => $setuptax,
3486 'taxclass' => $taxclass,
3487 'taxproductnum' => $taxproduct,
3490 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3491 ( 0 .. @$additional - 1 )
3493 'additional_count' => scalar(@$additional),
3494 'setup_fee' => $amount,
3497 my $error = $part_pkg->insert( options => \%options,
3498 tax_overrides => $override,
3501 $dbh->rollback if $oldAutoCommit;
3505 my $pkgpart = $part_pkg->pkgpart;
3506 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3507 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3508 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3509 $error = $type_pkgs->insert;
3511 $dbh->rollback if $oldAutoCommit;
3516 my $cust_pkg = new FS::cust_pkg ( {
3517 'custnum' => $self->custnum,
3518 'pkgpart' => $pkgpart,
3519 'quantity' => $quantity,
3520 'start_date' => $start_date,
3521 'no_auto' => $no_auto,
3522 'locationnum'=> $locationnum,
3525 $error = $cust_pkg->insert;
3527 $dbh->rollback if $oldAutoCommit;
3529 } elsif ( $cust_pkg_ref ) {
3530 ${$cust_pkg_ref} = $cust_pkg;
3534 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3535 'pkg_list' => [ $cust_pkg ],
3538 $dbh->rollback if $oldAutoCommit;
3543 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3548 #=item charge_postal_fee
3550 #Applies a one time charge this customer. If there is an error,
3551 #returns the error, returns the cust_pkg charge object or false
3552 #if there was no charge.
3556 # This should be a customer event. For that to work requires that bill
3557 # also be a customer event.
3559 sub charge_postal_fee {
3562 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3563 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3565 my $cust_pkg = new FS::cust_pkg ( {
3566 'custnum' => $self->custnum,
3567 'pkgpart' => $pkgpart,
3571 my $error = $cust_pkg->insert;
3572 $error ? $error : $cust_pkg;
3575 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3577 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3579 Optionally, a list or hashref of additional arguments to the qsearch call can
3586 my $opt = ref($_[0]) ? shift : { @_ };
3588 #return $self->num_cust_bill unless wantarray || keys %$opt;
3590 $opt->{'table'} = 'cust_bill';
3591 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3592 $opt->{'hashref'}{'custnum'} = $self->custnum;
3593 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3595 map { $_ } #behavior of sort undefined in scalar context
3596 sort { $a->_date <=> $b->_date }
3600 =item open_cust_bill
3602 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3607 sub open_cust_bill {
3611 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3617 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3619 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3623 sub legacy_cust_bill {
3626 #return $self->num_legacy_cust_bill unless wantarray;
3628 map { $_ } #behavior of sort undefined in scalar context
3629 sort { $a->_date <=> $b->_date }
3630 qsearch({ 'table' => 'legacy_cust_bill',
3631 'hashref' => { 'custnum' => $self->custnum, },
3632 'order_by' => 'ORDER BY _date ASC',
3636 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3638 Returns all the statements (see L<FS::cust_statement>) for this customer.
3640 Optionally, a list or hashref of additional arguments to the qsearch call can
3645 =item cust_bill_void
3647 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3651 sub cust_bill_void {
3654 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3655 sort { $a->_date <=> $b->_date }
3656 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3659 sub cust_statement {
3661 my $opt = ref($_[0]) ? shift : { @_ };
3663 #return $self->num_cust_statement unless wantarray || keys %$opt;
3665 $opt->{'table'} = 'cust_statement';
3666 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3667 $opt->{'hashref'}{'custnum'} = $self->custnum;
3668 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3670 map { $_ } #behavior of sort undefined in scalar context
3671 sort { $a->_date <=> $b->_date }
3675 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3677 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3679 Optionally, a list or hashref of additional arguments to the qsearch call can
3680 be passed following the SVCDB.
3687 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3688 warn "$me svc_x requires a svcdb";
3691 my $opt = ref($_[0]) ? shift : { @_ };
3693 $opt->{'table'} = $svcdb;
3694 $opt->{'addl_from'} =
3695 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3696 ($opt->{'addl_from'} || '');
3698 my $custnum = $self->custnum;
3699 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3700 my $where = "cust_pkg.custnum = $custnum";
3702 my $extra_sql = $opt->{'extra_sql'} || '';
3703 if ( keys %{ $opt->{'hashref'} } ) {
3704 $extra_sql = " AND $where $extra_sql";
3707 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3708 $extra_sql = "WHERE $where AND $1";
3711 $extra_sql = "WHERE $where $extra_sql";
3714 $opt->{'extra_sql'} = $extra_sql;
3719 # required for use as an eventtable;
3722 $self->svc_x('svc_acct', @_);
3727 Returns all the credits (see L<FS::cust_credit>) for this customer.
3733 map { $_ } #return $self->num_cust_credit unless wantarray;
3734 sort { $a->_date <=> $b->_date }
3735 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3738 =item cust_credit_pkgnum
3740 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3741 package when using experimental package balances.
3745 sub cust_credit_pkgnum {
3746 my( $self, $pkgnum ) = @_;
3747 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3748 sort { $a->_date <=> $b->_date }
3749 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3750 'pkgnum' => $pkgnum,
3757 Returns all the payments (see L<FS::cust_pay>) for this customer.
3763 return $self->num_cust_pay unless wantarray;
3764 sort { $a->_date <=> $b->_date }
3765 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3770 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3771 called automatically when the cust_pay method is used in a scalar context.
3777 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3778 my $sth = dbh->prepare($sql) or die dbh->errstr;
3779 $sth->execute($self->custnum) or die $sth->errstr;
3780 $sth->fetchrow_arrayref->[0];
3783 =item cust_pay_pkgnum
3785 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3786 package when using experimental package balances.
3790 sub cust_pay_pkgnum {
3791 my( $self, $pkgnum ) = @_;
3792 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3793 sort { $a->_date <=> $b->_date }
3794 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3795 'pkgnum' => $pkgnum,
3802 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3808 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3809 sort { $a->_date <=> $b->_date }
3810 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3813 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3815 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3817 Optionally, a list or hashref of additional arguments to the qsearch call can
3822 sub cust_pay_batch {
3824 my $opt = ref($_[0]) ? shift : { @_ };
3826 #return $self->num_cust_statement unless wantarray || keys %$opt;
3828 $opt->{'table'} = 'cust_pay_batch';
3829 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3830 $opt->{'hashref'}{'custnum'} = $self->custnum;
3831 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3833 map { $_ } #behavior of sort undefined in scalar context
3834 sort { $a->paybatchnum <=> $b->paybatchnum }
3838 =item cust_pay_pending
3840 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3841 (without status "done").
3845 sub cust_pay_pending {
3847 return $self->num_cust_pay_pending unless wantarray;
3848 sort { $a->_date <=> $b->_date }
3849 qsearch( 'cust_pay_pending', {
3850 'custnum' => $self->custnum,
3851 'status' => { op=>'!=', value=>'done' },
3856 =item cust_pay_pending_attempt
3858 Returns all payment attempts / declined payments for this customer, as pending
3859 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3860 a corresponding payment (see L<FS::cust_pay>).
3864 sub cust_pay_pending_attempt {
3866 return $self->num_cust_pay_pending_attempt unless wantarray;
3867 sort { $a->_date <=> $b->_date }
3868 qsearch( 'cust_pay_pending', {
3869 'custnum' => $self->custnum,
3876 =item num_cust_pay_pending
3878 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3879 customer (without status "done"). Also called automatically when the
3880 cust_pay_pending method is used in a scalar context.
3884 sub num_cust_pay_pending {
3887 " SELECT COUNT(*) FROM cust_pay_pending ".
3888 " WHERE custnum = ? AND status != 'done' ",
3893 =item num_cust_pay_pending_attempt
3895 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3896 customer, with status "done" but without a corresp. Also called automatically when the
3897 cust_pay_pending method is used in a scalar context.
3901 sub num_cust_pay_pending_attempt {
3904 " SELECT COUNT(*) FROM cust_pay_pending ".
3905 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3912 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3918 map { $_ } #return $self->num_cust_refund unless wantarray;
3919 sort { $a->_date <=> $b->_date }
3920 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3923 =item display_custnum
3925 Returns the displayed customer number for this customer: agent_custid if
3926 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3930 sub display_custnum {
3933 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3934 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3935 if ( $special eq 'CoStAg' ) {
3936 $prefix = uc( join('',
3938 ($self->state =~ /^(..)/),
3939 $prefix || ($self->agent->agent =~ /^(..)/)
3942 elsif ( $special eq 'CoStCl' ) {
3943 $prefix = uc( join('',
3945 ($self->state =~ /^(..)/),
3946 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3949 # add any others here if needed
3952 my $length = $conf->config('cust_main-custnum-display_length');
3953 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3954 return $self->agent_custid;
3955 } elsif ( $prefix ) {
3956 $length = 8 if !defined($length);
3958 sprintf('%0'.$length.'d', $self->custnum)
3959 } elsif ( $length ) {
3960 return sprintf('%0'.$length.'d', $self->custnum);
3962 return $self->custnum;
3968 Returns a name string for this customer, either "Company (Last, First)" or
3975 my $name = $self->contact;
3976 $name = $self->company. " ($name)" if $self->company;
3980 =item service_contact
3982 Returns the L<FS::contact> object for this customer that has the 'Service'
3983 contact class, or undef if there is no such contact. Deprecated; don't use
3988 sub service_contact {
3990 if ( !exists($self->{service_contact}) ) {
3991 my $classnum = $self->scalar_sql(
3992 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3993 ) || 0; #if it's zero, qsearchs will return nothing
3994 $self->{service_contact} = qsearchs('contact', {
3995 'classnum' => $classnum, 'custnum' => $self->custnum
3998 $self->{service_contact};
4003 Returns a name string for this (service/shipping) contact, either
4004 "Company (Last, First)" or "Last, First".
4011 my $name = $self->ship_contact;
4012 $name = $self->company. " ($name)" if $self->company;
4018 Returns a name string for this customer, either "Company" or "First Last".
4024 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4027 =item ship_name_short
4029 Returns a name string for this (service/shipping) contact, either "Company"
4034 sub ship_name_short {
4036 $self->service_contact
4037 ? $self->ship_contact_firstlast
4043 Returns this customer's full (billing) contact name only, "Last, First"
4049 $self->get('last'). ', '. $self->first;
4054 Returns this customer's full (shipping) contact name only, "Last, First"
4060 my $contact = $self->service_contact || $self;
4061 $contact->get('last') . ', ' . $contact->get('first');
4064 =item contact_firstlast
4066 Returns this customers full (billing) contact name only, "First Last".
4070 sub contact_firstlast {
4072 $self->first. ' '. $self->get('last');
4075 =item ship_contact_firstlast
4077 Returns this customer's full (shipping) contact name only, "First Last".
4081 sub ship_contact_firstlast {
4083 my $contact = $self->service_contact || $self;
4084 $contact->get('first') . ' '. $contact->get('last');
4087 #XXX this doesn't work in 3.x+
4090 #Returns this customer's full country name
4096 # code2country($self->country);
4099 =item county_state_county [ PREFIX ]
4101 Returns a string consisting of just the county, state and country.
4105 sub county_state_country {
4108 if ( @_ && $_[0] && $self->has_ship_address ) {
4109 $locationnum = $self->ship_locationnum;
4111 $locationnum = $self->bill_locationnum;
4113 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4114 $cust_location->county_state_country;
4117 =item geocode DATA_VENDOR
4119 Returns a value for the customer location as encoded by DATA_VENDOR.
4120 Currently this only makes sense for "CCH" as DATA_VENDOR.
4128 Returns a status string for this customer, currently:
4132 =item prospect - No packages have ever been ordered
4134 =item ordered - Recurring packages all are new (not yet billed).
4136 =item active - One or more recurring packages is active
4138 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4140 =item suspended - All non-cancelled recurring packages are suspended
4142 =item cancelled - All recurring packages are cancelled
4146 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4147 cust_main-status_module configuration option.
4151 sub status { shift->cust_status(@_); }
4155 for my $status ( FS::cust_main->statuses() ) {
4156 my $method = $status.'_sql';
4157 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4158 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4159 $sth->execute( ($self->custnum) x $numnum )
4160 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4161 return $status if $sth->fetchrow_arrayref->[0];
4165 =item ucfirst_cust_status
4167 =item ucfirst_status
4169 Returns the status with the first character capitalized.
4173 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4175 sub ucfirst_cust_status {
4177 ucfirst($self->cust_status);
4182 Returns a hex triplet color string for this customer's status.
4186 sub statuscolor { shift->cust_statuscolor(@_); }
4188 sub cust_statuscolor {
4190 __PACKAGE__->statuscolors->{$self->cust_status};
4195 Returns an array of hashes representing the customer's RT tickets.
4202 my $num = $conf->config('cust_main-max_tickets') || 10;
4205 if ( $conf->config('ticket_system') ) {
4206 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4208 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4212 foreach my $priority (
4213 $conf->config('ticket_system-custom_priority_field-values'), ''
4215 last if scalar(@tickets) >= $num;
4217 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4218 $num - scalar(@tickets),
4228 # Return services representing svc_accts in customer support packages
4229 sub support_services {
4231 my %packages = map { $_ => 1 } $conf->config('support_packages');
4233 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4234 grep { $_->part_svc->svcdb eq 'svc_acct' }
4235 map { $_->cust_svc }
4236 grep { exists $packages{ $_->pkgpart } }
4237 $self->ncancelled_pkgs;
4241 # Return a list of latitude/longitude for one of the services (if any)
4242 sub service_coordinates {
4246 grep { $_->latitude && $_->longitude }
4248 map { $_->cust_svc }
4249 $self->ncancelled_pkgs;
4251 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4256 Returns a masked version of the named field
4261 my ($self,$field) = @_;
4265 'x'x(length($self->getfield($field))-4).
4266 substr($self->getfield($field), (length($self->getfield($field))-4));
4272 =head1 CLASS METHODS
4278 Class method that returns the list of possible status strings for customers
4279 (see L<the status method|/status>). For example:
4281 @statuses = FS::cust_main->statuses();
4287 keys %{ $self->statuscolors };
4290 =item cust_status_sql
4292 Returns an SQL fragment to determine the status of a cust_main record, as a
4297 sub cust_status_sql {
4299 for my $status ( FS::cust_main->statuses() ) {
4300 my $method = $status.'_sql';
4301 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4310 Returns an SQL expression identifying prospective cust_main records (customers
4311 with no packages ever ordered)
4315 use vars qw($select_count_pkgs);
4316 $select_count_pkgs =
4317 "SELECT COUNT(*) FROM cust_pkg
4318 WHERE cust_pkg.custnum = cust_main.custnum";
4320 sub select_count_pkgs_sql {
4325 " 0 = ( $select_count_pkgs ) ";
4330 Returns an SQL expression identifying ordered cust_main records (customers with
4331 no active packages, but recurring packages not yet setup or one time charges
4337 FS::cust_main->none_active_sql.
4338 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4343 Returns an SQL expression identifying active cust_main records (customers with
4344 active recurring packages).
4349 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4352 =item none_active_sql
4354 Returns an SQL expression identifying cust_main records with no active
4355 recurring packages. This includes customers of status prospect, ordered,
4356 inactive, and suspended.
4360 sub none_active_sql {
4361 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4366 Returns an SQL expression identifying inactive cust_main records (customers with
4367 no active recurring packages, but otherwise unsuspended/uncancelled).
4372 FS::cust_main->none_active_sql.
4373 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4379 Returns an SQL expression identifying suspended cust_main records.
4384 sub suspended_sql { susp_sql(@_); }
4386 FS::cust_main->none_active_sql.
4387 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4393 Returns an SQL expression identifying cancelled cust_main records.
4397 sub cancel_sql { shift->cancelled_sql(@_); }
4400 =item uncancelled_sql
4402 Returns an SQL expression identifying un-cancelled cust_main records.
4406 sub uncancelled_sql { uncancel_sql(@_); }
4407 sub uncancel_sql { "
4408 ( 0 < ( $select_count_pkgs
4409 AND ( cust_pkg.cancel IS NULL
4410 OR cust_pkg.cancel = 0
4413 OR 0 = ( $select_count_pkgs )
4419 Returns an SQL fragment to retreive the balance.
4424 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4425 WHERE cust_bill.custnum = cust_main.custnum )
4426 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4427 WHERE cust_pay.custnum = cust_main.custnum )
4428 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4429 WHERE cust_credit.custnum = cust_main.custnum )
4430 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4431 WHERE cust_refund.custnum = cust_main.custnum )
4434 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4436 Returns an SQL fragment to retreive the balance for this customer, optionally
4437 considering invoices with date earlier than START_TIME, and not
4438 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4439 total_unapplied_payments).
4441 Times are specified as SQL fragments or numeric
4442 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4443 L<Date::Parse> for conversion functions. The empty string can be passed
4444 to disable that time constraint completely.
4446 Available options are:
4450 =item unapplied_date
4452 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)
4457 set to true to remove all customer comparison clauses, for totals
4462 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4467 JOIN clause (typically used with the total option)
4471 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4472 time will be ignored. Note that START_TIME and END_TIME only limit the date
4473 range for invoices and I<unapplied> payments, credits, and refunds.
4479 sub balance_date_sql {
4480 my( $class, $start, $end, %opt ) = @_;
4482 my $cutoff = $opt{'cutoff'};
4484 my $owed = FS::cust_bill->owed_sql($cutoff);
4485 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4486 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4487 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4489 my $j = $opt{'join'} || '';
4491 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4492 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4493 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4494 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4496 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4497 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4498 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4499 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4504 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4506 Returns an SQL fragment to retreive the total unapplied payments for this
4507 customer, only considering payments with date earlier than START_TIME, and
4508 optionally not later than END_TIME.
4510 Times are specified as SQL fragments or numeric
4511 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4512 L<Date::Parse> for conversion functions. The empty string can be passed
4513 to disable that time constraint completely.
4515 Available options are:
4519 sub unapplied_payments_date_sql {
4520 my( $class, $start, $end, %opt ) = @_;
4522 my $cutoff = $opt{'cutoff'};
4524 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4526 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4527 'unapplied_date'=>1 );
4529 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4532 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4534 Helper method for balance_date_sql; name (and usage) subject to change
4535 (suggestions welcome).
4537 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4538 cust_refund, cust_credit or cust_pay).
4540 If TABLE is "cust_bill" or the unapplied_date option is true, only
4541 considers records with date earlier than START_TIME, and optionally not
4542 later than END_TIME .
4546 sub _money_table_where {
4547 my( $class, $table, $start, $end, %opt ) = @_;
4550 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4551 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4552 push @where, "$table._date <= $start" if defined($start) && length($start);
4553 push @where, "$table._date > $end" if defined($end) && length($end);
4555 push @where, @{$opt{'where'}} if $opt{'where'};
4556 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4562 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4563 use FS::cust_main::Search;
4566 FS::cust_main::Search->search(@_);
4581 #warn join('-',keys %$param);
4582 my $fh = $param->{filehandle};
4583 my $agentnum = $param->{agentnum};
4584 my $format = $param->{format};
4586 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4589 if ( $format eq 'simple' ) {
4590 @fields = qw( custnum agent_custid amount pkg );
4592 die "unknown format $format";
4595 eval "use Text::CSV_XS;";
4598 my $csv = new Text::CSV_XS;
4605 local $SIG{HUP} = 'IGNORE';
4606 local $SIG{INT} = 'IGNORE';
4607 local $SIG{QUIT} = 'IGNORE';
4608 local $SIG{TERM} = 'IGNORE';
4609 local $SIG{TSTP} = 'IGNORE';
4610 local $SIG{PIPE} = 'IGNORE';
4612 my $oldAutoCommit = $FS::UID::AutoCommit;
4613 local $FS::UID::AutoCommit = 0;
4616 #while ( $columns = $csv->getline($fh) ) {
4618 while ( defined($line=<$fh>) ) {
4620 $csv->parse($line) or do {
4621 $dbh->rollback if $oldAutoCommit;
4622 return "can't parse: ". $csv->error_input();
4625 my @columns = $csv->fields();
4626 #warn join('-',@columns);
4629 foreach my $field ( @fields ) {
4630 $row{$field} = shift @columns;
4633 if ( $row{custnum} && $row{agent_custid} ) {
4634 dbh->rollback if $oldAutoCommit;
4635 return "can't specify custnum with agent_custid $row{agent_custid}";
4639 if ( $row{agent_custid} && $agentnum ) {
4640 %hash = ( 'agent_custid' => $row{agent_custid},
4641 'agentnum' => $agentnum,
4645 if ( $row{custnum} ) {
4646 %hash = ( 'custnum' => $row{custnum} );
4649 unless ( scalar(keys %hash) ) {
4650 $dbh->rollback if $oldAutoCommit;
4651 return "can't find customer without custnum or agent_custid and agentnum";
4654 my $cust_main = qsearchs('cust_main', { %hash } );
4655 unless ( $cust_main ) {
4656 $dbh->rollback if $oldAutoCommit;
4657 my $custnum = $row{custnum} || $row{agent_custid};
4658 return "unknown custnum $custnum";
4661 if ( $row{'amount'} > 0 ) {
4662 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4664 $dbh->rollback if $oldAutoCommit;
4668 } elsif ( $row{'amount'} < 0 ) {
4669 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4672 $dbh->rollback if $oldAutoCommit;
4682 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4684 return "Empty file!" unless $imported;
4690 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4692 Deprecated. Use event notification and message templates
4693 (L<FS::msg_template>) instead.
4695 Sends a templated email notification to the customer (see L<Text::Template>).
4697 OPTIONS is a hash and may include
4699 I<from> - the email sender (default is invoice_from)
4701 I<to> - comma-separated scalar or arrayref of recipients
4702 (default is invoicing_list)
4704 I<subject> - The subject line of the sent email notification
4705 (default is "Notice from company_name")
4707 I<extra_fields> - a hashref of name/value pairs which will be substituted
4710 The following variables are vavailable in the template.
4712 I<$first> - the customer first name
4713 I<$last> - the customer last name
4714 I<$company> - the customer company
4715 I<$payby> - a description of the method of payment for the customer
4716 # would be nice to use FS::payby::shortname
4717 I<$payinfo> - the account information used to collect for this customer
4718 I<$expdate> - the expiration of the customer payment in seconds from epoch
4723 my ($self, $template, %options) = @_;
4725 return unless $conf->exists($template);
4727 my $from = $conf->config('invoice_from', $self->agentnum)
4728 if $conf->exists('invoice_from', $self->agentnum);
4729 $from = $options{from} if exists($options{from});
4731 my $to = join(',', $self->invoicing_list_emailonly);
4732 $to = $options{to} if exists($options{to});
4734 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4735 if $conf->exists('company_name', $self->agentnum);
4736 $subject = $options{subject} if exists($options{subject});
4738 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4739 SOURCE => [ map "$_\n",
4740 $conf->config($template)]
4742 or die "can't create new Text::Template object: Text::Template::ERROR";
4743 $notify_template->compile()
4744 or die "can't compile template: Text::Template::ERROR";
4746 $FS::notify_template::_template::company_name =
4747 $conf->config('company_name', $self->agentnum);
4748 $FS::notify_template::_template::company_address =
4749 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4751 my $paydate = $self->paydate || '2037-12-31';
4752 $FS::notify_template::_template::first = $self->first;
4753 $FS::notify_template::_template::last = $self->last;
4754 $FS::notify_template::_template::company = $self->company;
4755 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4756 my $payby = $self->payby;
4757 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4758 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4760 #credit cards expire at the end of the month/year of their exp date
4761 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4762 $FS::notify_template::_template::payby = 'credit card';
4763 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4764 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4766 }elsif ($payby eq 'COMP') {
4767 $FS::notify_template::_template::payby = 'complimentary account';
4769 $FS::notify_template::_template::payby = 'current method';
4771 $FS::notify_template::_template::expdate = $expire_time;
4773 for (keys %{$options{extra_fields}}){
4775 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4778 send_email(from => $from,
4780 subject => $subject,
4781 body => $notify_template->fill_in( PACKAGE =>
4782 'FS::notify_template::_template' ),
4787 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4789 Generates a templated notification to the customer (see L<Text::Template>).
4791 OPTIONS is a hash and may include
4793 I<extra_fields> - a hashref of name/value pairs which will be substituted
4794 into the template. These values may override values mentioned below
4795 and those from the customer record.
4797 The following variables are available in the template instead of or in addition
4798 to the fields of the customer record.
4800 I<$payby> - a description of the method of payment for the customer
4801 # would be nice to use FS::payby::shortname
4802 I<$payinfo> - the masked account information used to collect for this customer
4803 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4804 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4808 # a lot like cust_bill::print_latex
4809 sub generate_letter {
4810 my ($self, $template, %options) = @_;
4812 return unless $conf->exists($template);
4814 my $letter_template = new Text::Template
4816 SOURCE => [ map "$_\n", $conf->config($template)],
4817 DELIMITERS => [ '[@--', '--@]' ],
4819 or die "can't create new Text::Template object: Text::Template::ERROR";
4821 $letter_template->compile()
4822 or die "can't compile template: Text::Template::ERROR";
4824 my %letter_data = map { $_ => $self->$_ } $self->fields;
4825 $letter_data{payinfo} = $self->mask_payinfo;
4827 #my $paydate = $self->paydate || '2037-12-31';
4828 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4830 my $payby = $self->payby;
4831 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4832 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4834 #credit cards expire at the end of the month/year of their exp date
4835 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4836 $letter_data{payby} = 'credit card';
4837 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4838 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4840 }elsif ($payby eq 'COMP') {
4841 $letter_data{payby} = 'complimentary account';
4843 $letter_data{payby} = 'current method';
4845 $letter_data{expdate} = $expire_time;
4847 for (keys %{$options{extra_fields}}){
4848 $letter_data{$_} = $options{extra_fields}->{$_};
4851 unless(exists($letter_data{returnaddress})){
4852 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4853 $self->agent_template)
4855 if ( length($retadd) ) {
4856 $letter_data{returnaddress} = $retadd;
4857 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4858 $letter_data{returnaddress} =
4859 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4863 ( $conf->config('company_name', $self->agentnum),
4864 $conf->config('company_address', $self->agentnum),
4868 $letter_data{returnaddress} = '~';
4872 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4874 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4876 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4878 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4882 ) or die "can't open temp file: $!\n";
4883 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4884 or die "can't write temp file: $!\n";
4886 $letter_data{'logo_file'} = $lh->filename;
4888 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4892 ) or die "can't open temp file: $!\n";
4894 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4896 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4897 return ($1, $letter_data{'logo_file'});
4901 =item print_ps TEMPLATE
4903 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4909 my($file, $lfile) = $self->generate_letter(@_);
4910 my $ps = FS::Misc::generate_ps($file);
4911 unlink($file.'.tex');
4917 =item print TEMPLATE
4919 Prints the filled in template.
4921 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4925 sub queueable_print {
4928 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4929 or die "invalid customer number: " . $opt{custvnum};
4931 my $error = $self->print( $opt{template} );
4932 die $error if $error;
4936 my ($self, $template) = (shift, shift);
4938 [ $self->print_ps($template) ],
4939 'agentnum' => $self->agentnum,
4943 #these three subs should just go away once agent stuff is all config overrides
4945 sub agent_template {
4947 $self->_agent_plandata('agent_templatename');
4950 sub agent_invoice_from {
4952 $self->_agent_plandata('agent_invoice_from');
4955 sub _agent_plandata {
4956 my( $self, $option ) = @_;
4958 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4959 #agent-specific Conf
4961 use FS::part_event::Condition;
4963 my $agentnum = $self->agentnum;
4965 my $regexp = regexp_sql();
4967 my $part_event_option =
4969 'select' => 'part_event_option.*',
4970 'table' => 'part_event_option',
4972 LEFT JOIN part_event USING ( eventpart )
4973 LEFT JOIN part_event_option AS peo_agentnum
4974 ON ( part_event.eventpart = peo_agentnum.eventpart
4975 AND peo_agentnum.optionname = 'agentnum'
4976 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4978 LEFT JOIN part_event_condition
4979 ON ( part_event.eventpart = part_event_condition.eventpart
4980 AND part_event_condition.conditionname = 'cust_bill_age'
4982 LEFT JOIN part_event_condition_option
4983 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4984 AND part_event_condition_option.optionname = 'age'
4987 #'hashref' => { 'optionname' => $option },
4988 #'hashref' => { 'part_event_option.optionname' => $option },
4990 " WHERE part_event_option.optionname = ". dbh->quote($option).
4991 " AND action = 'cust_bill_send_agent' ".
4992 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4993 " AND peo_agentnum.optionname = 'agentnum' ".
4994 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4996 CASE WHEN part_event_condition_option.optionname IS NULL
4998 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5000 , part_event.weight".
5004 unless ( $part_event_option ) {
5005 return $self->agent->invoice_template || ''
5006 if $option eq 'agent_templatename';
5010 $part_event_option->optionvalue;
5014 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5016 Subroutine (not a method), designed to be called from the queue.
5018 Takes a list of options and values.
5020 Pulls up the customer record via the custnum option and calls bill_and_collect.
5025 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5027 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5028 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5030 $cust_main->bill_and_collect( %args );
5033 sub process_bill_and_collect {
5035 my $param = thaw(decode_base64(shift));
5036 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5037 or die "custnum '$param->{custnum}' not found!\n";
5038 $param->{'job'} = $job;
5039 $param->{'fatal'} = 1; # runs from job queue, will be caught
5040 $param->{'retry'} = 1;
5042 $cust_main->bill_and_collect( %$param );
5045 =item process_censustract_update CUSTNUM
5047 Queueable function to update the census tract to the current year (as set in
5048 the 'census_year' configuration variable) and retrieve the new tract code.
5052 sub process_censustract_update {
5053 eval "use FS::Misc::Geo qw(get_censustract)";
5055 my $custnum = shift;
5056 my $cust_main = qsearchs( 'cust_main', { custnum => $custnum })
5057 or die "custnum '$custnum' not found!\n";
5059 my $new_year = $conf->config('census_year') or return;
5060 my $new_tract = get_censustract({ $cust_main->location_hash }, $new_year);
5061 if ( $new_tract =~ /^\d/ ) {
5062 # then it's a tract code
5063 $cust_main->set('censustract', $new_tract);
5064 $cust_main->set('censusyear', $new_year);
5066 local($ignore_expired_card) = 1;
5067 local($ignore_illegal_zip) = 1;
5068 local($ignore_banned_card) = 1;
5069 local($skip_fuzzyfiles) = 1;
5070 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5071 my $error = $cust_main->replace;
5072 die $error if $error;
5075 # it's an error message
5081 #starting to take quite a while for big dbs
5082 # (JRNL: journaled so it only happens once per database)
5083 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5084 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5085 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5086 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5087 # JRNL leading/trailing spaces in first, last, company
5088 # - otaker upgrade? journal and call it good? (double check to make sure
5089 # we're not still setting otaker here)
5091 #only going to get worse with new location stuff...
5093 sub _upgrade_data { #class method
5094 my ($class, %opts) = @_;
5097 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5100 #this seems to be the only expensive one.. why does it take so long?
5101 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5103 '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';
5104 FS::upgrade_journal->set_done('cust_main__signupdate');
5107 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5109 # fix yyyy-m-dd formatted paydates
5110 if ( driver_name =~ /^mysql/i ) {
5112 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5113 } else { # the SQL standard
5115 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5117 FS::upgrade_journal->set_done('cust_main__paydate');
5120 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5122 push @statements, #fix the weird BILL with a cc# in payinfo problem
5124 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5126 FS::upgrade_journal->set_done('cust_main__payinfo');
5131 foreach my $sql ( @statements ) {
5132 my $sth = dbh->prepare($sql) or die dbh->errstr;
5133 $sth->execute or die $sth->errstr;
5134 #warn ( (time - $t). " seconds\n" );
5138 local($ignore_expired_card) = 1;
5139 local($ignore_banned_card) = 1;
5140 local($skip_fuzzyfiles) = 1;
5141 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5143 FS::cust_main::Location->_upgrade_data(%opts);
5145 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5147 foreach my $cust_main ( qsearch({
5148 'table' => 'cust_main',
5150 'extra_sql' => 'WHERE '.
5152 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5153 qw( first last company )
5156 my $error = $cust_main->replace;
5157 die $error if $error;
5160 FS::upgrade_journal->set_done('cust_main__trimspaces');
5164 $class->_upgrade_otaker(%opts);
5174 The delete method should possibly take an FS::cust_main object reference
5175 instead of a scalar customer number.
5177 Bill and collect options should probably be passed as references instead of a
5180 There should probably be a configuration file with a list of allowed credit
5183 No multiple currency support (probably a larger project than just this module).
5185 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5187 Birthdates rely on negative epoch values.
5189 The payby for card/check batches is broken. With mixed batching, bad
5192 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5196 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5197 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5198 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.