2 use base qw( FS::cust_main::Packages
4 FS::cust_main::NationalID
6 FS::cust_main::Billing_Realtime
7 FS::cust_main::Billing_Discount
8 FS::cust_main::Billing_ThirdParty
9 FS::cust_main::Location
10 FS::cust_main::Credit_Limit
11 FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
12 FS::geocode_Mixin FS::Quotable_Mixin FS::Sales_Mixin
19 use vars qw( $DEBUG $me $conf
22 $ignore_expired_card $ignore_banned_card $ignore_illegal_zip
28 use Scalar::Util qw( blessed );
29 use Time::Local qw(timelocal);
30 use Storable qw(thaw);
34 use Digest::MD5 qw(md5_base64);
37 use File::Temp; #qw( tempfile );
38 use Business::CreditCard 0.28;
40 use FS::UID qw( dbh driver_name );
41 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
43 use FS::Misc qw( generate_email send_email generate_ps do_print );
44 use FS::Msgcat qw(gettext);
51 use FS::cust_bill_void;
52 use FS::legacy_cust_bill;
54 use FS::cust_pay_pending;
55 use FS::cust_pay_void;
56 use FS::cust_pay_batch;
59 use FS::part_referral;
60 use FS::cust_main_county;
61 use FS::cust_location;
63 use FS::cust_main_exemption;
64 use FS::cust_tax_adjustment;
65 use FS::cust_tax_location;
66 use FS::agent_currency;
67 use FS::cust_main_invoice;
69 use FS::prepay_credit;
75 use FS::payment_gateway;
76 use FS::agent_payment_gateway;
78 use FS::cust_main_note;
79 use FS::cust_attachment;
82 use FS::upgrade_journal;
86 # 1 is mostly method/subroutine entry and options
87 # 2 traces progress of some operations
88 # 3 is even more information including possibly sensitive data
90 $me = '[FS::cust_main]';
93 $ignore_expired_card = 0;
94 $ignore_banned_card = 0;
95 $ignore_invalid_card = 0;
99 @encrypted_fields = ('payinfo', 'paycvv');
100 sub nohistory_fields { ('payinfo', 'paycvv'); }
102 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
104 #ask FS::UID to run this stuff for us later
105 #$FS::UID::callback{'FS::cust_main'} = sub {
106 install_callback FS::UID sub {
107 $conf = new FS::Conf;
108 #yes, need it for stuff below (prolly should be cached)
109 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
114 my ( $hashref, $cache ) = @_;
115 if ( exists $hashref->{'pkgnum'} ) {
116 #@{ $self->{'_pkgnum'} } = ();
117 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
118 $self->{'_pkgnum'} = $subcache;
119 #push @{ $self->{'_pkgnum'} },
120 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
126 FS::cust_main - Object methods for cust_main records
132 $record = new FS::cust_main \%hash;
133 $record = new FS::cust_main { 'column' => 'value' };
135 $error = $record->insert;
137 $error = $new_record->replace($old_record);
139 $error = $record->delete;
141 $error = $record->check;
143 @cust_pkg = $record->all_pkgs;
145 @cust_pkg = $record->ncancelled_pkgs;
147 @cust_pkg = $record->suspended_pkgs;
149 $error = $record->bill;
150 $error = $record->bill %options;
151 $error = $record->bill 'time' => $time;
153 $error = $record->collect;
154 $error = $record->collect %options;
155 $error = $record->collect 'invoice_time' => $time,
160 An FS::cust_main object represents a customer. FS::cust_main inherits from
161 FS::Record. The following fields are currently supported:
167 Primary key (assigned automatically for new customers)
171 Agent (see L<FS::agent>)
175 Advertising source (see L<FS::part_referral>)
187 Cocial security number (optional)
211 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
215 Payment Information (See L<FS::payinfo_Mixin> for data format)
219 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
223 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
227 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
231 Start date month (maestro/solo cards only)
235 Start date year (maestro/solo cards only)
239 Issue number (maestro/solo cards only)
243 Name on card or billing name
247 IP address from which payment information was received
251 Tax exempt, empty or `Y'
255 Order taker (see L<FS::access_user>)
261 =item referral_custnum
263 Referring customer number
267 Enable individual CDR spooling, empty or `Y'
271 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
275 Discourage individual CDR printing, empty or `Y'
279 Allow self-service editing of ticket subjects, empty or 'Y'
281 =item calling_list_exempt
283 Do not call, empty or 'Y'
293 Creates a new customer. To add the customer to the database, see L<"insert">.
295 Note that this stores the hash reference, not a distinct copy of the hash it
296 points to. You can ask the object for a copy with the I<hash> method.
300 sub table { 'cust_main'; }
302 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
304 Adds this customer to the database. If there is an error, returns the error,
305 otherwise returns false.
307 Usually the customer's location will not yet exist in the database, and
308 the C<bill_location> and C<ship_location> pseudo-fields must be set to
309 uninserted L<FS::cust_location> objects. These will be inserted and linked
310 (in both directions) to the new customer record. If they're references
311 to the same object, they will become the same location.
313 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
314 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
315 are inserted atomicly, or the transaction is rolled back. Passing an empty
316 hash reference is equivalent to not supplying this parameter. There should be
317 a better explanation of this, but until then, here's an example:
320 tie %hash, 'Tie::RefHash'; #this part is important
322 $cust_pkg => [ $svc_acct ],
325 $cust_main->insert( \%hash );
327 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
328 be set as the invoicing list (see L<"invoicing_list">). Errors return as
329 expected and rollback the entire transaction; it is not necessary to call
330 check_invoicing_list first. The invoicing_list is set after the records in the
331 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
332 invoicing_list destination to the newly-created svc_acct. Here's an example:
334 $cust_main->insert( {}, [ $email, 'POST' ] );
336 Currently available options are: I<depend_jobnum>, I<noexport>,
337 I<tax_exemption> and I<prospectnum>.
339 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
340 on the supplied jobnum (they will not run until the specific job completes).
341 This can be used to defer provisioning until some action completes (such
342 as running the customer's credit card successfully).
344 The I<noexport> option is deprecated. If I<noexport> is set true, no
345 provisioning jobs (exports) are scheduled. (You can schedule them later with
346 the B<reexport> method.)
348 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
349 of tax names and exemption numbers. FS::cust_main_exemption records will be
350 created and inserted.
352 If I<prospectnum> is set, moves contacts and locations from that prospect.
354 If I<contact> is set to an arrayref of FS::contact objects, inserts those
355 new contacts with this new customer.
361 my $cust_pkgs = @_ ? shift : {};
362 my $invoicing_list = @_ ? shift : '';
364 warn "$me insert called with options ".
365 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
368 local $SIG{HUP} = 'IGNORE';
369 local $SIG{INT} = 'IGNORE';
370 local $SIG{QUIT} = 'IGNORE';
371 local $SIG{TERM} = 'IGNORE';
372 local $SIG{TSTP} = 'IGNORE';
373 local $SIG{PIPE} = 'IGNORE';
375 my $oldAutoCommit = $FS::UID::AutoCommit;
376 local $FS::UID::AutoCommit = 0;
379 my $prepay_identifier = '';
380 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
382 if ( $self->payby eq 'PREPAY' ) {
384 $self->payby('BILL');
385 $prepay_identifier = $self->payinfo;
388 warn " looking up prepaid card $prepay_identifier\n"
391 my $error = $self->get_prepay( $prepay_identifier,
392 'amount_ref' => \$amount,
393 'seconds_ref' => \$seconds,
394 'upbytes_ref' => \$upbytes,
395 'downbytes_ref' => \$downbytes,
396 'totalbytes_ref' => \$totalbytes,
399 $dbh->rollback if $oldAutoCommit;
400 #return "error applying prepaid card (transaction rolled back): $error";
404 $payby = 'PREP' if $amount;
406 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|PPAL)$/ ) {
409 $self->payby('BILL');
410 $amount = $self->paid;
415 foreach my $l (qw(bill_location ship_location)) {
416 my $loc = delete $self->hashref->{$l};
417 # XXX if we're moving a prospect's locations, do that here
419 #return "$l not set";
420 #location-less customer records are now permitted
424 if ( !$loc->locationnum ) {
425 # warn the location that we're going to insert it with no custnum
426 $loc->set(custnum_pending => 1);
427 warn " inserting $l\n"
429 my $error = $loc->insert;
431 $dbh->rollback if $oldAutoCommit;
432 my $label = $l eq 'ship_location' ? 'service' : 'billing';
433 return "$error (in $label location)";
436 elsif ( ($loc->custnum || 0) > 0 or $loc->prospectnum ) {
437 # then it somehow belongs to another customer--shouldn't happen
438 $dbh->rollback if $oldAutoCommit;
439 return "$l belongs to customer ".$loc->custnum;
441 # else it already belongs to this customer
442 # (happens when ship_location is identical to bill_location)
444 $self->set($l.'num', $loc->locationnum);
446 if ( $self->get($l.'num') eq '' ) {
447 $dbh->rollback if $oldAutoCommit;
452 warn " inserting $self\n"
455 $self->signupdate(time) unless $self->signupdate;
457 $self->auto_agent_custid()
458 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
460 my $error = $self->SUPER::insert;
462 $dbh->rollback if $oldAutoCommit;
463 #return "inserting cust_main record (transaction rolled back): $error";
467 # now set cust_location.custnum
468 foreach my $l (qw(bill_location ship_location)) {
469 warn " setting $l.custnum\n"
471 my $loc = $self->$l or next;
472 unless ( $loc->custnum ) {
473 $loc->set(custnum => $self->custnum);
474 $error ||= $loc->replace;
478 $dbh->rollback if $oldAutoCommit;
479 return "error setting $l custnum: $error";
483 warn " setting invoicing list\n"
486 if ( $invoicing_list ) {
487 $error = $self->check_invoicing_list( $invoicing_list );
489 $dbh->rollback if $oldAutoCommit;
490 #return "checking invoicing_list (transaction rolled back): $error";
493 $self->invoicing_list( $invoicing_list );
496 warn " setting customer tags\n"
499 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
500 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
501 'custnum' => $self->custnum };
502 my $error = $cust_tag->insert;
504 $dbh->rollback if $oldAutoCommit;
509 my $prospectnum = delete $options{'prospectnum'};
510 if ( $prospectnum ) {
512 warn " moving contacts and locations from prospect $prospectnum\n"
516 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
517 unless ( $prospect_main ) {
518 $dbh->rollback if $oldAutoCommit;
519 return "Unknown prospectnum $prospectnum";
521 $prospect_main->custnum($self->custnum);
522 $prospect_main->disabled('Y');
523 my $error = $prospect_main->replace;
525 $dbh->rollback if $oldAutoCommit;
529 my @contact = $prospect_main->contact;
530 my @cust_location = $prospect_main->cust_location;
531 my @qual = $prospect_main->qual;
533 foreach my $r ( @contact, @cust_location, @qual ) {
535 $r->custnum($self->custnum);
536 my $error = $r->replace;
538 $dbh->rollback if $oldAutoCommit;
545 my $contact = delete $options{'contact'};
548 foreach my $c ( @$contact ) {
549 $c->custnum($self->custnum);
550 my $error = $c->insert;
552 $dbh->rollback if $oldAutoCommit;
560 warn " setting cust_main_exemption\n"
563 my $tax_exemption = delete $options{'tax_exemption'};
564 if ( $tax_exemption ) {
566 $tax_exemption = { map { $_ => '' } @$tax_exemption }
567 if ref($tax_exemption) eq 'ARRAY';
569 foreach my $taxname ( keys %$tax_exemption ) {
570 my $cust_main_exemption = new FS::cust_main_exemption {
571 'custnum' => $self->custnum,
572 'taxname' => $taxname,
573 'exempt_number' => $tax_exemption->{$taxname},
575 my $error = $cust_main_exemption->insert;
577 $dbh->rollback if $oldAutoCommit;
578 return "inserting cust_main_exemption (transaction rolled back): $error";
583 warn " ordering packages\n"
586 $error = $self->order_pkgs( $cust_pkgs,
588 'seconds_ref' => \$seconds,
589 'upbytes_ref' => \$upbytes,
590 'downbytes_ref' => \$downbytes,
591 'totalbytes_ref' => \$totalbytes,
594 $dbh->rollback if $oldAutoCommit;
599 $dbh->rollback if $oldAutoCommit;
600 return "No svc_acct record to apply pre-paid time";
602 if ( $upbytes || $downbytes || $totalbytes ) {
603 $dbh->rollback if $oldAutoCommit;
604 return "No svc_acct record to apply pre-paid data";
608 warn " inserting initial $payby payment of $amount\n"
610 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
612 $dbh->rollback if $oldAutoCommit;
613 return "inserting payment (transaction rolled back): $error";
617 unless ( $import || $skip_fuzzyfiles ) {
618 warn " queueing fuzzyfiles update\n"
620 $error = $self->queue_fuzzyfiles_update;
622 $dbh->rollback if $oldAutoCommit;
623 return "updating fuzzy search cache: $error";
627 # FS::geocode_Mixin::after_insert or something?
628 if ( $conf->config('tax_district_method') and !$import ) {
629 # if anything non-empty, try to look it up
630 my $queue = new FS::queue {
631 'job' => 'FS::geocode_Mixin::process_district_update',
632 'custnum' => $self->custnum,
634 my $error = $queue->insert( ref($self), $self->custnum );
636 $dbh->rollback if $oldAutoCommit;
637 return "queueing tax district update: $error";
642 warn " exporting\n" if $DEBUG > 1;
644 my $export_args = $options{'export_args'} || [];
647 map qsearch( 'part_export', {exportnum=>$_} ),
648 $conf->config('cust_main-exports'); #, $agentnum
650 foreach my $part_export ( @part_export ) {
651 my $error = $part_export->export_insert($self, @$export_args);
653 $dbh->rollback if $oldAutoCommit;
654 return "exporting to ". $part_export->exporttype.
655 " (transaction rolled back): $error";
659 #foreach my $depend_jobnum ( @$depend_jobnums ) {
660 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
662 # foreach my $jobnum ( @jobnums ) {
663 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
664 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
666 # my $error = $queue->depend_insert($depend_jobnum);
668 # $dbh->rollback if $oldAutoCommit;
669 # return "error queuing job dependancy: $error";
676 #if ( exists $options{'jobnums'} ) {
677 # push @{ $options{'jobnums'} }, @jobnums;
680 warn " insert complete; committing transaction\n"
683 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
688 use File::CounterFile;
689 sub auto_agent_custid {
692 my $format = $conf->config('cust_main-auto_agent_custid');
694 if ( $format eq '1YMMXXXXXXXX' ) {
696 my $counter = new File::CounterFile 'cust_main.agent_custid';
699 my $ym = 100000000000 + time2str('%y%m00000000', time);
700 if ( $ym > $counter->value ) {
701 $counter->{'value'} = $agent_custid = $ym;
702 $counter->{'updated'} = 1;
704 $agent_custid = $counter->inc;
710 die "Unknown cust_main-auto_agent_custid format: $format";
713 $self->agent_custid($agent_custid);
717 =item PACKAGE METHODS
719 Documentation on customer package methods has been moved to
720 L<FS::cust_main::Packages>.
722 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
724 Recharges this (existing) customer with the specified prepaid card (see
725 L<FS::prepay_credit>), specified either by I<identifier> or as an
726 FS::prepay_credit object. If there is an error, returns the error, otherwise
729 Optionally, five scalar references can be passed as well. They will have their
730 values filled in with the amount, number of seconds, and number of upload,
731 download, and total bytes applied by this prepaid card.
735 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
736 #the only place that uses these args
737 sub recharge_prepay {
738 my( $self, $prepay_credit, $amountref, $secondsref,
739 $upbytesref, $downbytesref, $totalbytesref ) = @_;
741 local $SIG{HUP} = 'IGNORE';
742 local $SIG{INT} = 'IGNORE';
743 local $SIG{QUIT} = 'IGNORE';
744 local $SIG{TERM} = 'IGNORE';
745 local $SIG{TSTP} = 'IGNORE';
746 local $SIG{PIPE} = 'IGNORE';
748 my $oldAutoCommit = $FS::UID::AutoCommit;
749 local $FS::UID::AutoCommit = 0;
752 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
754 my $error = $self->get_prepay( $prepay_credit,
755 'amount_ref' => \$amount,
756 'seconds_ref' => \$seconds,
757 'upbytes_ref' => \$upbytes,
758 'downbytes_ref' => \$downbytes,
759 'totalbytes_ref' => \$totalbytes,
761 || $self->increment_seconds($seconds)
762 || $self->increment_upbytes($upbytes)
763 || $self->increment_downbytes($downbytes)
764 || $self->increment_totalbytes($totalbytes)
765 || $self->insert_cust_pay_prepay( $amount,
767 ? $prepay_credit->identifier
772 $dbh->rollback if $oldAutoCommit;
776 if ( defined($amountref) ) { $$amountref = $amount; }
777 if ( defined($secondsref) ) { $$secondsref = $seconds; }
778 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
779 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
780 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
782 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
787 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
789 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
790 specified either by I<identifier> or as an FS::prepay_credit object.
792 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
793 incremented by the values of the prepaid card.
795 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
796 check or set this customer's I<agentnum>.
798 If there is an error, returns the error, otherwise returns false.
804 my( $self, $prepay_credit, %opt ) = @_;
806 local $SIG{HUP} = 'IGNORE';
807 local $SIG{INT} = 'IGNORE';
808 local $SIG{QUIT} = 'IGNORE';
809 local $SIG{TERM} = 'IGNORE';
810 local $SIG{TSTP} = 'IGNORE';
811 local $SIG{PIPE} = 'IGNORE';
813 my $oldAutoCommit = $FS::UID::AutoCommit;
814 local $FS::UID::AutoCommit = 0;
817 unless ( ref($prepay_credit) ) {
819 my $identifier = $prepay_credit;
821 $prepay_credit = qsearchs(
823 { 'identifier' => $identifier },
828 unless ( $prepay_credit ) {
829 $dbh->rollback if $oldAutoCommit;
830 return "Invalid prepaid card: ". $identifier;
835 if ( $prepay_credit->agentnum ) {
836 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
837 $dbh->rollback if $oldAutoCommit;
838 return "prepaid card not valid for agent ". $self->agentnum;
840 $self->agentnum($prepay_credit->agentnum);
843 my $error = $prepay_credit->delete;
845 $dbh->rollback if $oldAutoCommit;
846 return "removing prepay_credit (transaction rolled back): $error";
849 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
850 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
852 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
857 =item increment_upbytes SECONDS
859 Updates this customer's single or primary account (see L<FS::svc_acct>) by
860 the specified number of upbytes. If there is an error, returns the error,
861 otherwise returns false.
865 sub increment_upbytes {
866 _increment_column( shift, 'upbytes', @_);
869 =item increment_downbytes SECONDS
871 Updates this customer's single or primary account (see L<FS::svc_acct>) by
872 the specified number of downbytes. If there is an error, returns the error,
873 otherwise returns false.
877 sub increment_downbytes {
878 _increment_column( shift, 'downbytes', @_);
881 =item increment_totalbytes SECONDS
883 Updates this customer's single or primary account (see L<FS::svc_acct>) by
884 the specified number of totalbytes. If there is an error, returns the error,
885 otherwise returns false.
889 sub increment_totalbytes {
890 _increment_column( shift, 'totalbytes', @_);
893 =item increment_seconds SECONDS
895 Updates this customer's single or primary account (see L<FS::svc_acct>) by
896 the specified number of seconds. If there is an error, returns the error,
897 otherwise returns false.
901 sub increment_seconds {
902 _increment_column( shift, 'seconds', @_);
905 =item _increment_column AMOUNT
907 Updates this customer's single or primary account (see L<FS::svc_acct>) by
908 the specified number of seconds or bytes. If there is an error, returns
909 the error, otherwise returns false.
913 sub _increment_column {
914 my( $self, $column, $amount ) = @_;
915 warn "$me increment_column called: $column, $amount\n"
918 return '' unless $amount;
920 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
921 $self->ncancelled_pkgs;
924 return 'No packages with primary or single services found'.
925 ' to apply pre-paid time';
926 } elsif ( scalar(@cust_pkg) > 1 ) {
927 #maybe have a way to specify the package/account?
928 return 'Multiple packages found to apply pre-paid time';
931 my $cust_pkg = $cust_pkg[0];
932 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
936 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
939 return 'No account found to apply pre-paid time';
940 } elsif ( scalar(@cust_svc) > 1 ) {
941 return 'Multiple accounts found to apply pre-paid time';
944 my $svc_acct = $cust_svc[0]->svc_x;
945 warn " found service svcnum ". $svc_acct->pkgnum.
946 ' ('. $svc_acct->email. ")\n"
949 $column = "increment_$column";
950 $svc_acct->$column($amount);
954 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
956 Inserts a prepayment in the specified amount for this customer. An optional
957 second argument can specify the prepayment identifier for tracking purposes.
958 If there is an error, returns the error, otherwise returns false.
962 sub insert_cust_pay_prepay {
963 shift->insert_cust_pay('PREP', @_);
966 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
968 Inserts a cash payment in the specified amount for this customer. An optional
969 second argument can specify the payment identifier for tracking purposes.
970 If there is an error, returns the error, otherwise returns false.
974 sub insert_cust_pay_cash {
975 shift->insert_cust_pay('CASH', @_);
978 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
980 Inserts a Western Union payment in the specified amount for this customer. An
981 optional second argument can specify the prepayment identifier for tracking
982 purposes. If there is an error, returns the error, otherwise returns false.
986 sub insert_cust_pay_west {
987 shift->insert_cust_pay('WEST', @_);
990 sub insert_cust_pay {
991 my( $self, $payby, $amount ) = splice(@_, 0, 3);
992 my $payinfo = scalar(@_) ? shift : '';
994 my $cust_pay = new FS::cust_pay {
995 'custnum' => $self->custnum,
996 'paid' => sprintf('%.2f', $amount),
997 #'_date' => #date the prepaid card was purchased???
999 'payinfo' => $payinfo,
1005 =item delete [ OPTION => VALUE ... ]
1007 This deletes the customer. If there is an error, returns the error, otherwise
1010 This will completely remove all traces of the customer record. This is not
1011 what you want when a customer cancels service; for that, cancel all of the
1012 customer's packages (see L</cancel>).
1014 If the customer has any uncancelled packages, you need to pass a new (valid)
1015 customer number for those packages to be transferred to, as the "new_customer"
1016 option. Cancelled packages will be deleted. Did I mention that this is NOT
1017 what you want when a customer cancels service and that you really should be
1018 looking at L<FS::cust_pkg/cancel>?
1020 You can't delete a customer with invoices (see L<FS::cust_bill>),
1021 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1022 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1023 set the "delete_financials" option to a true value.
1028 my( $self, %opt ) = @_;
1030 local $SIG{HUP} = 'IGNORE';
1031 local $SIG{INT} = 'IGNORE';
1032 local $SIG{QUIT} = 'IGNORE';
1033 local $SIG{TERM} = 'IGNORE';
1034 local $SIG{TSTP} = 'IGNORE';
1035 local $SIG{PIPE} = 'IGNORE';
1037 my $oldAutoCommit = $FS::UID::AutoCommit;
1038 local $FS::UID::AutoCommit = 0;
1041 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1042 $dbh->rollback if $oldAutoCommit;
1043 return "Can't delete a master agent customer";
1046 #use FS::access_user
1047 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1048 $dbh->rollback if $oldAutoCommit;
1049 return "Can't delete a master employee customer";
1052 tie my %financial_tables, 'Tie::IxHash',
1053 'cust_bill' => 'invoices',
1054 'cust_statement' => 'statements',
1055 'cust_credit' => 'credits',
1056 'cust_pay' => 'payments',
1057 'cust_refund' => 'refunds',
1060 foreach my $table ( keys %financial_tables ) {
1062 my @records = $self->$table();
1064 if ( @records && ! $opt{'delete_financials'} ) {
1065 $dbh->rollback if $oldAutoCommit;
1066 return "Can't delete a customer with ". $financial_tables{$table};
1069 foreach my $record ( @records ) {
1070 my $error = $record->delete;
1072 $dbh->rollback if $oldAutoCommit;
1073 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1079 my @cust_pkg = $self->ncancelled_pkgs;
1081 my $new_custnum = $opt{'new_custnum'};
1082 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1083 $dbh->rollback if $oldAutoCommit;
1084 return "Invalid new customer number: $new_custnum";
1086 foreach my $cust_pkg ( @cust_pkg ) {
1087 my %hash = $cust_pkg->hash;
1088 $hash{'custnum'} = $new_custnum;
1089 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1090 my $error = $new_cust_pkg->replace($cust_pkg,
1091 options => { $cust_pkg->options },
1094 $dbh->rollback if $oldAutoCommit;
1099 my @cancelled_cust_pkg = $self->all_pkgs;
1100 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1101 my $error = $cust_pkg->delete;
1103 $dbh->rollback if $oldAutoCommit;
1108 #cust_tax_adjustment in financials?
1109 #cust_pay_pending? ouch
1111 foreach my $table (qw(
1112 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1113 cust_location cust_main_note cust_tax_adjustment
1114 cust_pay_void cust_pay_batch queue cust_tax_exempt
1116 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1117 my $error = $record->delete;
1119 $dbh->rollback if $oldAutoCommit;
1125 my $sth = $dbh->prepare(
1126 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1128 my $errstr = $dbh->errstr;
1129 $dbh->rollback if $oldAutoCommit;
1132 $sth->execute($self->custnum) or do {
1133 my $errstr = $sth->errstr;
1134 $dbh->rollback if $oldAutoCommit;
1140 my $ticket_dbh = '';
1141 if ($conf->config('ticket_system') eq 'RT_Internal') {
1143 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1144 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1145 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1146 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1149 if ( $ticket_dbh ) {
1151 my $ticket_sth = $ticket_dbh->prepare(
1152 'DELETE FROM Links WHERE Target = ?'
1154 my $errstr = $ticket_dbh->errstr;
1155 $dbh->rollback if $oldAutoCommit;
1158 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1160 my $errstr = $ticket_sth->errstr;
1161 $dbh->rollback if $oldAutoCommit;
1165 #check and see if the customer is the only link on the ticket, and
1166 #if so, set the ticket to deleted status in RT?
1167 #maybe someday, for now this will at least fix tickets not displaying
1171 #delete the customer record
1173 my $error = $self->SUPER::delete;
1175 $dbh->rollback if $oldAutoCommit;
1179 # cust_main exports!
1181 #my $export_args = $options{'export_args'} || [];
1184 map qsearch( 'part_export', {exportnum=>$_} ),
1185 $conf->config('cust_main-exports'); #, $agentnum
1187 foreach my $part_export ( @part_export ) {
1188 my $error = $part_export->export_delete( $self ); #, @$export_args);
1190 $dbh->rollback if $oldAutoCommit;
1191 return "exporting to ". $part_export->exporttype.
1192 " (transaction rolled back): $error";
1196 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1201 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1203 This merges this customer into the provided new custnum, and then deletes the
1204 customer. If there is an error, returns the error, otherwise returns false.
1206 The source customer's name, company name, phone numbers, agent,
1207 referring customer, customer class, advertising source, order taker, and
1208 billing information (except balance) are discarded.
1210 All packages are moved to the target customer. Packages with package locations
1211 are preserved. Packages without package locations are moved to a new package
1212 location with the source customer's service/shipping address.
1214 All invoices, statements, payments, credits and refunds are moved to the target
1215 customer. The source customer's balance is added to the target customer.
1217 All notes, attachments, tickets and customer tags are moved to the target
1220 Change history is not currently moved.
1225 my( $self, $new_custnum, %opt ) = @_;
1227 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1229 my $new_cust_main = qsearchs( 'cust_main', { 'custnum' => $new_custnum } )
1230 or return "Invalid new customer number: $new_custnum";
1232 return 'Access denied: "Merge customer across agents" access right required to merge into a customer of a different agent'
1233 if $self->agentnum != $new_cust_main->agentnum
1234 && ! $FS::CurrentUser::CurrentUser->access_right('Merge customer across agents');
1236 local $SIG{HUP} = 'IGNORE';
1237 local $SIG{INT} = 'IGNORE';
1238 local $SIG{QUIT} = 'IGNORE';
1239 local $SIG{TERM} = 'IGNORE';
1240 local $SIG{TSTP} = 'IGNORE';
1241 local $SIG{PIPE} = 'IGNORE';
1243 my $oldAutoCommit = $FS::UID::AutoCommit;
1244 local $FS::UID::AutoCommit = 0;
1247 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1248 $dbh->rollback if $oldAutoCommit;
1249 return "Can't merge a master agent customer";
1252 #use FS::access_user
1253 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1254 $dbh->rollback if $oldAutoCommit;
1255 return "Can't merge a master employee customer";
1258 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1259 'status' => { op=>'!=', value=>'done' },
1263 $dbh->rollback if $oldAutoCommit;
1264 return "Can't merge a customer with pending payments";
1267 tie my %financial_tables, 'Tie::IxHash',
1268 'cust_bill' => 'invoices',
1269 'cust_bill_void' => 'voided invoices',
1270 'cust_statement' => 'statements',
1271 'cust_credit' => 'credits',
1272 'cust_credit_void' => 'voided credits',
1273 'cust_pay' => 'payments',
1274 'cust_pay_void' => 'voided payments',
1275 'cust_refund' => 'refunds',
1278 foreach my $table ( keys %financial_tables ) {
1280 my @records = $self->$table();
1282 foreach my $record ( @records ) {
1283 $record->custnum($new_custnum);
1284 my $error = $record->replace;
1286 $dbh->rollback if $oldAutoCommit;
1287 return "Error merging ". $financial_tables{$table}. ": $error\n";
1293 my $name = $self->ship_name; #?
1295 my $locationnum = '';
1296 foreach my $cust_pkg ( $self->all_pkgs ) {
1297 $cust_pkg->custnum($new_custnum);
1299 unless ( $cust_pkg->locationnum ) {
1300 unless ( $locationnum ) {
1301 my $cust_location = new FS::cust_location {
1302 $self->location_hash,
1303 'custnum' => $new_custnum,
1305 my $error = $cust_location->insert;
1307 $dbh->rollback if $oldAutoCommit;
1310 $locationnum = $cust_location->locationnum;
1312 $cust_pkg->locationnum($locationnum);
1315 my $error = $cust_pkg->replace;
1317 $dbh->rollback if $oldAutoCommit;
1321 # add customer (ship) name to svc_phone.phone_name if blank
1322 my @cust_svc = $cust_pkg->cust_svc;
1323 foreach my $cust_svc (@cust_svc) {
1324 my($label, $value, $svcdb) = $cust_svc->label;
1325 next unless $svcdb eq 'svc_phone';
1326 my $svc_phone = $cust_svc->svc_x;
1327 next if $svc_phone->phone_name;
1328 $svc_phone->phone_name($name);
1329 my $error = $svc_phone->replace;
1331 $dbh->rollback if $oldAutoCommit;
1339 # cust_tax_exempt (texas tax exemptions)
1340 # cust_recon (some sort of not-well understood thing for OnPac)
1342 #these are moved over
1343 foreach my $table (qw(
1344 cust_tag cust_location contact cust_attachment cust_main_note
1345 cust_tax_adjustment cust_pay_batch queue
1347 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1348 $record->custnum($new_custnum);
1349 my $error = $record->replace;
1351 $dbh->rollback if $oldAutoCommit;
1357 #these aren't preserved
1358 foreach my $table (qw(
1359 cust_main_exemption cust_main_invoice
1361 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1362 my $error = $record->delete;
1364 $dbh->rollback if $oldAutoCommit;
1371 my $sth = $dbh->prepare(
1372 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1374 my $errstr = $dbh->errstr;
1375 $dbh->rollback if $oldAutoCommit;
1378 $sth->execute($new_custnum, $self->custnum) or do {
1379 my $errstr = $sth->errstr;
1380 $dbh->rollback if $oldAutoCommit;
1386 my $ticket_dbh = '';
1387 if ($conf->config('ticket_system') eq 'RT_Internal') {
1389 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1390 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1391 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1392 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1395 if ( $ticket_dbh ) {
1397 my $ticket_sth = $ticket_dbh->prepare(
1398 'UPDATE Links SET Target = ? WHERE Target = ?'
1400 my $errstr = $ticket_dbh->errstr;
1401 $dbh->rollback if $oldAutoCommit;
1404 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1405 'freeside://freeside/cust_main/'.$self->custnum)
1407 my $errstr = $ticket_sth->errstr;
1408 $dbh->rollback if $oldAutoCommit;
1414 #delete the customer record
1416 my $error = $self->delete;
1418 $dbh->rollback if $oldAutoCommit;
1422 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1427 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1429 Replaces the OLD_RECORD with this one in the database. If there is an error,
1430 returns the error, otherwise returns false.
1432 To change the customer's address, set the pseudo-fields C<bill_location> and
1433 C<ship_location>. The address will still only change if at least one of the
1434 address fields differs from the existing values.
1436 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1437 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1438 expected and rollback the entire transaction; it is not necessary to call
1439 check_invoicing_list first. Here's an example:
1441 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1443 Currently available options are: I<tax_exemption>.
1445 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1446 of tax names and exemption numbers. FS::cust_main_exemption records will be
1447 deleted and inserted as appropriate.
1454 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1456 : $self->replace_old;
1460 warn "$me replace called\n"
1463 my $curuser = $FS::CurrentUser::CurrentUser;
1464 if ( $self->payby eq 'COMP'
1465 && $self->payby ne $old->payby
1466 && ! $curuser->access_right('Complimentary customer')
1469 return "You are not permitted to create complimentary accounts.";
1472 local($ignore_expired_card) = 1
1473 if $old->payby =~ /^(CARD|DCRD)$/
1474 && $self->payby =~ /^(CARD|DCRD)$/
1475 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1477 local($ignore_banned_card) = 1
1478 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1479 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1480 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1482 return "Invoicing locale is required"
1485 && $conf->exists('cust_main-require_locale');
1487 local $SIG{HUP} = 'IGNORE';
1488 local $SIG{INT} = 'IGNORE';
1489 local $SIG{QUIT} = 'IGNORE';
1490 local $SIG{TERM} = 'IGNORE';
1491 local $SIG{TSTP} = 'IGNORE';
1492 local $SIG{PIPE} = 'IGNORE';
1494 my $oldAutoCommit = $FS::UID::AutoCommit;
1495 local $FS::UID::AutoCommit = 0;
1498 for my $l (qw(bill_location ship_location)) {
1499 my $old_loc = $old->$l;
1500 my $new_loc = $self->$l;
1502 # find the existing location if there is one
1503 $new_loc->set('custnum' => $self->custnum);
1504 my $error = $new_loc->find_or_insert;
1506 $dbh->rollback if $oldAutoCommit;
1509 $self->set($l.'num', $new_loc->locationnum);
1512 # replace the customer record
1513 my $error = $self->SUPER::replace($old);
1516 $dbh->rollback if $oldAutoCommit;
1520 # now move packages to the new service location
1521 $self->set('ship_location', ''); #flush cache
1522 if ( $old->ship_locationnum and # should only be null during upgrade...
1523 $old->ship_locationnum != $self->ship_locationnum ) {
1524 $error = $old->ship_location->move_to($self->ship_location);
1526 $dbh->rollback if $oldAutoCommit;
1530 # don't move packages based on the billing location, but
1531 # disable it if it's no longer in use
1532 if ( $old->bill_locationnum and
1533 $old->bill_locationnum != $self->bill_locationnum ) {
1534 $error = $old->bill_location->disable_if_unused;
1536 $dbh->rollback if $oldAutoCommit;
1541 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1542 my $invoicing_list = shift @param;
1543 $error = $self->check_invoicing_list( $invoicing_list );
1545 $dbh->rollback if $oldAutoCommit;
1548 $self->invoicing_list( $invoicing_list );
1551 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1553 #this could be more efficient than deleting and re-inserting, if it matters
1554 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1555 my $error = $cust_tag->delete;
1557 $dbh->rollback if $oldAutoCommit;
1561 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1562 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1563 'custnum' => $self->custnum };
1564 my $error = $cust_tag->insert;
1566 $dbh->rollback if $oldAutoCommit;
1573 my %options = @param;
1575 my $tax_exemption = delete $options{'tax_exemption'};
1576 if ( $tax_exemption ) {
1578 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1579 if ref($tax_exemption) eq 'ARRAY';
1581 my %cust_main_exemption =
1582 map { $_->taxname => $_ }
1583 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1585 foreach my $taxname ( keys %$tax_exemption ) {
1587 if ( $cust_main_exemption{$taxname} &&
1588 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1591 delete $cust_main_exemption{$taxname};
1595 my $cust_main_exemption = new FS::cust_main_exemption {
1596 'custnum' => $self->custnum,
1597 'taxname' => $taxname,
1598 'exempt_number' => $tax_exemption->{$taxname},
1600 my $error = $cust_main_exemption->insert;
1602 $dbh->rollback if $oldAutoCommit;
1603 return "inserting cust_main_exemption (transaction rolled back): $error";
1607 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1608 my $error = $cust_main_exemption->delete;
1610 $dbh->rollback if $oldAutoCommit;
1611 return "deleting cust_main_exemption (transaction rolled back): $error";
1617 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1618 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1619 && $self->get('payinfo') !~ /^99\d{14}$/
1621 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1626 # card/check/lec info has changed, want to retry realtime_ invoice events
1627 my $error = $self->retry_realtime;
1629 $dbh->rollback if $oldAutoCommit;
1634 unless ( $import || $skip_fuzzyfiles ) {
1635 $error = $self->queue_fuzzyfiles_update;
1637 $dbh->rollback if $oldAutoCommit;
1638 return "updating fuzzy search cache: $error";
1642 # tax district update in cust_location
1644 # cust_main exports!
1646 my $export_args = $options{'export_args'} || [];
1649 map qsearch( 'part_export', {exportnum=>$_} ),
1650 $conf->config('cust_main-exports'); #, $agentnum
1652 foreach my $part_export ( @part_export ) {
1653 my $error = $part_export->export_replace( $self, $old, @$export_args);
1655 $dbh->rollback if $oldAutoCommit;
1656 return "exporting to ". $part_export->exporttype.
1657 " (transaction rolled back): $error";
1661 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1666 =item queue_fuzzyfiles_update
1668 Used by insert & replace to update the fuzzy search cache
1672 use FS::cust_main::Search;
1673 sub queue_fuzzyfiles_update {
1676 local $SIG{HUP} = 'IGNORE';
1677 local $SIG{INT} = 'IGNORE';
1678 local $SIG{QUIT} = 'IGNORE';
1679 local $SIG{TERM} = 'IGNORE';
1680 local $SIG{TSTP} = 'IGNORE';
1681 local $SIG{PIPE} = 'IGNORE';
1683 my $oldAutoCommit = $FS::UID::AutoCommit;
1684 local $FS::UID::AutoCommit = 0;
1687 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1688 my $queue = new FS::queue {
1689 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1691 my @args = "cust_main.$field", $self->get($field);
1692 my $error = $queue->insert( @args );
1694 $dbh->rollback if $oldAutoCommit;
1695 return "queueing job (transaction rolled back): $error";
1700 push @locations, $self->bill_location if $self->bill_locationnum;
1701 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1702 foreach my $location (@locations) {
1703 my $queue = new FS::queue {
1704 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1706 my @args = 'cust_location.address1', $location->address1;
1707 my $error = $queue->insert( @args );
1709 $dbh->rollback if $oldAutoCommit;
1710 return "queueing job (transaction rolled back): $error";
1714 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1721 Checks all fields to make sure this is a valid customer record. If there is
1722 an error, returns the error, otherwise returns false. Called by the insert
1723 and replace methods.
1730 warn "$me check BEFORE: \n". $self->_dump
1734 $self->ut_numbern('custnum')
1735 || $self->ut_number('agentnum')
1736 || $self->ut_textn('agent_custid')
1737 || $self->ut_number('refnum')
1738 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1739 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1740 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1741 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1742 || $self->ut_textn('custbatch')
1743 || $self->ut_name('last')
1744 || $self->ut_name('first')
1745 || $self->ut_snumbern('signupdate')
1746 || $self->ut_snumbern('birthdate')
1747 || $self->ut_snumbern('spouse_birthdate')
1748 || $self->ut_snumbern('anniversary_date')
1749 || $self->ut_textn('company')
1750 || $self->ut_textn('ship_company')
1751 || $self->ut_anything('comments')
1752 || $self->ut_numbern('referral_custnum')
1753 || $self->ut_textn('stateid')
1754 || $self->ut_textn('stateid_state')
1755 || $self->ut_textn('invoice_terms')
1756 || $self->ut_floatn('cdr_termination_percentage')
1757 || $self->ut_floatn('credit_limit')
1758 || $self->ut_numbern('billday')
1759 || $self->ut_numbern('prorate_day')
1760 || $self->ut_flag('edit_subject')
1761 || $self->ut_flag('calling_list_exempt')
1762 || $self->ut_flag('invoice_noemail')
1763 || $self->ut_flag('message_noemail')
1764 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1765 || $self->ut_currencyn('currency')
1768 foreach (qw(company ship_company)) {
1769 my $company = $self->get($_);
1770 $company =~ s/^\s+//;
1771 $company =~ s/\s+$//;
1772 $company =~ s/\s+/ /g;
1773 $self->set($_, $company);
1776 #barf. need message catalogs. i18n. etc.
1777 $error .= "Please select an advertising source."
1778 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1779 return $error if $error;
1781 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1782 or return "Unknown agent";
1784 if ( $self->currency ) {
1785 my $agent_currency = qsearchs( 'agent_currency', {
1786 'agentnum' => $agent->agentnum,
1787 'currency' => $self->currency,
1789 or return "Agent ". $agent->agent.
1790 " not permitted to offer ". $self->currency. " invoicing";
1793 return "Unknown refnum"
1794 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1796 return "Unknown referring custnum: ". $self->referral_custnum
1797 unless ! $self->referral_custnum
1798 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1800 if ( $self->ss eq '' ) {
1805 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1806 or return "Illegal social security number: ". $self->ss;
1807 $self->ss("$1-$2-$3");
1810 # cust_main_county verification now handled by cust_location check
1813 $self->ut_phonen('daytime', $self->country)
1814 || $self->ut_phonen('night', $self->country)
1815 || $self->ut_phonen('fax', $self->country)
1816 || $self->ut_phonen('mobile', $self->country)
1818 return $error if $error;
1820 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1822 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1825 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1827 : FS::Msgcat::_gettext('daytime');
1828 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1830 : FS::Msgcat::_gettext('night');
1832 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1834 : FS::Msgcat::_gettext('mobile');
1836 return "$daytime_label, $night_label or $mobile_label is required"
1840 ### start of stuff moved to cust_payby
1841 # then mostly kept here to support upgrades (can remove in 5.x)
1842 # but modified to allow everything to be empty
1844 if ( $self->payby ) {
1845 FS::payby->can_payby($self->table, $self->payby)
1846 or return "Illegal payby: ". $self->payby;
1851 $error = $self->ut_numbern('paystart_month')
1852 || $self->ut_numbern('paystart_year')
1853 || $self->ut_numbern('payissue')
1854 || $self->ut_textn('paytype')
1856 return $error if $error;
1858 if ( $self->payip eq '' ) {
1861 $error = $self->ut_ip('payip');
1862 return $error if $error;
1865 # If it is encrypted and the private key is not availaible then we can't
1866 # check the credit card.
1867 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1869 # Need some kind of global flag to accept invalid cards, for testing
1871 if ( !$import && !$ignore_invalid_card && $check_payinfo &&
1872 $self->payby =~ /^(CARD|DCRD)$/ ) {
1874 my $payinfo = $self->payinfo;
1875 $payinfo =~ s/\D//g;
1876 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1877 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1879 $self->payinfo($payinfo);
1881 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1883 return gettext('unknown_card_type')
1884 if $self->payinfo !~ /^99\d{14}$/ #token
1885 && cardtype($self->payinfo) eq "Unknown";
1887 unless ( $ignore_banned_card ) {
1888 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1890 if ( $ban->bantype eq 'warn' ) {
1891 #or others depending on value of $ban->reason ?
1892 return '_duplicate_card'.
1893 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1894 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1895 ' (ban# '. $ban->bannum. ')'
1896 unless $self->override_ban_warn;
1898 return 'Banned credit card: banned on '.
1899 time2str('%a %h %o at %r', $ban->_date).
1900 ' by '. $ban->otaker.
1901 ' (ban# '. $ban->bannum. ')';
1906 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1907 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1908 $self->paycvv =~ /^(\d{4})$/
1909 or return "CVV2 (CID) for American Express cards is four digits.";
1912 $self->paycvv =~ /^(\d{3})$/
1913 or return "CVV2 (CVC2/CID) is three digits.";
1920 my $cardtype = cardtype($payinfo);
1921 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1923 return "Start date or issue number is required for $cardtype cards"
1924 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1926 return "Start month must be between 1 and 12"
1927 if $self->paystart_month
1928 and $self->paystart_month < 1 || $self->paystart_month > 12;
1930 return "Start year must be 1990 or later"
1931 if $self->paystart_year
1932 and $self->paystart_year < 1990;
1934 return "Issue number must be beween 1 and 99"
1936 and $self->payissue < 1 || $self->payissue > 99;
1939 $self->paystart_month('');
1940 $self->paystart_year('');
1941 $self->payissue('');
1944 } elsif ( !$ignore_invalid_card && $check_payinfo &&
1945 $self->payby =~ /^(CHEK|DCHK)$/ ) {
1947 my $payinfo = $self->payinfo;
1948 $payinfo =~ s/[^\d\@\.]//g;
1949 if ( $conf->config('echeck-country') eq 'CA' ) {
1950 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1951 or return 'invalid echeck account@branch.bank';
1952 $payinfo = "$1\@$2.$3";
1953 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1954 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1955 $payinfo = "$1\@$2";
1957 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1958 $payinfo = "$1\@$2";
1960 $self->payinfo($payinfo);
1963 unless ( $ignore_banned_card ) {
1964 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1966 if ( $ban->bantype eq 'warn' ) {
1967 #or others depending on value of $ban->reason ?
1968 return '_duplicate_ach' unless $self->override_ban_warn;
1970 return 'Banned ACH account: banned on '.
1971 time2str('%a %h %o at %r', $ban->_date).
1972 ' by '. $ban->otaker.
1973 ' (ban# '. $ban->bannum. ')';
1978 } elsif ( $self->payby eq 'LECB' ) {
1980 my $payinfo = $self->payinfo;
1981 $payinfo =~ s/\D//g;
1982 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1984 $self->payinfo($payinfo);
1987 } elsif ( $self->payby eq 'BILL' ) {
1989 $error = $self->ut_textn('payinfo');
1990 return "Illegal P.O. number: ". $self->payinfo if $error;
1993 } elsif ( $self->payby eq 'COMP' ) {
1995 my $curuser = $FS::CurrentUser::CurrentUser;
1996 if ( ! $self->custnum
1997 && ! $curuser->access_right('Complimentary customer')
2000 return "You are not permitted to create complimentary accounts."
2003 $error = $self->ut_textn('payinfo');
2004 return "Illegal comp account issuer: ". $self->payinfo if $error;
2007 } elsif ( $self->payby eq 'PREPAY' ) {
2009 my $payinfo = $self->payinfo;
2010 $payinfo =~ s/\W//g; #anything else would just confuse things
2011 $self->payinfo($payinfo);
2012 $error = $self->ut_alpha('payinfo');
2013 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2014 return "Unknown prepayment identifier"
2015 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2020 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2021 return "Expiration date required"
2022 # shouldn't payinfo_check do this?
2023 unless ! $self->payby
2024 || $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
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') );
2053 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2054 $self->payname =~ /^([\w \,\.\-\']*)$/
2055 or return gettext('illegal_name'). " payname: ". $self->payname;
2058 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2059 or return gettext('illegal_name'). " payname: ". $self->payname;
2065 ### end of stuff moved to cust_payby
2067 return "Please select an invoicing locale"
2070 && $conf->exists('cust_main-require_locale');
2072 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2073 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2077 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2079 warn "$me check AFTER: \n". $self->_dump
2082 $self->SUPER::check;
2087 Returns a list of fields which have ship_ duplicates.
2092 qw( last first company
2093 address1 address2 city county state zip country
2095 daytime night fax mobile
2099 =item has_ship_address
2101 Returns true if this customer record has a separate shipping address.
2105 sub has_ship_address {
2107 $self->bill_locationnum != $self->ship_locationnum;
2112 Returns a list of key/value pairs, with the following keys: address1,
2113 adddress2, city, county, state, zip, country, district, and geocode. The
2114 shipping address is used if present.
2120 $self->ship_location->location_hash;
2125 Returns all locations (see L<FS::cust_location>) for this customer.
2131 qsearch('cust_location', { 'custnum' => $self->custnum,
2132 'prospectnum' => '' } );
2137 Returns all contacts (see L<FS::contact>) for this customer.
2141 #already used :/ sub contact {
2144 qsearch('contact', { 'custnum' => $self->custnum } );
2149 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2156 'table' => 'cust_payby',
2157 'hashref' => { 'custnum' => $self->custnum },
2158 'order_by' => 'ORDER BY weight ASC',
2164 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2165 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2166 on success or a list of errors.
2172 grep { $_->unsuspend } $self->suspended_pkgs;
2177 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2179 Returns a list: an empty list on success or a list of errors.
2185 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2188 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2190 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2191 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2192 of a list of pkgparts; the hashref has the following keys:
2196 =item pkgparts - listref of pkgparts
2198 =item (other options are passed to the suspend method)
2203 Returns a list: an empty list on success or a list of errors.
2207 sub suspend_if_pkgpart {
2209 my (@pkgparts, %opt);
2210 if (ref($_[0]) eq 'HASH'){
2211 @pkgparts = @{$_[0]{pkgparts}};
2216 grep { $_->suspend(%opt) }
2217 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2218 $self->unsuspended_pkgs;
2221 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2223 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2224 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2225 instead of a list of pkgparts; the hashref has the following keys:
2229 =item pkgparts - listref of pkgparts
2231 =item (other options are passed to the suspend method)
2235 Returns a list: an empty list on success or a list of errors.
2239 sub suspend_unless_pkgpart {
2241 my (@pkgparts, %opt);
2242 if (ref($_[0]) eq 'HASH'){
2243 @pkgparts = @{$_[0]{pkgparts}};
2248 grep { $_->suspend(%opt) }
2249 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2250 $self->unsuspended_pkgs;
2253 =item cancel [ OPTION => VALUE ... ]
2255 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2257 Available options are:
2261 =item quiet - can be set true to supress email cancellation notices.
2263 =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.
2265 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2267 =item nobill - can be set true to skip billing if it might otherwise be done.
2271 Always returns a list: an empty list on success or a list of errors.
2275 # nb that dates are not specified as valid options to this method
2278 my( $self, %opt ) = @_;
2280 warn "$me cancel called on customer ". $self->custnum. " with options ".
2281 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2284 return ( 'access denied' )
2285 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2287 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2289 #should try decryption (we might have the private key)
2290 # and if not maybe queue a job for the server that does?
2291 return ( "Can't (yet) ban encrypted credit cards" )
2292 if $self->is_encrypted($self->payinfo);
2294 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2295 my $error = $ban->insert;
2296 return ( $error ) if $error;
2300 my @pkgs = $self->ncancelled_pkgs;
2302 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2304 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2305 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2309 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2310 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2313 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2316 sub _banned_pay_hashref {
2327 'payby' => $payby2ban{$self->payby},
2328 'payinfo' => $self->payinfo,
2329 #don't ever *search* on reason! #'reason' =>
2333 sub _new_banned_pay_hashref {
2335 my $hr = $self->_banned_pay_hashref;
2336 $hr->{payinfo} = md5_base64($hr->{payinfo});
2342 Returns all notes (see L<FS::cust_main_note>) for this customer.
2347 my($self,$orderby_classnum) = (shift,shift);
2348 my $orderby = "_DATE DESC";
2349 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2350 qsearch( 'cust_main_note',
2351 { 'custnum' => $self->custnum },
2353 "ORDER BY $orderby",
2359 Returns the agent (see L<FS::agent>) for this customer.
2363 Returns the agent name (see L<FS::agent>) for this customer.
2369 $self->agent->agent;
2374 Returns any tags associated with this customer, as FS::cust_tag objects,
2375 or an empty list if there are no tags.
2379 Returns any tags associated with this customer, as FS::part_tag objects,
2380 or an empty list if there are no tags.
2386 map $_->part_tag, $self->cust_tag;
2392 Returns the customer class, as an FS::cust_class object, or the empty string
2393 if there is no customer class.
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
3068 =item invoicing_list [ ARRAYREF ]
3070 If an arguement is given, sets these email addresses as invoice recipients
3071 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3072 (except as warnings), so use check_invoicing_list first.
3074 Returns a list of email addresses (with svcnum entries expanded).
3076 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3077 check it without disturbing anything by passing nothing.
3079 This interface may change in the future.
3083 sub invoicing_list {
3084 my( $self, $arrayref ) = @_;
3087 my @cust_main_invoice;
3088 if ( $self->custnum ) {
3089 @cust_main_invoice =
3090 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3092 @cust_main_invoice = ();
3094 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3095 #warn $cust_main_invoice->destnum;
3096 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3097 #warn $cust_main_invoice->destnum;
3098 my $error = $cust_main_invoice->delete;
3099 warn $error if $error;
3102 if ( $self->custnum ) {
3103 @cust_main_invoice =
3104 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3106 @cust_main_invoice = ();
3108 my %seen = map { $_->address => 1 } @cust_main_invoice;
3109 foreach my $address ( @{$arrayref} ) {
3110 next if exists $seen{$address} && $seen{$address};
3111 $seen{$address} = 1;
3112 my $cust_main_invoice = new FS::cust_main_invoice ( {
3113 'custnum' => $self->custnum,
3116 my $error = $cust_main_invoice->insert;
3117 warn $error if $error;
3121 if ( $self->custnum ) {
3123 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3130 =item check_invoicing_list ARRAYREF
3132 Checks these arguements as valid input for the invoicing_list method. If there
3133 is an error, returns the error, otherwise returns false.
3137 sub check_invoicing_list {
3138 my( $self, $arrayref ) = @_;
3140 foreach my $address ( @$arrayref ) {
3142 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3143 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3146 my $cust_main_invoice = new FS::cust_main_invoice ( {
3147 'custnum' => $self->custnum,
3150 my $error = $self->custnum
3151 ? $cust_main_invoice->check
3152 : $cust_main_invoice->checkdest
3154 return $error if $error;
3158 return "Email address required"
3159 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3160 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3165 =item set_default_invoicing_list
3167 Sets the invoicing list to all accounts associated with this customer,
3168 overwriting any previous invoicing list.
3172 sub set_default_invoicing_list {
3174 $self->invoicing_list($self->all_emails);
3179 Returns the email addresses of all accounts provisioned for this customer.
3186 foreach my $cust_pkg ( $self->all_pkgs ) {
3187 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3189 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3190 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3192 $list{$_}=1 foreach map { $_->email } @svc_acct;
3197 =item invoicing_list_addpost
3199 Adds postal invoicing to this customer. If this customer is already configured
3200 to receive postal invoices, does nothing.
3204 sub invoicing_list_addpost {
3206 return if grep { $_ eq 'POST' } $self->invoicing_list;
3207 my @invoicing_list = $self->invoicing_list;
3208 push @invoicing_list, 'POST';
3209 $self->invoicing_list(\@invoicing_list);
3212 =item invoicing_list_emailonly
3214 Returns the list of email invoice recipients (invoicing_list without non-email
3215 destinations such as POST and FAX).
3219 sub invoicing_list_emailonly {
3221 warn "$me invoicing_list_emailonly called"
3223 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3226 =item invoicing_list_emailonly_scalar
3228 Returns the list of email invoice recipients (invoicing_list without non-email
3229 destinations such as POST and FAX) as a comma-separated scalar.
3233 sub invoicing_list_emailonly_scalar {
3235 warn "$me invoicing_list_emailonly_scalar called"
3237 join(', ', $self->invoicing_list_emailonly);
3240 =item referral_custnum_cust_main
3242 Returns the customer who referred this customer (or the empty string, if
3243 this customer was not referred).
3245 Note the difference with referral_cust_main method: This method,
3246 referral_custnum_cust_main returns the single customer (if any) who referred
3247 this customer, while referral_cust_main returns an array of customers referred
3252 sub referral_custnum_cust_main {
3254 return '' unless $self->referral_custnum;
3255 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3258 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3260 Returns an array of customers referred by this customer (referral_custnum set
3261 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3262 customers referred by customers referred by this customer and so on, inclusive.
3263 The default behavior is DEPTH 1 (no recursion).
3265 Note the difference with referral_custnum_cust_main method: This method,
3266 referral_cust_main, returns an array of customers referred BY this customer,
3267 while referral_custnum_cust_main returns the single customer (if any) who
3268 referred this customer.
3272 sub referral_cust_main {
3274 my $depth = @_ ? shift : 1;
3275 my $exclude = @_ ? shift : {};
3278 map { $exclude->{$_->custnum}++; $_; }
3279 grep { ! $exclude->{ $_->custnum } }
3280 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3284 map { $_->referral_cust_main($depth-1, $exclude) }
3291 =item referral_cust_main_ncancelled
3293 Same as referral_cust_main, except only returns customers with uncancelled
3298 sub referral_cust_main_ncancelled {
3300 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3303 =item referral_cust_pkg [ DEPTH ]
3305 Like referral_cust_main, except returns a flat list of all unsuspended (and
3306 uncancelled) packages for each customer. The number of items in this list may
3307 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3311 sub referral_cust_pkg {
3313 my $depth = @_ ? shift : 1;
3315 map { $_->unsuspended_pkgs }
3316 grep { $_->unsuspended_pkgs }
3317 $self->referral_cust_main($depth);
3320 =item referring_cust_main
3322 Returns the single cust_main record for the customer who referred this customer
3323 (referral_custnum), or false.
3327 sub referring_cust_main {
3329 return '' unless $self->referral_custnum;
3330 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3333 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3335 Applies a credit to this customer. If there is an error, returns the error,
3336 otherwise returns false.
3338 REASON can be a text string, an FS::reason object, or a scalar reference to
3339 a reasonnum. If a text string, it will be automatically inserted as a new
3340 reason, and a 'reason_type' option must be passed to indicate the
3341 FS::reason_type for the new reason.
3343 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3344 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3345 I<commission_pkgnum>.
3347 Any other options are passed to FS::cust_credit::insert.
3352 my( $self, $amount, $reason, %options ) = @_;
3354 my $cust_credit = new FS::cust_credit {
3355 'custnum' => $self->custnum,
3356 'amount' => $amount,
3359 if ( ref($reason) ) {
3361 if ( ref($reason) eq 'SCALAR' ) {
3362 $cust_credit->reasonnum( $$reason );
3364 $cust_credit->reasonnum( $reason->reasonnum );
3368 $cust_credit->set('reason', $reason)
3371 $cust_credit->$_( delete $options{$_} )
3372 foreach grep exists($options{$_}),
3373 qw( addlinfo eventnum ),
3374 map "commission_$_", qw( agentnum salesnum pkgnum );
3376 $cust_credit->insert(%options);
3380 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3382 Creates a one-time charge for this customer. If there is an error, returns
3383 the error, otherwise returns false.
3385 New-style, with a hashref of options:
3387 my $error = $cust_main->charge(
3391 'start_date' => str2time('7/4/2009'),
3392 'pkg' => 'Description',
3393 'comment' => 'Comment',
3394 'additional' => [], #extra invoice detail
3395 'classnum' => 1, #pkg_class
3397 'setuptax' => '', # or 'Y' for tax exempt
3399 'locationnum'=> 1234, # optional
3402 'taxclass' => 'Tax class',
3405 'taxproduct' => 2, #part_pkg_taxproduct
3406 'override' => {}, #XXX describe
3408 #will be filled in with the new object
3409 'cust_pkg_ref' => \$cust_pkg,
3411 #generate an invoice immediately
3413 'invoice_terms' => '', #with these terms
3419 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3425 my ( $amount, $quantity, $start_date, $classnum );
3426 my ( $pkg, $comment, $additional );
3427 my ( $setuptax, $taxclass ); #internal taxes
3428 my ( $taxproduct, $override ); #vendor (CCH) taxes
3430 my $cust_pkg_ref = '';
3431 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3433 if ( ref( $_[0] ) ) {
3434 $amount = $_[0]->{amount};
3435 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3436 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3437 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3438 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3439 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3440 : '$'. sprintf("%.2f",$amount);
3441 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3442 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3443 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3444 $additional = $_[0]->{additional} || [];
3445 $taxproduct = $_[0]->{taxproductnum};
3446 $override = { '' => $_[0]->{tax_override} };
3447 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3448 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3449 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3450 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3455 $pkg = @_ ? shift : 'One-time charge';
3456 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3458 $taxclass = @_ ? shift : '';
3462 local $SIG{HUP} = 'IGNORE';
3463 local $SIG{INT} = 'IGNORE';
3464 local $SIG{QUIT} = 'IGNORE';
3465 local $SIG{TERM} = 'IGNORE';
3466 local $SIG{TSTP} = 'IGNORE';
3467 local $SIG{PIPE} = 'IGNORE';
3469 my $oldAutoCommit = $FS::UID::AutoCommit;
3470 local $FS::UID::AutoCommit = 0;
3473 my $part_pkg = new FS::part_pkg ( {
3475 'comment' => $comment,
3479 'classnum' => ( $classnum ? $classnum : '' ),
3480 'setuptax' => $setuptax,
3481 'taxclass' => $taxclass,
3482 'taxproductnum' => $taxproduct,
3485 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3486 ( 0 .. @$additional - 1 )
3488 'additional_count' => scalar(@$additional),
3489 'setup_fee' => $amount,
3492 my $error = $part_pkg->insert( options => \%options,
3493 tax_overrides => $override,
3496 $dbh->rollback if $oldAutoCommit;
3500 my $pkgpart = $part_pkg->pkgpart;
3501 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3502 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3503 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3504 $error = $type_pkgs->insert;
3506 $dbh->rollback if $oldAutoCommit;
3511 my $cust_pkg = new FS::cust_pkg ( {
3512 'custnum' => $self->custnum,
3513 'pkgpart' => $pkgpart,
3514 'quantity' => $quantity,
3515 'start_date' => $start_date,
3516 'no_auto' => $no_auto,
3517 'locationnum'=> $locationnum,
3520 $error = $cust_pkg->insert;
3522 $dbh->rollback if $oldAutoCommit;
3524 } elsif ( $cust_pkg_ref ) {
3525 ${$cust_pkg_ref} = $cust_pkg;
3529 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3530 'pkg_list' => [ $cust_pkg ],
3533 $dbh->rollback if $oldAutoCommit;
3538 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3543 #=item charge_postal_fee
3545 #Applies a one time charge this customer. If there is an error,
3546 #returns the error, returns the cust_pkg charge object or false
3547 #if there was no charge.
3551 # This should be a customer event. For that to work requires that bill
3552 # also be a customer event.
3554 sub charge_postal_fee {
3557 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3558 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3560 my $cust_pkg = new FS::cust_pkg ( {
3561 'custnum' => $self->custnum,
3562 'pkgpart' => $pkgpart,
3566 my $error = $cust_pkg->insert;
3567 $error ? $error : $cust_pkg;
3570 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3572 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3574 Optionally, a list or hashref of additional arguments to the qsearch call can
3581 my $opt = ref($_[0]) ? shift : { @_ };
3583 #return $self->num_cust_bill unless wantarray || keys %$opt;
3585 $opt->{'table'} = 'cust_bill';
3586 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3587 $opt->{'hashref'}{'custnum'} = $self->custnum;
3588 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3590 map { $_ } #behavior of sort undefined in scalar context
3591 sort { $a->_date <=> $b->_date }
3595 =item open_cust_bill
3597 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3602 sub open_cust_bill {
3606 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3612 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3614 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3618 sub legacy_cust_bill {
3621 #return $self->num_legacy_cust_bill unless wantarray;
3623 map { $_ } #behavior of sort undefined in scalar context
3624 sort { $a->_date <=> $b->_date }
3625 qsearch({ 'table' => 'legacy_cust_bill',
3626 'hashref' => { 'custnum' => $self->custnum, },
3627 'order_by' => 'ORDER BY _date ASC',
3631 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3633 Returns all the statements (see L<FS::cust_statement>) for this customer.
3635 Optionally, a list or hashref of additional arguments to the qsearch call can
3640 =item cust_bill_void
3642 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3646 sub cust_bill_void {
3649 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3650 sort { $a->_date <=> $b->_date }
3651 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3654 sub cust_statement {
3656 my $opt = ref($_[0]) ? shift : { @_ };
3658 #return $self->num_cust_statement unless wantarray || keys %$opt;
3660 $opt->{'table'} = 'cust_statement';
3661 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3662 $opt->{'hashref'}{'custnum'} = $self->custnum;
3663 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3665 map { $_ } #behavior of sort undefined in scalar context
3666 sort { $a->_date <=> $b->_date }
3670 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3672 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3674 Optionally, a list or hashref of additional arguments to the qsearch call can
3675 be passed following the SVCDB.
3682 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3683 warn "$me svc_x requires a svcdb";
3686 my $opt = ref($_[0]) ? shift : { @_ };
3688 $opt->{'table'} = $svcdb;
3689 $opt->{'addl_from'} =
3690 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3691 ($opt->{'addl_from'} || '');
3693 my $custnum = $self->custnum;
3694 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3695 my $where = "cust_pkg.custnum = $custnum";
3697 my $extra_sql = $opt->{'extra_sql'} || '';
3698 if ( keys %{ $opt->{'hashref'} } ) {
3699 $extra_sql = " AND $where $extra_sql";
3702 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3703 $extra_sql = "WHERE $where AND $1";
3706 $extra_sql = "WHERE $where $extra_sql";
3709 $opt->{'extra_sql'} = $extra_sql;
3714 # required for use as an eventtable;
3717 $self->svc_x('svc_acct', @_);
3722 Returns all the credits (see L<FS::cust_credit>) for this customer.
3728 map { $_ } #return $self->num_cust_credit unless wantarray;
3729 sort { $a->_date <=> $b->_date }
3730 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3733 =item cust_credit_pkgnum
3735 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3736 package when using experimental package balances.
3740 sub cust_credit_pkgnum {
3741 my( $self, $pkgnum ) = @_;
3742 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3743 sort { $a->_date <=> $b->_date }
3744 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3745 'pkgnum' => $pkgnum,
3750 =item cust_credit_void
3752 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3756 sub cust_credit_void {
3759 sort { $a->_date <=> $b->_date }
3760 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3765 Returns all the payments (see L<FS::cust_pay>) for this customer.
3771 return $self->num_cust_pay unless wantarray;
3772 sort { $a->_date <=> $b->_date }
3773 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3778 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3779 called automatically when the cust_pay method is used in a scalar context.
3785 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3786 my $sth = dbh->prepare($sql) or die dbh->errstr;
3787 $sth->execute($self->custnum) or die $sth->errstr;
3788 $sth->fetchrow_arrayref->[0];
3791 =item cust_pay_pkgnum
3793 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3794 package when using experimental package balances.
3798 sub cust_pay_pkgnum {
3799 my( $self, $pkgnum ) = @_;
3800 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3801 sort { $a->_date <=> $b->_date }
3802 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3803 'pkgnum' => $pkgnum,
3810 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3816 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3817 sort { $a->_date <=> $b->_date }
3818 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3821 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3823 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3825 Optionally, a list or hashref of additional arguments to the qsearch call can
3830 sub cust_pay_batch {
3832 my $opt = ref($_[0]) ? shift : { @_ };
3834 #return $self->num_cust_statement unless wantarray || keys %$opt;
3836 $opt->{'table'} = 'cust_pay_batch';
3837 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3838 $opt->{'hashref'}{'custnum'} = $self->custnum;
3839 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3841 map { $_ } #behavior of sort undefined in scalar context
3842 sort { $a->paybatchnum <=> $b->paybatchnum }
3846 =item cust_pay_pending
3848 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3849 (without status "done").
3853 sub cust_pay_pending {
3855 return $self->num_cust_pay_pending unless wantarray;
3856 sort { $a->_date <=> $b->_date }
3857 qsearch( 'cust_pay_pending', {
3858 'custnum' => $self->custnum,
3859 'status' => { op=>'!=', value=>'done' },
3864 =item cust_pay_pending_attempt
3866 Returns all payment attempts / declined payments for this customer, as pending
3867 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3868 a corresponding payment (see L<FS::cust_pay>).
3872 sub cust_pay_pending_attempt {
3874 return $self->num_cust_pay_pending_attempt unless wantarray;
3875 sort { $a->_date <=> $b->_date }
3876 qsearch( 'cust_pay_pending', {
3877 'custnum' => $self->custnum,
3884 =item num_cust_pay_pending
3886 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3887 customer (without status "done"). Also called automatically when the
3888 cust_pay_pending method is used in a scalar context.
3892 sub num_cust_pay_pending {
3895 " SELECT COUNT(*) FROM cust_pay_pending ".
3896 " WHERE custnum = ? AND status != 'done' ",
3901 =item num_cust_pay_pending_attempt
3903 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3904 customer, with status "done" but without a corresp. Also called automatically when the
3905 cust_pay_pending method is used in a scalar context.
3909 sub num_cust_pay_pending_attempt {
3912 " SELECT COUNT(*) FROM cust_pay_pending ".
3913 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3920 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3926 map { $_ } #return $self->num_cust_refund unless wantarray;
3927 sort { $a->_date <=> $b->_date }
3928 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3931 =item display_custnum
3933 Returns the displayed customer number for this customer: agent_custid if
3934 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3938 sub display_custnum {
3941 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3942 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3943 if ( $special eq 'CoStAg' ) {
3944 $prefix = uc( join('',
3946 ($self->state =~ /^(..)/),
3947 $prefix || ($self->agent->agent =~ /^(..)/)
3950 elsif ( $special eq 'CoStCl' ) {
3951 $prefix = uc( join('',
3953 ($self->state =~ /^(..)/),
3954 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3957 # add any others here if needed
3960 my $length = $conf->config('cust_main-custnum-display_length');
3961 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3962 return $self->agent_custid;
3963 } elsif ( $prefix ) {
3964 $length = 8 if !defined($length);
3966 sprintf('%0'.$length.'d', $self->custnum)
3967 } elsif ( $length ) {
3968 return sprintf('%0'.$length.'d', $self->custnum);
3970 return $self->custnum;
3976 Returns a name string for this customer, either "Company (Last, First)" or
3983 my $name = $self->contact;
3984 $name = $self->company. " ($name)" if $self->company;
3988 =item service_contact
3990 Returns the L<FS::contact> object for this customer that has the 'Service'
3991 contact class, or undef if there is no such contact. Deprecated; don't use
3996 sub service_contact {
3998 if ( !exists($self->{service_contact}) ) {
3999 my $classnum = $self->scalar_sql(
4000 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4001 ) || 0; #if it's zero, qsearchs will return nothing
4002 $self->{service_contact} = qsearchs('contact', {
4003 'classnum' => $classnum, 'custnum' => $self->custnum
4006 $self->{service_contact};
4011 Returns a name string for this (service/shipping) contact, either
4012 "Company (Last, First)" or "Last, First".
4019 my $name = $self->ship_contact;
4020 $name = $self->company. " ($name)" if $self->company;
4026 Returns a name string for this customer, either "Company" or "First Last".
4032 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4035 =item ship_name_short
4037 Returns a name string for this (service/shipping) contact, either "Company"
4042 sub ship_name_short {
4044 $self->service_contact
4045 ? $self->ship_contact_firstlast
4051 Returns this customer's full (billing) contact name only, "Last, First"
4057 $self->get('last'). ', '. $self->first;
4062 Returns this customer's full (shipping) contact name only, "Last, First"
4068 my $contact = $self->service_contact || $self;
4069 $contact->get('last') . ', ' . $contact->get('first');
4072 =item contact_firstlast
4074 Returns this customers full (billing) contact name only, "First Last".
4078 sub contact_firstlast {
4080 $self->first. ' '. $self->get('last');
4083 =item ship_contact_firstlast
4085 Returns this customer's full (shipping) contact name only, "First Last".
4089 sub ship_contact_firstlast {
4091 my $contact = $self->service_contact || $self;
4092 $contact->get('first') . ' '. $contact->get('last');
4095 #XXX this doesn't work in 3.x+
4098 #Returns this customer's full country name
4104 # code2country($self->country);
4107 sub bill_country_full {
4109 code2country($self->bill_location->country);
4112 sub ship_country_full {
4114 code2country($self->ship_location->country);
4117 =item county_state_county [ PREFIX ]
4119 Returns a string consisting of just the county, state and country.
4123 sub county_state_country {
4126 if ( @_ && $_[0] && $self->has_ship_address ) {
4127 $locationnum = $self->ship_locationnum;
4129 $locationnum = $self->bill_locationnum;
4131 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4132 $cust_location->county_state_country;
4135 =item geocode DATA_VENDOR
4137 Returns a value for the customer location as encoded by DATA_VENDOR.
4138 Currently this only makes sense for "CCH" as DATA_VENDOR.
4146 Returns a status string for this customer, currently:
4150 =item prospect - No packages have ever been ordered
4152 =item ordered - Recurring packages all are new (not yet billed).
4154 =item active - One or more recurring packages is active
4156 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4158 =item suspended - All non-cancelled recurring packages are suspended
4160 =item cancelled - All recurring packages are cancelled
4164 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4165 cust_main-status_module configuration option.
4169 sub status { shift->cust_status(@_); }
4173 for my $status ( FS::cust_main->statuses() ) {
4174 my $method = $status.'_sql';
4175 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4176 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4177 $sth->execute( ($self->custnum) x $numnum )
4178 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4179 return $status if $sth->fetchrow_arrayref->[0];
4183 =item ucfirst_cust_status
4185 =item ucfirst_status
4187 Returns the status with the first character capitalized.
4191 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4193 sub ucfirst_cust_status {
4195 ucfirst($self->cust_status);
4200 Returns a hex triplet color string for this customer's status.
4204 sub statuscolor { shift->cust_statuscolor(@_); }
4206 sub cust_statuscolor {
4208 __PACKAGE__->statuscolors->{$self->cust_status};
4211 =item tickets [ STATUS ]
4213 Returns an array of hashes representing the customer's RT tickets.
4215 An optional status (or arrayref or hashref of statuses) may be specified.
4221 my $status = ( @_ && $_[0] ) ? shift : '';
4223 my $num = $conf->config('cust_main-max_tickets') || 10;
4226 if ( $conf->config('ticket_system') ) {
4227 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4229 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4238 foreach my $priority (
4239 $conf->config('ticket_system-custom_priority_field-values'), ''
4241 last if scalar(@tickets) >= $num;
4243 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4244 $num - scalar(@tickets),
4255 # Return services representing svc_accts in customer support packages
4256 sub support_services {
4258 my %packages = map { $_ => 1 } $conf->config('support_packages');
4260 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4261 grep { $_->part_svc->svcdb eq 'svc_acct' }
4262 map { $_->cust_svc }
4263 grep { exists $packages{ $_->pkgpart } }
4264 $self->ncancelled_pkgs;
4268 # Return a list of latitude/longitude for one of the services (if any)
4269 sub service_coordinates {
4273 grep { $_->latitude && $_->longitude }
4275 map { $_->cust_svc }
4276 $self->ncancelled_pkgs;
4278 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4283 Returns a masked version of the named field
4288 my ($self,$field) = @_;
4292 'x'x(length($self->getfield($field))-4).
4293 substr($self->getfield($field), (length($self->getfield($field))-4));
4299 =head1 CLASS METHODS
4305 Class method that returns the list of possible status strings for customers
4306 (see L<the status method|/status>). For example:
4308 @statuses = FS::cust_main->statuses();
4314 keys %{ $self->statuscolors };
4317 =item cust_status_sql
4319 Returns an SQL fragment to determine the status of a cust_main record, as a
4324 sub cust_status_sql {
4326 for my $status ( FS::cust_main->statuses() ) {
4327 my $method = $status.'_sql';
4328 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4337 Returns an SQL expression identifying prospective cust_main records (customers
4338 with no packages ever ordered)
4342 use vars qw($select_count_pkgs);
4343 $select_count_pkgs =
4344 "SELECT COUNT(*) FROM cust_pkg
4345 WHERE cust_pkg.custnum = cust_main.custnum";
4347 sub select_count_pkgs_sql {
4352 " 0 = ( $select_count_pkgs ) ";
4357 Returns an SQL expression identifying ordered cust_main records (customers with
4358 no active packages, but recurring packages not yet setup or one time charges
4364 FS::cust_main->none_active_sql.
4365 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4370 Returns an SQL expression identifying active cust_main records (customers with
4371 active recurring packages).
4376 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4379 =item none_active_sql
4381 Returns an SQL expression identifying cust_main records with no active
4382 recurring packages. This includes customers of status prospect, ordered,
4383 inactive, and suspended.
4387 sub none_active_sql {
4388 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4393 Returns an SQL expression identifying inactive cust_main records (customers with
4394 no active recurring packages, but otherwise unsuspended/uncancelled).
4399 FS::cust_main->none_active_sql.
4400 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4406 Returns an SQL expression identifying suspended cust_main records.
4411 sub suspended_sql { susp_sql(@_); }
4413 FS::cust_main->none_active_sql.
4414 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4420 Returns an SQL expression identifying cancelled cust_main records.
4424 sub cancel_sql { shift->cancelled_sql(@_); }
4427 =item uncancelled_sql
4429 Returns an SQL expression identifying un-cancelled cust_main records.
4433 sub uncancelled_sql { uncancel_sql(@_); }
4434 sub uncancel_sql { "
4435 ( 0 < ( $select_count_pkgs
4436 AND ( cust_pkg.cancel IS NULL
4437 OR cust_pkg.cancel = 0
4440 OR 0 = ( $select_count_pkgs )
4446 Returns an SQL fragment to retreive the balance.
4451 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4452 WHERE cust_bill.custnum = cust_main.custnum )
4453 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4454 WHERE cust_pay.custnum = cust_main.custnum )
4455 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4456 WHERE cust_credit.custnum = cust_main.custnum )
4457 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4458 WHERE cust_refund.custnum = cust_main.custnum )
4461 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4463 Returns an SQL fragment to retreive the balance for this customer, optionally
4464 considering invoices with date earlier than START_TIME, and not
4465 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4466 total_unapplied_payments).
4468 Times are specified as SQL fragments or numeric
4469 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4470 L<Date::Parse> for conversion functions. The empty string can be passed
4471 to disable that time constraint completely.
4473 Available options are:
4477 =item unapplied_date
4479 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)
4484 set to true to remove all customer comparison clauses, for totals
4489 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4494 JOIN clause (typically used with the total option)
4498 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4499 time will be ignored. Note that START_TIME and END_TIME only limit the date
4500 range for invoices and I<unapplied> payments, credits, and refunds.
4506 sub balance_date_sql {
4507 my( $class, $start, $end, %opt ) = @_;
4509 my $cutoff = $opt{'cutoff'};
4511 my $owed = FS::cust_bill->owed_sql($cutoff);
4512 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4513 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4514 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4516 my $j = $opt{'join'} || '';
4518 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4519 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4520 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4521 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4523 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4524 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4525 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4526 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4531 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4533 Returns an SQL fragment to retreive the total unapplied payments for this
4534 customer, only considering payments with date earlier than START_TIME, and
4535 optionally not later than END_TIME.
4537 Times are specified as SQL fragments or numeric
4538 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4539 L<Date::Parse> for conversion functions. The empty string can be passed
4540 to disable that time constraint completely.
4542 Available options are:
4546 sub unapplied_payments_date_sql {
4547 my( $class, $start, $end, %opt ) = @_;
4549 my $cutoff = $opt{'cutoff'};
4551 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4553 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4554 'unapplied_date'=>1 );
4556 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4559 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4561 Helper method for balance_date_sql; name (and usage) subject to change
4562 (suggestions welcome).
4564 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4565 cust_refund, cust_credit or cust_pay).
4567 If TABLE is "cust_bill" or the unapplied_date option is true, only
4568 considers records with date earlier than START_TIME, and optionally not
4569 later than END_TIME .
4573 sub _money_table_where {
4574 my( $class, $table, $start, $end, %opt ) = @_;
4577 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4578 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4579 push @where, "$table._date <= $start" if defined($start) && length($start);
4580 push @where, "$table._date > $end" if defined($end) && length($end);
4582 push @where, @{$opt{'where'}} if $opt{'where'};
4583 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4589 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4590 use FS::cust_main::Search;
4593 FS::cust_main::Search->search(@_);
4602 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4604 Deprecated. Use event notification and message templates
4605 (L<FS::msg_template>) instead.
4607 Sends a templated email notification to the customer (see L<Text::Template>).
4609 OPTIONS is a hash and may include
4611 I<from> - the email sender (default is invoice_from)
4613 I<to> - comma-separated scalar or arrayref of recipients
4614 (default is invoicing_list)
4616 I<subject> - The subject line of the sent email notification
4617 (default is "Notice from company_name")
4619 I<extra_fields> - a hashref of name/value pairs which will be substituted
4622 The following variables are vavailable in the template.
4624 I<$first> - the customer first name
4625 I<$last> - the customer last name
4626 I<$company> - the customer company
4627 I<$payby> - a description of the method of payment for the customer
4628 # would be nice to use FS::payby::shortname
4629 I<$payinfo> - the account information used to collect for this customer
4630 I<$expdate> - the expiration of the customer payment in seconds from epoch
4635 my ($self, $template, %options) = @_;
4637 return unless $conf->exists($template);
4639 my $from = $conf->config('invoice_from', $self->agentnum)
4640 if $conf->exists('invoice_from', $self->agentnum);
4641 $from = $options{from} if exists($options{from});
4643 my $to = join(',', $self->invoicing_list_emailonly);
4644 $to = $options{to} if exists($options{to});
4646 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4647 if $conf->exists('company_name', $self->agentnum);
4648 $subject = $options{subject} if exists($options{subject});
4650 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4651 SOURCE => [ map "$_\n",
4652 $conf->config($template)]
4654 or die "can't create new Text::Template object: Text::Template::ERROR";
4655 $notify_template->compile()
4656 or die "can't compile template: Text::Template::ERROR";
4658 $FS::notify_template::_template::company_name =
4659 $conf->config('company_name', $self->agentnum);
4660 $FS::notify_template::_template::company_address =
4661 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4663 my $paydate = $self->paydate || '2037-12-31';
4664 $FS::notify_template::_template::first = $self->first;
4665 $FS::notify_template::_template::last = $self->last;
4666 $FS::notify_template::_template::company = $self->company;
4667 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4668 my $payby = $self->payby;
4669 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4670 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4672 #credit cards expire at the end of the month/year of their exp date
4673 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4674 $FS::notify_template::_template::payby = 'credit card';
4675 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4676 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4678 }elsif ($payby eq 'COMP') {
4679 $FS::notify_template::_template::payby = 'complimentary account';
4681 $FS::notify_template::_template::payby = 'current method';
4683 $FS::notify_template::_template::expdate = $expire_time;
4685 for (keys %{$options{extra_fields}}){
4687 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4690 send_email(from => $from,
4692 subject => $subject,
4693 body => $notify_template->fill_in( PACKAGE =>
4694 'FS::notify_template::_template' ),
4699 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4701 Generates a templated notification to the customer (see L<Text::Template>).
4703 OPTIONS is a hash and may include
4705 I<extra_fields> - a hashref of name/value pairs which will be substituted
4706 into the template. These values may override values mentioned below
4707 and those from the customer record.
4709 The following variables are available in the template instead of or in addition
4710 to the fields of the customer record.
4712 I<$payby> - a description of the method of payment for the customer
4713 # would be nice to use FS::payby::shortname
4714 I<$payinfo> - the masked account information used to collect for this customer
4715 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4716 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4720 # a lot like cust_bill::print_latex
4721 sub generate_letter {
4722 my ($self, $template, %options) = @_;
4724 return unless $conf->exists($template);
4726 my $letter_template = new Text::Template
4728 SOURCE => [ map "$_\n", $conf->config($template)],
4729 DELIMITERS => [ '[@--', '--@]' ],
4731 or die "can't create new Text::Template object: Text::Template::ERROR";
4733 $letter_template->compile()
4734 or die "can't compile template: Text::Template::ERROR";
4736 my %letter_data = map { $_ => $self->$_ } $self->fields;
4737 $letter_data{payinfo} = $self->mask_payinfo;
4739 #my $paydate = $self->paydate || '2037-12-31';
4740 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4742 my $payby = $self->payby;
4743 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4744 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4746 #credit cards expire at the end of the month/year of their exp date
4747 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4748 $letter_data{payby} = 'credit card';
4749 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4750 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4752 }elsif ($payby eq 'COMP') {
4753 $letter_data{payby} = 'complimentary account';
4755 $letter_data{payby} = 'current method';
4757 $letter_data{expdate} = $expire_time;
4759 for (keys %{$options{extra_fields}}){
4760 $letter_data{$_} = $options{extra_fields}->{$_};
4763 unless(exists($letter_data{returnaddress})){
4764 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4765 $self->agent_template)
4767 if ( length($retadd) ) {
4768 $letter_data{returnaddress} = $retadd;
4769 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4770 $letter_data{returnaddress} =
4771 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4775 ( $conf->config('company_name', $self->agentnum),
4776 $conf->config('company_address', $self->agentnum),
4780 $letter_data{returnaddress} = '~';
4784 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4786 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4788 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4790 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4794 ) or die "can't open temp file: $!\n";
4795 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4796 or die "can't write temp file: $!\n";
4798 $letter_data{'logo_file'} = $lh->filename;
4800 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4804 ) or die "can't open temp file: $!\n";
4806 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4808 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4809 return ($1, $letter_data{'logo_file'});
4813 =item print_ps TEMPLATE
4815 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4821 my($file, $lfile) = $self->generate_letter(@_);
4822 my $ps = FS::Misc::generate_ps($file);
4823 unlink($file.'.tex');
4829 =item print TEMPLATE
4831 Prints the filled in template.
4833 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4837 sub queueable_print {
4840 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4841 or die "invalid customer number: " . $opt{custnum};
4843 my $error = $self->print( { 'template' => $opt{template} } );
4844 die $error if $error;
4848 my ($self, $template) = (shift, shift);
4850 [ $self->print_ps($template) ],
4851 'agentnum' => $self->agentnum,
4855 #these three subs should just go away once agent stuff is all config overrides
4857 sub agent_template {
4859 $self->_agent_plandata('agent_templatename');
4862 sub agent_invoice_from {
4864 $self->_agent_plandata('agent_invoice_from');
4867 sub _agent_plandata {
4868 my( $self, $option ) = @_;
4870 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4871 #agent-specific Conf
4873 use FS::part_event::Condition;
4875 my $agentnum = $self->agentnum;
4877 my $regexp = regexp_sql();
4879 my $part_event_option =
4881 'select' => 'part_event_option.*',
4882 'table' => 'part_event_option',
4884 LEFT JOIN part_event USING ( eventpart )
4885 LEFT JOIN part_event_option AS peo_agentnum
4886 ON ( part_event.eventpart = peo_agentnum.eventpart
4887 AND peo_agentnum.optionname = 'agentnum'
4888 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4890 LEFT JOIN part_event_condition
4891 ON ( part_event.eventpart = part_event_condition.eventpart
4892 AND part_event_condition.conditionname = 'cust_bill_age'
4894 LEFT JOIN part_event_condition_option
4895 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4896 AND part_event_condition_option.optionname = 'age'
4899 #'hashref' => { 'optionname' => $option },
4900 #'hashref' => { 'part_event_option.optionname' => $option },
4902 " WHERE part_event_option.optionname = ". dbh->quote($option).
4903 " AND action = 'cust_bill_send_agent' ".
4904 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4905 " AND peo_agentnum.optionname = 'agentnum' ".
4906 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4908 CASE WHEN part_event_condition_option.optionname IS NULL
4910 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4912 , part_event.weight".
4916 unless ( $part_event_option ) {
4917 return $self->agent->invoice_template || ''
4918 if $option eq 'agent_templatename';
4922 $part_event_option->optionvalue;
4926 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4928 Subroutine (not a method), designed to be called from the queue.
4930 Takes a list of options and values.
4932 Pulls up the customer record via the custnum option and calls bill_and_collect.
4937 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4939 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4940 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4942 #without this errors don't get rolled back
4943 $args{'fatal'} = 1; # runs from job queue, will be caught
4945 $cust_main->bill_and_collect( %args );
4948 sub process_bill_and_collect {
4950 my $param = thaw(decode_base64(shift));
4951 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4952 or die "custnum '$param->{custnum}' not found!\n";
4953 $param->{'job'} = $job;
4954 $param->{'fatal'} = 1; # runs from job queue, will be caught
4955 $param->{'retry'} = 1;
4957 $cust_main->bill_and_collect( %$param );
4960 #starting to take quite a while for big dbs
4961 # (JRNL: journaled so it only happens once per database)
4962 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
4963 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
4964 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
4965 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
4966 # JRNL leading/trailing spaces in first, last, company
4967 # JRNL migrate to cust_payby
4968 # - otaker upgrade? journal and call it good? (double check to make sure
4969 # we're not still setting otaker here)
4971 #only going to get worse with new location stuff...
4973 sub _upgrade_data { #class method
4974 my ($class, %opts) = @_;
4977 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
4980 #this seems to be the only expensive one.. why does it take so long?
4981 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
4983 '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';
4984 FS::upgrade_journal->set_done('cust_main__signupdate');
4987 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
4989 # fix yyyy-m-dd formatted paydates
4990 if ( driver_name =~ /^mysql/i ) {
4992 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4993 } else { # the SQL standard
4995 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4997 FS::upgrade_journal->set_done('cust_main__paydate');
5000 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5002 push @statements, #fix the weird BILL with a cc# in payinfo problem
5004 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5006 FS::upgrade_journal->set_done('cust_main__payinfo');
5011 foreach my $sql ( @statements ) {
5012 my $sth = dbh->prepare($sql) or die dbh->errstr;
5013 $sth->execute or die $sth->errstr;
5014 #warn ( (time - $t). " seconds\n" );
5018 local($ignore_expired_card) = 1;
5019 local($ignore_banned_card) = 1;
5020 local($skip_fuzzyfiles) = 1;
5021 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5023 FS::cust_main::Location->_upgrade_data(%opts);
5025 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5027 foreach my $cust_main ( qsearch({
5028 'table' => 'cust_main',
5030 'extra_sql' => 'WHERE '.
5032 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5033 qw( first last company )
5036 my $error = $cust_main->replace;
5037 die $error if $error;
5040 FS::upgrade_journal->set_done('cust_main__trimspaces');
5044 unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5046 #we don't want to decrypt them, just stuff them as-is into cust_payby
5047 local(@encrypted_fields) = ();
5049 local($FS::cust_payby::ignore_expired_card) = 1;
5050 local($FS::cust_payby::ignore_banned_card) = 1;
5052 my @payfields = qw( payby payinfo paycvv paymask
5053 paydate paystart_month paystart_year payissue
5054 payname paystate paytype payip
5057 my $search = new FS::Cursor {
5058 'table' => 'cust_main',
5059 'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5062 while (my $cust_main = $search->fetch) {
5064 my $cust_payby = new FS::cust_payby {
5065 'custnum' => $cust_main->custnum,
5067 map { $_ => $cust_main->$_(); } @payfields
5070 my $error = $cust_payby->insert;
5071 die $error if $error;
5073 $cust_main->setfield($_, '') foreach @payfields;
5074 $error = $cust_main->replace;
5075 die $error if $error;
5079 FS::upgrade_journal->set_done('cust_main__cust_payby');
5082 $class->_upgrade_otaker(%opts);
5092 The delete method should possibly take an FS::cust_main object reference
5093 instead of a scalar customer number.
5095 Bill and collect options should probably be passed as references instead of a
5098 There should probably be a configuration file with a list of allowed credit
5101 No multiple currency support (probably a larger project than just this module).
5103 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5105 Birthdates rely on negative epoch values.
5107 The payby for card/check batches is broken. With mixed batching, bad
5110 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5114 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5115 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5116 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.