5 #FS::cust_main:_Marketgear when they're ready to move to 2.1
6 use base qw( FS::cust_main::Packages FS::cust_main::Status
7 FS::cust_main::Billing FS::cust_main::Billing_Realtime
8 FS::cust_main::Billing_Discount
9 FS::cust_main::Location
10 FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
11 FS::geocode_Mixin FS::Quotable_Mixin
15 use vars qw( $DEBUG $me $conf
18 $ignore_expired_card $ignore_banned_card $ignore_illegal_zip
23 use Scalar::Util qw( blessed );
24 use Time::Local qw(timelocal);
25 use Storable qw(thaw);
29 use Digest::MD5 qw(md5_base64);
32 use File::Temp; #qw( tempfile );
33 use Business::CreditCard 0.28;
35 use FS::UID qw( getotaker dbh driver_name );
36 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
37 use FS::Misc qw( generate_email send_email generate_ps do_print );
38 use FS::Msgcat qw(gettext);
45 use FS::legacy_cust_bill;
47 use FS::cust_pay_pending;
48 use FS::cust_pay_void;
49 use FS::cust_pay_batch;
52 use FS::part_referral;
53 use FS::cust_main_county;
54 use FS::cust_location;
56 use FS::cust_main_exemption;
57 use FS::cust_tax_adjustment;
58 use FS::cust_tax_location;
60 use FS::cust_main_invoice;
62 use FS::prepay_credit;
68 use FS::payment_gateway;
69 use FS::agent_payment_gateway;
71 use FS::cust_main_note;
72 use FS::cust_attachment;
75 use FS::upgrade_journal;
77 # 1 is mostly method/subroutine entry and options
78 # 2 traces progress of some operations
79 # 3 is even more information including possibly sensitive data
81 $me = '[FS::cust_main]';
84 $ignore_expired_card = 0;
85 $ignore_banned_card = 0;
89 @encrypted_fields = ('payinfo', 'paycvv');
90 sub nohistory_fields { ('payinfo', 'paycvv'); }
92 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
94 #ask FS::UID to run this stuff for us later
95 #$FS::UID::callback{'FS::cust_main'} = sub {
96 install_callback FS::UID sub {
98 #yes, need it for stuff below (prolly should be cached)
103 my ( $hashref, $cache ) = @_;
104 if ( exists $hashref->{'pkgnum'} ) {
105 #@{ $self->{'_pkgnum'} } = ();
106 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
107 $self->{'_pkgnum'} = $subcache;
108 #push @{ $self->{'_pkgnum'} },
109 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
115 FS::cust_main - Object methods for cust_main records
121 $record = new FS::cust_main \%hash;
122 $record = new FS::cust_main { 'column' => 'value' };
124 $error = $record->insert;
126 $error = $new_record->replace($old_record);
128 $error = $record->delete;
130 $error = $record->check;
132 @cust_pkg = $record->all_pkgs;
134 @cust_pkg = $record->ncancelled_pkgs;
136 @cust_pkg = $record->suspended_pkgs;
138 $error = $record->bill;
139 $error = $record->bill %options;
140 $error = $record->bill 'time' => $time;
142 $error = $record->collect;
143 $error = $record->collect %options;
144 $error = $record->collect 'invoice_time' => $time,
149 An FS::cust_main object represents a customer. FS::cust_main inherits from
150 FS::Record. The following fields are currently supported:
156 Primary key (assigned automatically for new customers)
160 Agent (see L<FS::agent>)
164 Advertising source (see L<FS::part_referral>)
176 Cocial security number (optional)
200 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
204 Payment Information (See L<FS::payinfo_Mixin> for data format)
208 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
212 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
216 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
220 Start date month (maestro/solo cards only)
224 Start date year (maestro/solo cards only)
228 Issue number (maestro/solo cards only)
232 Name on card or billing name
236 IP address from which payment information was received
240 Tax exempt, empty or `Y'
244 Order taker (see L<FS::access_user>)
250 =item referral_custnum
252 Referring customer number
256 Enable individual CDR spooling, empty or `Y'
260 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
264 Discourage individual CDR printing, empty or `Y'
268 Allow self-service editing of ticket subjects, empty or 'Y'
270 =item calling_list_exempt
272 Do not call, empty or 'Y'
282 Creates a new customer. To add the customer to the database, see L<"insert">.
284 Note that this stores the hash reference, not a distinct copy of the hash it
285 points to. You can ask the object for a copy with the I<hash> method.
289 sub table { 'cust_main'; }
291 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
293 Adds this customer to the database. If there is an error, returns the error,
294 otherwise returns false.
296 Usually the customer's location will not yet exist in the database, and
297 the C<bill_location> and C<ship_location> pseudo-fields must be set to
298 uninserted L<FS::cust_location> objects. These will be inserted and linked
299 (in both directions) to the new customer record. If they're references
300 to the same object, they will become the same location.
302 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
303 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
304 are inserted atomicly, or the transaction is rolled back. Passing an empty
305 hash reference is equivalent to not supplying this parameter. There should be
306 a better explanation of this, but until then, here's an example:
309 tie %hash, 'Tie::RefHash'; #this part is important
311 $cust_pkg => [ $svc_acct ],
314 $cust_main->insert( \%hash );
316 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
317 be set as the invoicing list (see L<"invoicing_list">). Errors return as
318 expected and rollback the entire transaction; it is not necessary to call
319 check_invoicing_list first. The invoicing_list is set after the records in the
320 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
321 invoicing_list destination to the newly-created svc_acct. Here's an example:
323 $cust_main->insert( {}, [ $email, 'POST' ] );
325 Currently available options are: I<depend_jobnum>, I<noexport>,
326 I<tax_exemption> and I<prospectnum>.
328 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
329 on the supplied jobnum (they will not run until the specific job completes).
330 This can be used to defer provisioning until some action completes (such
331 as running the customer's credit card successfully).
333 The I<noexport> option is deprecated. If I<noexport> is set true, no
334 provisioning jobs (exports) are scheduled. (You can schedule them later with
335 the B<reexport> method.)
337 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
338 of tax names and exemption numbers. FS::cust_main_exemption records will be
339 created and inserted.
341 If I<prospectnum> is set, moves contacts and locations from that prospect.
347 my $cust_pkgs = @_ ? shift : {};
348 my $invoicing_list = @_ ? shift : '';
350 warn "$me insert called with options ".
351 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
354 local $SIG{HUP} = 'IGNORE';
355 local $SIG{INT} = 'IGNORE';
356 local $SIG{QUIT} = 'IGNORE';
357 local $SIG{TERM} = 'IGNORE';
358 local $SIG{TSTP} = 'IGNORE';
359 local $SIG{PIPE} = 'IGNORE';
361 my $oldAutoCommit = $FS::UID::AutoCommit;
362 local $FS::UID::AutoCommit = 0;
365 my $prepay_identifier = '';
366 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
368 if ( $self->payby eq 'PREPAY' ) {
370 $self->payby('BILL');
371 $prepay_identifier = $self->payinfo;
374 warn " looking up prepaid card $prepay_identifier\n"
377 my $error = $self->get_prepay( $prepay_identifier,
378 'amount_ref' => \$amount,
379 'seconds_ref' => \$seconds,
380 'upbytes_ref' => \$upbytes,
381 'downbytes_ref' => \$downbytes,
382 'totalbytes_ref' => \$totalbytes,
385 $dbh->rollback if $oldAutoCommit;
386 #return "error applying prepaid card (transaction rolled back): $error";
390 $payby = 'PREP' if $amount;
392 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
395 $self->payby('BILL');
396 $amount = $self->paid;
401 foreach my $l (qw(bill_location ship_location)) {
402 my $loc = delete $self->hashref->{$l};
403 # XXX if we're moving a prospect's locations, do that here
408 if ( !$loc->locationnum ) {
409 # warn the location that we're going to insert it with no custnum
410 $loc->set(custnum_pending => 1);
411 warn " inserting $l\n"
413 my $error = $loc->insert;
415 $dbh->rollback if $oldAutoCommit;
416 my $label = $l eq 'ship_location' ? 'service' : 'billing';
417 return "$error (in $label location)";
420 elsif ( ($loc->custnum || 0) > 0 or $loc->prospectnum ) {
421 # then it somehow belongs to another customer--shouldn't happen
422 $dbh->rollback if $oldAutoCommit;
423 return "$l belongs to customer ".$loc->custnum;
425 # else it already belongs to this customer
426 # (happens when ship_location is identical to bill_location)
428 $self->set($l.'num', $loc->locationnum);
430 if ( $self->get($l.'num') eq '' ) {
431 $dbh->rollback if $oldAutoCommit;
436 warn " inserting $self\n"
439 $self->signupdate(time) unless $self->signupdate;
441 $self->auto_agent_custid()
442 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
444 my $error = $self->SUPER::insert;
446 $dbh->rollback if $oldAutoCommit;
447 #return "inserting cust_main record (transaction rolled back): $error";
451 # now set cust_location.custnum
452 foreach my $l (qw(bill_location ship_location)) {
453 warn " setting $l.custnum\n"
456 $loc->set(custnum => $self->custnum);
457 $error ||= $loc->replace;
460 $dbh->rollback if $oldAutoCommit;
461 return "error setting $l custnum: $error";
465 warn " setting invoicing list\n"
468 if ( $invoicing_list ) {
469 $error = $self->check_invoicing_list( $invoicing_list );
471 $dbh->rollback if $oldAutoCommit;
472 #return "checking invoicing_list (transaction rolled back): $error";
475 $self->invoicing_list( $invoicing_list );
478 warn " setting customer tags\n"
481 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
482 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
483 'custnum' => $self->custnum };
484 my $error = $cust_tag->insert;
486 $dbh->rollback if $oldAutoCommit;
491 my $prospectnum = delete $options{'prospectnum'};
492 if ( $prospectnum ) {
494 warn " moving contacts and locations from prospect $prospectnum\n"
498 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
499 unless ( $prospect_main ) {
500 $dbh->rollback if $oldAutoCommit;
501 return "Unknown prospectnum $prospectnum";
503 $prospect_main->custnum($self->custnum);
504 $prospect_main->disabled('Y');
505 my $error = $prospect_main->replace;
507 $dbh->rollback if $oldAutoCommit;
511 my @contact = $prospect_main->contact;
512 my @cust_location = $prospect_main->cust_location;
513 my @qual = $prospect_main->qual;
515 foreach my $r ( @contact, @cust_location, @qual ) {
517 $r->custnum($self->custnum);
518 my $error = $r->replace;
520 $dbh->rollback if $oldAutoCommit;
527 warn " setting cust_main_exemption\n"
530 my $tax_exemption = delete $options{'tax_exemption'};
531 if ( $tax_exemption ) {
533 $tax_exemption = { map { $_ => '' } @$tax_exemption }
534 if ref($tax_exemption) eq 'ARRAY';
536 foreach my $taxname ( keys %$tax_exemption ) {
537 my $cust_main_exemption = new FS::cust_main_exemption {
538 'custnum' => $self->custnum,
539 'taxname' => $taxname,
540 'exempt_number' => $tax_exemption->{$taxname},
542 my $error = $cust_main_exemption->insert;
544 $dbh->rollback if $oldAutoCommit;
545 return "inserting cust_main_exemption (transaction rolled back): $error";
550 if ( $self->can('start_copy_skel') ) {
551 my $error = $self->start_copy_skel;
553 $dbh->rollback if $oldAutoCommit;
558 warn " ordering packages\n"
561 $error = $self->order_pkgs( $cust_pkgs,
563 'seconds_ref' => \$seconds,
564 'upbytes_ref' => \$upbytes,
565 'downbytes_ref' => \$downbytes,
566 'totalbytes_ref' => \$totalbytes,
569 $dbh->rollback if $oldAutoCommit;
574 $dbh->rollback if $oldAutoCommit;
575 return "No svc_acct record to apply pre-paid time";
577 if ( $upbytes || $downbytes || $totalbytes ) {
578 $dbh->rollback if $oldAutoCommit;
579 return "No svc_acct record to apply pre-paid data";
583 warn " inserting initial $payby payment of $amount\n"
585 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
587 $dbh->rollback if $oldAutoCommit;
588 return "inserting payment (transaction rolled back): $error";
592 unless ( $import || $skip_fuzzyfiles ) {
593 warn " queueing fuzzyfiles update\n"
595 $error = $self->queue_fuzzyfiles_update;
597 $dbh->rollback if $oldAutoCommit;
598 return "updating fuzzy search cache: $error";
602 # FS::geocode_Mixin::after_insert or something?
603 if ( $conf->config('tax_district_method') and !$import ) {
604 # if anything non-empty, try to look it up
605 my $queue = new FS::queue {
606 'job' => 'FS::geocode_Mixin::process_district_update',
607 'custnum' => $self->custnum,
609 my $error = $queue->insert( ref($self), $self->custnum );
611 $dbh->rollback if $oldAutoCommit;
612 return "queueing tax district update: $error";
617 warn " exporting\n" if $DEBUG > 1;
619 my $export_args = $options{'export_args'} || [];
622 map qsearch( 'part_export', {exportnum=>$_} ),
623 $conf->config('cust_main-exports'); #, $agentnum
625 foreach my $part_export ( @part_export ) {
626 my $error = $part_export->export_insert($self, @$export_args);
628 $dbh->rollback if $oldAutoCommit;
629 return "exporting to ". $part_export->exporttype.
630 " (transaction rolled back): $error";
634 #foreach my $depend_jobnum ( @$depend_jobnums ) {
635 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
637 # foreach my $jobnum ( @jobnums ) {
638 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
639 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
641 # my $error = $queue->depend_insert($depend_jobnum);
643 # $dbh->rollback if $oldAutoCommit;
644 # return "error queuing job dependancy: $error";
651 #if ( exists $options{'jobnums'} ) {
652 # push @{ $options{'jobnums'} }, @jobnums;
655 warn " insert complete; committing transaction\n"
658 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
663 use File::CounterFile;
664 sub auto_agent_custid {
667 my $format = $conf->config('cust_main-auto_agent_custid');
669 if ( $format eq '1YMMXXXXXXXX' ) {
671 my $counter = new File::CounterFile 'cust_main.agent_custid';
674 my $ym = 100000000000 + time2str('%y%m00000000', time);
675 if ( $ym > $counter->value ) {
676 $counter->{'value'} = $agent_custid = $ym;
677 $counter->{'updated'} = 1;
679 $agent_custid = $counter->inc;
685 die "Unknown cust_main-auto_agent_custid format: $format";
688 $self->agent_custid($agent_custid);
692 =item PACKAGE METHODS
694 Documentation on customer package methods has been moved to
695 L<FS::cust_main::Packages>.
697 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
699 Recharges this (existing) customer with the specified prepaid card (see
700 L<FS::prepay_credit>), specified either by I<identifier> or as an
701 FS::prepay_credit object. If there is an error, returns the error, otherwise
704 Optionally, five scalar references can be passed as well. They will have their
705 values filled in with the amount, number of seconds, and number of upload,
706 download, and total bytes applied by this prepaid card.
710 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
711 #the only place that uses these args
712 sub recharge_prepay {
713 my( $self, $prepay_credit, $amountref, $secondsref,
714 $upbytesref, $downbytesref, $totalbytesref ) = @_;
716 local $SIG{HUP} = 'IGNORE';
717 local $SIG{INT} = 'IGNORE';
718 local $SIG{QUIT} = 'IGNORE';
719 local $SIG{TERM} = 'IGNORE';
720 local $SIG{TSTP} = 'IGNORE';
721 local $SIG{PIPE} = 'IGNORE';
723 my $oldAutoCommit = $FS::UID::AutoCommit;
724 local $FS::UID::AutoCommit = 0;
727 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
729 my $error = $self->get_prepay( $prepay_credit,
730 'amount_ref' => \$amount,
731 'seconds_ref' => \$seconds,
732 'upbytes_ref' => \$upbytes,
733 'downbytes_ref' => \$downbytes,
734 'totalbytes_ref' => \$totalbytes,
736 || $self->increment_seconds($seconds)
737 || $self->increment_upbytes($upbytes)
738 || $self->increment_downbytes($downbytes)
739 || $self->increment_totalbytes($totalbytes)
740 || $self->insert_cust_pay_prepay( $amount,
742 ? $prepay_credit->identifier
747 $dbh->rollback if $oldAutoCommit;
751 if ( defined($amountref) ) { $$amountref = $amount; }
752 if ( defined($secondsref) ) { $$secondsref = $seconds; }
753 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
754 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
755 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
757 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
762 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
764 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
765 specified either by I<identifier> or as an FS::prepay_credit object.
767 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
768 incremented by the values of the prepaid card.
770 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
771 check or set this customer's I<agentnum>.
773 If there is an error, returns the error, otherwise returns false.
779 my( $self, $prepay_credit, %opt ) = @_;
781 local $SIG{HUP} = 'IGNORE';
782 local $SIG{INT} = 'IGNORE';
783 local $SIG{QUIT} = 'IGNORE';
784 local $SIG{TERM} = 'IGNORE';
785 local $SIG{TSTP} = 'IGNORE';
786 local $SIG{PIPE} = 'IGNORE';
788 my $oldAutoCommit = $FS::UID::AutoCommit;
789 local $FS::UID::AutoCommit = 0;
792 unless ( ref($prepay_credit) ) {
794 my $identifier = $prepay_credit;
796 $prepay_credit = qsearchs(
798 { 'identifier' => $identifier },
803 unless ( $prepay_credit ) {
804 $dbh->rollback if $oldAutoCommit;
805 return "Invalid prepaid card: ". $identifier;
810 if ( $prepay_credit->agentnum ) {
811 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
812 $dbh->rollback if $oldAutoCommit;
813 return "prepaid card not valid for agent ". $self->agentnum;
815 $self->agentnum($prepay_credit->agentnum);
818 my $error = $prepay_credit->delete;
820 $dbh->rollback if $oldAutoCommit;
821 return "removing prepay_credit (transaction rolled back): $error";
824 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
825 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
827 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
832 =item increment_upbytes SECONDS
834 Updates this customer's single or primary account (see L<FS::svc_acct>) by
835 the specified number of upbytes. If there is an error, returns the error,
836 otherwise returns false.
840 sub increment_upbytes {
841 _increment_column( shift, 'upbytes', @_);
844 =item increment_downbytes SECONDS
846 Updates this customer's single or primary account (see L<FS::svc_acct>) by
847 the specified number of downbytes. If there is an error, returns the error,
848 otherwise returns false.
852 sub increment_downbytes {
853 _increment_column( shift, 'downbytes', @_);
856 =item increment_totalbytes SECONDS
858 Updates this customer's single or primary account (see L<FS::svc_acct>) by
859 the specified number of totalbytes. If there is an error, returns the error,
860 otherwise returns false.
864 sub increment_totalbytes {
865 _increment_column( shift, 'totalbytes', @_);
868 =item increment_seconds SECONDS
870 Updates this customer's single or primary account (see L<FS::svc_acct>) by
871 the specified number of seconds. If there is an error, returns the error,
872 otherwise returns false.
876 sub increment_seconds {
877 _increment_column( shift, 'seconds', @_);
880 =item _increment_column AMOUNT
882 Updates this customer's single or primary account (see L<FS::svc_acct>) by
883 the specified number of seconds or bytes. If there is an error, returns
884 the error, otherwise returns false.
888 sub _increment_column {
889 my( $self, $column, $amount ) = @_;
890 warn "$me increment_column called: $column, $amount\n"
893 return '' unless $amount;
895 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
896 $self->ncancelled_pkgs;
899 return 'No packages with primary or single services found'.
900 ' to apply pre-paid time';
901 } elsif ( scalar(@cust_pkg) > 1 ) {
902 #maybe have a way to specify the package/account?
903 return 'Multiple packages found to apply pre-paid time';
906 my $cust_pkg = $cust_pkg[0];
907 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
911 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
914 return 'No account found to apply pre-paid time';
915 } elsif ( scalar(@cust_svc) > 1 ) {
916 return 'Multiple accounts found to apply pre-paid time';
919 my $svc_acct = $cust_svc[0]->svc_x;
920 warn " found service svcnum ". $svc_acct->pkgnum.
921 ' ('. $svc_acct->email. ")\n"
924 $column = "increment_$column";
925 $svc_acct->$column($amount);
929 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
931 Inserts a prepayment in the specified amount for this customer. An optional
932 second argument can specify the prepayment identifier for tracking purposes.
933 If there is an error, returns the error, otherwise returns false.
937 sub insert_cust_pay_prepay {
938 shift->insert_cust_pay('PREP', @_);
941 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
943 Inserts a cash payment in the specified amount for this customer. An optional
944 second argument can specify the payment identifier for tracking purposes.
945 If there is an error, returns the error, otherwise returns false.
949 sub insert_cust_pay_cash {
950 shift->insert_cust_pay('CASH', @_);
953 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
955 Inserts a Western Union payment in the specified amount for this customer. An
956 optional second argument can specify the prepayment identifier for tracking
957 purposes. If there is an error, returns the error, otherwise returns false.
961 sub insert_cust_pay_west {
962 shift->insert_cust_pay('WEST', @_);
965 sub insert_cust_pay {
966 my( $self, $payby, $amount ) = splice(@_, 0, 3);
967 my $payinfo = scalar(@_) ? shift : '';
969 my $cust_pay = new FS::cust_pay {
970 'custnum' => $self->custnum,
971 'paid' => sprintf('%.2f', $amount),
972 #'_date' => #date the prepaid card was purchased???
974 'payinfo' => $payinfo,
982 This method is deprecated. See the I<depend_jobnum> option to the insert and
983 order_pkgs methods for a better way to defer provisioning.
985 Re-schedules all exports by calling the B<reexport> method of all associated
986 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
987 otherwise returns false.
994 carp "WARNING: FS::cust_main::reexport is deprectated; ".
995 "use the depend_jobnum option to insert or order_pkgs to delay export";
997 local $SIG{HUP} = 'IGNORE';
998 local $SIG{INT} = 'IGNORE';
999 local $SIG{QUIT} = 'IGNORE';
1000 local $SIG{TERM} = 'IGNORE';
1001 local $SIG{TSTP} = 'IGNORE';
1002 local $SIG{PIPE} = 'IGNORE';
1004 my $oldAutoCommit = $FS::UID::AutoCommit;
1005 local $FS::UID::AutoCommit = 0;
1008 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1009 my $error = $cust_pkg->reexport;
1011 $dbh->rollback if $oldAutoCommit;
1016 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1021 =item delete [ OPTION => VALUE ... ]
1023 This deletes the customer. If there is an error, returns the error, otherwise
1026 This will completely remove all traces of the customer record. This is not
1027 what you want when a customer cancels service; for that, cancel all of the
1028 customer's packages (see L</cancel>).
1030 If the customer has any uncancelled packages, you need to pass a new (valid)
1031 customer number for those packages to be transferred to, as the "new_customer"
1032 option. Cancelled packages will be deleted. Did I mention that this is NOT
1033 what you want when a customer cancels service and that you really should be
1034 looking at L<FS::cust_pkg/cancel>?
1036 You can't delete a customer with invoices (see L<FS::cust_bill>),
1037 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1038 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1039 set the "delete_financials" option to a true value.
1044 my( $self, %opt ) = @_;
1046 local $SIG{HUP} = 'IGNORE';
1047 local $SIG{INT} = 'IGNORE';
1048 local $SIG{QUIT} = 'IGNORE';
1049 local $SIG{TERM} = 'IGNORE';
1050 local $SIG{TSTP} = 'IGNORE';
1051 local $SIG{PIPE} = 'IGNORE';
1053 my $oldAutoCommit = $FS::UID::AutoCommit;
1054 local $FS::UID::AutoCommit = 0;
1057 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1058 $dbh->rollback if $oldAutoCommit;
1059 return "Can't delete a master agent customer";
1062 #use FS::access_user
1063 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1064 $dbh->rollback if $oldAutoCommit;
1065 return "Can't delete a master employee customer";
1068 tie my %financial_tables, 'Tie::IxHash',
1069 'cust_bill' => 'invoices',
1070 'cust_statement' => 'statements',
1071 'cust_credit' => 'credits',
1072 'cust_pay' => 'payments',
1073 'cust_refund' => 'refunds',
1076 foreach my $table ( keys %financial_tables ) {
1078 my @records = $self->$table();
1080 if ( @records && ! $opt{'delete_financials'} ) {
1081 $dbh->rollback if $oldAutoCommit;
1082 return "Can't delete a customer with ". $financial_tables{$table};
1085 foreach my $record ( @records ) {
1086 my $error = $record->delete;
1088 $dbh->rollback if $oldAutoCommit;
1089 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1095 my @cust_pkg = $self->ncancelled_pkgs;
1097 my $new_custnum = $opt{'new_custnum'};
1098 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1099 $dbh->rollback if $oldAutoCommit;
1100 return "Invalid new customer number: $new_custnum";
1102 foreach my $cust_pkg ( @cust_pkg ) {
1103 my %hash = $cust_pkg->hash;
1104 $hash{'custnum'} = $new_custnum;
1105 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1106 my $error = $new_cust_pkg->replace($cust_pkg,
1107 options => { $cust_pkg->options },
1110 $dbh->rollback if $oldAutoCommit;
1115 my @cancelled_cust_pkg = $self->all_pkgs;
1116 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1117 my $error = $cust_pkg->delete;
1119 $dbh->rollback if $oldAutoCommit;
1124 #cust_tax_adjustment in financials?
1125 #cust_pay_pending? ouch
1127 foreach my $table (qw(
1128 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1129 cust_location cust_main_note cust_tax_adjustment
1130 cust_pay_void cust_pay_batch queue cust_tax_exempt
1132 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1133 my $error = $record->delete;
1135 $dbh->rollback if $oldAutoCommit;
1141 my $sth = $dbh->prepare(
1142 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1144 my $errstr = $dbh->errstr;
1145 $dbh->rollback if $oldAutoCommit;
1148 $sth->execute($self->custnum) or do {
1149 my $errstr = $sth->errstr;
1150 $dbh->rollback if $oldAutoCommit;
1156 my $ticket_dbh = '';
1157 if ($conf->config('ticket_system') eq 'RT_Internal') {
1159 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1160 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1161 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1162 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1165 if ( $ticket_dbh ) {
1167 my $ticket_sth = $ticket_dbh->prepare(
1168 'DELETE FROM Links WHERE Target = ?'
1170 my $errstr = $ticket_dbh->errstr;
1171 $dbh->rollback if $oldAutoCommit;
1174 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1176 my $errstr = $ticket_sth->errstr;
1177 $dbh->rollback if $oldAutoCommit;
1181 #check and see if the customer is the only link on the ticket, and
1182 #if so, set the ticket to deleted status in RT?
1183 #maybe someday, for now this will at least fix tickets not displaying
1187 #delete the customer record
1189 my $error = $self->SUPER::delete;
1191 $dbh->rollback if $oldAutoCommit;
1195 # cust_main exports!
1197 #my $export_args = $options{'export_args'} || [];
1200 map qsearch( 'part_export', {exportnum=>$_} ),
1201 $conf->config('cust_main-exports'); #, $agentnum
1203 foreach my $part_export ( @part_export ) {
1204 my $error = $part_export->export_delete( $self ); #, @$export_args);
1206 $dbh->rollback if $oldAutoCommit;
1207 return "exporting to ". $part_export->exporttype.
1208 " (transaction rolled back): $error";
1212 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1217 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1219 This merges this customer into the provided new custnum, and then deletes the
1220 customer. If there is an error, returns the error, otherwise returns false.
1222 The source customer's name, company name, phone numbers, agent,
1223 referring customer, customer class, advertising source, order taker, and
1224 billing information (except balance) are discarded.
1226 All packages are moved to the target customer. Packages with package locations
1227 are preserved. Packages without package locations are moved to a new package
1228 location with the source customer's service/shipping address.
1230 All invoices, statements, payments, credits and refunds are moved to the target
1231 customer. The source customer's balance is added to the target customer.
1233 All notes, attachments, tickets and customer tags are moved to the target
1236 Change history is not currently moved.
1241 my( $self, $new_custnum, %opt ) = @_;
1243 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1245 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1246 return "Invalid new customer number: $new_custnum";
1249 local $SIG{HUP} = 'IGNORE';
1250 local $SIG{INT} = 'IGNORE';
1251 local $SIG{QUIT} = 'IGNORE';
1252 local $SIG{TERM} = 'IGNORE';
1253 local $SIG{TSTP} = 'IGNORE';
1254 local $SIG{PIPE} = 'IGNORE';
1256 my $oldAutoCommit = $FS::UID::AutoCommit;
1257 local $FS::UID::AutoCommit = 0;
1260 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1261 $dbh->rollback if $oldAutoCommit;
1262 return "Can't merge a master agent customer";
1265 #use FS::access_user
1266 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1267 $dbh->rollback if $oldAutoCommit;
1268 return "Can't merge a master employee customer";
1271 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1272 'status' => { op=>'!=', value=>'done' },
1276 $dbh->rollback if $oldAutoCommit;
1277 return "Can't merge a customer with pending payments";
1280 tie my %financial_tables, 'Tie::IxHash',
1281 'cust_bill' => 'invoices',
1282 'cust_statement' => 'statements',
1283 'cust_credit' => 'credits',
1284 'cust_pay' => 'payments',
1285 'cust_pay_void' => 'voided payments',
1286 'cust_refund' => 'refunds',
1289 foreach my $table ( keys %financial_tables ) {
1291 my @records = $self->$table();
1293 foreach my $record ( @records ) {
1294 $record->custnum($new_custnum);
1295 my $error = $record->replace;
1297 $dbh->rollback if $oldAutoCommit;
1298 return "Error merging ". $financial_tables{$table}. ": $error\n";
1304 my $name = $self->ship_name; #?
1306 my $locationnum = '';
1307 foreach my $cust_pkg ( $self->all_pkgs ) {
1308 $cust_pkg->custnum($new_custnum);
1310 unless ( $cust_pkg->locationnum ) {
1311 unless ( $locationnum ) {
1312 my $cust_location = new FS::cust_location {
1313 $self->location_hash,
1314 'custnum' => $new_custnum,
1316 my $error = $cust_location->insert;
1318 $dbh->rollback if $oldAutoCommit;
1321 $locationnum = $cust_location->locationnum;
1323 $cust_pkg->locationnum($locationnum);
1326 my $error = $cust_pkg->replace;
1328 $dbh->rollback if $oldAutoCommit;
1332 # add customer (ship) name to svc_phone.phone_name if blank
1333 my @cust_svc = $cust_pkg->cust_svc;
1334 foreach my $cust_svc (@cust_svc) {
1335 my($label, $value, $svcdb) = $cust_svc->label;
1336 next unless $svcdb eq 'svc_phone';
1337 my $svc_phone = $cust_svc->svc_x;
1338 next if $svc_phone->phone_name;
1339 $svc_phone->phone_name($name);
1340 my $error = $svc_phone->replace;
1342 $dbh->rollback if $oldAutoCommit;
1350 # cust_tax_exempt (texas tax exemptions)
1351 # cust_recon (some sort of not-well understood thing for OnPac)
1353 #these are moved over
1354 foreach my $table (qw(
1355 cust_tag cust_location contact cust_attachment cust_main_note
1356 cust_tax_adjustment cust_pay_batch queue
1358 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1359 $record->custnum($new_custnum);
1360 my $error = $record->replace;
1362 $dbh->rollback if $oldAutoCommit;
1368 #these aren't preserved
1369 foreach my $table (qw(
1370 cust_main_exemption cust_main_invoice
1372 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1373 my $error = $record->delete;
1375 $dbh->rollback if $oldAutoCommit;
1382 my $sth = $dbh->prepare(
1383 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1385 my $errstr = $dbh->errstr;
1386 $dbh->rollback if $oldAutoCommit;
1389 $sth->execute($new_custnum, $self->custnum) or do {
1390 my $errstr = $sth->errstr;
1391 $dbh->rollback if $oldAutoCommit;
1397 my $ticket_dbh = '';
1398 if ($conf->config('ticket_system') eq 'RT_Internal') {
1400 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1401 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1402 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1403 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1406 if ( $ticket_dbh ) {
1408 my $ticket_sth = $ticket_dbh->prepare(
1409 'UPDATE Links SET Target = ? WHERE Target = ?'
1411 my $errstr = $ticket_dbh->errstr;
1412 $dbh->rollback if $oldAutoCommit;
1415 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1416 'freeside://freeside/cust_main/'.$self->custnum)
1418 my $errstr = $ticket_sth->errstr;
1419 $dbh->rollback if $oldAutoCommit;
1425 #delete the customer record
1427 my $error = $self->delete;
1429 $dbh->rollback if $oldAutoCommit;
1433 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1438 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1440 Replaces the OLD_RECORD with this one in the database. If there is an error,
1441 returns the error, otherwise returns false.
1443 To change the customer's address, set the pseudo-fields C<bill_location> and
1444 C<ship_location>. The address will still only change if at least one of the
1445 address fields differs from the existing values.
1447 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1448 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1449 expected and rollback the entire transaction; it is not necessary to call
1450 check_invoicing_list first. Here's an example:
1452 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1454 Currently available options are: I<tax_exemption>.
1456 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1457 of tax names and exemption numbers. FS::cust_main_exemption records will be
1458 deleted and inserted as appropriate.
1465 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1467 : $self->replace_old;
1471 warn "$me replace called\n"
1474 my $curuser = $FS::CurrentUser::CurrentUser;
1475 if ( $self->payby eq 'COMP'
1476 && $self->payby ne $old->payby
1477 && ! $curuser->access_right('Complimentary customer')
1480 return "You are not permitted to create complimentary accounts.";
1483 # should be unnecessary--geocode will default to null on new locations
1484 #if ( $old->get('geocode') && $old->get('geocode') eq $self->get('geocode')
1485 # && $conf->exists('enable_taxproducts')
1488 # my $pre = ($conf->exists('tax-ship_address') && $self->ship_zip)
1490 # $self->set('geocode', '')
1491 # if $old->get($pre.'zip') ne $self->get($pre.'zip')
1492 # && length($self->get($pre.'zip')) >= 10;
1495 # set_coord/coord_auto stuff is now handled by cust_location
1497 local($ignore_expired_card) = 1
1498 if $old->payby =~ /^(CARD|DCRD)$/
1499 && $self->payby =~ /^(CARD|DCRD)$/
1500 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1502 local($ignore_banned_card) = 1
1503 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1504 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1505 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1507 return "Invoicing locale is required"
1510 && $conf->exists('cust_main-require_locale');
1512 local $SIG{HUP} = 'IGNORE';
1513 local $SIG{INT} = 'IGNORE';
1514 local $SIG{QUIT} = 'IGNORE';
1515 local $SIG{TERM} = 'IGNORE';
1516 local $SIG{TSTP} = 'IGNORE';
1517 local $SIG{PIPE} = 'IGNORE';
1519 my $oldAutoCommit = $FS::UID::AutoCommit;
1520 local $FS::UID::AutoCommit = 0;
1523 for my $l (qw(bill_location ship_location)) {
1524 my $old_loc = $old->$l;
1525 my $new_loc = $self->$l;
1527 if ( !$new_loc->locationnum ) {
1529 # If the new location is all empty fields, or if it's identical to
1530 # the old location in all fields, don't replace.
1531 my @nonempty = grep { $new_loc->$_ } $self->location_fields;
1533 my @unlike = grep { $new_loc->$_ ne $old_loc->$_ } $self->location_fields;
1535 if ( @unlike or $old_loc->disabled ) {
1536 warn " changed $l fields: ".join(',',@unlike)."\n"
1538 $new_loc->set(custnum => $self->custnum);
1540 # insert it--the old location will be disabled later
1541 my $error = $new_loc->insert;
1543 $dbh->rollback if $oldAutoCommit;
1548 # no fields have changed and $old_loc isn't disabled, so don't change it
1553 elsif ( $new_loc->custnum ne $self->custnum or $new_loc->prospectnum ) {
1554 $dbh->rollback if $oldAutoCommit;
1555 return "$l belongs to customer ".$new_loc->custnum;
1557 # else the new location belongs to this customer so we're good
1559 # set the foo_locationnum now that we have one.
1560 $self->set($l.'num', $new_loc->locationnum);
1564 my $error = $self->SUPER::replace($old);
1567 $dbh->rollback if $oldAutoCommit;
1571 # now move packages to the new service location
1572 $self->set('ship_location', ''); #flush cache
1573 if ( $old->ship_locationnum and # should only be null during upgrade...
1574 $old->ship_locationnum != $self->ship_locationnum ) {
1575 $error = $old->ship_location->move_to($self->ship_location);
1577 $dbh->rollback if $oldAutoCommit;
1581 # don't move packages based on the billing location, but
1582 # disable it if it's no longer in use
1583 if ( $old->bill_locationnum and
1584 $old->bill_locationnum != $self->bill_locationnum ) {
1585 $error = $old->bill_location->disable_if_unused;
1587 $dbh->rollback if $oldAutoCommit;
1592 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1593 my $invoicing_list = shift @param;
1594 $error = $self->check_invoicing_list( $invoicing_list );
1596 $dbh->rollback if $oldAutoCommit;
1599 $self->invoicing_list( $invoicing_list );
1602 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1604 #this could be more efficient than deleting and re-inserting, if it matters
1605 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1606 my $error = $cust_tag->delete;
1608 $dbh->rollback if $oldAutoCommit;
1612 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1613 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1614 'custnum' => $self->custnum };
1615 my $error = $cust_tag->insert;
1617 $dbh->rollback if $oldAutoCommit;
1624 my %options = @param;
1626 my $tax_exemption = delete $options{'tax_exemption'};
1627 if ( $tax_exemption ) {
1629 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1630 if ref($tax_exemption) eq 'ARRAY';
1632 my %cust_main_exemption =
1633 map { $_->taxname => $_ }
1634 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1636 foreach my $taxname ( keys %$tax_exemption ) {
1638 if ( $cust_main_exemption{$taxname} &&
1639 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1642 delete $cust_main_exemption{$taxname};
1646 my $cust_main_exemption = new FS::cust_main_exemption {
1647 'custnum' => $self->custnum,
1648 'taxname' => $taxname,
1649 'exempt_number' => $tax_exemption->{$taxname},
1651 my $error = $cust_main_exemption->insert;
1653 $dbh->rollback if $oldAutoCommit;
1654 return "inserting cust_main_exemption (transaction rolled back): $error";
1658 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1659 my $error = $cust_main_exemption->delete;
1661 $dbh->rollback if $oldAutoCommit;
1662 return "deleting cust_main_exemption (transaction rolled back): $error";
1668 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1669 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1670 && $self->get('payinfo') !~ /^99\d{14}$/
1672 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1677 # card/check/lec info has changed, want to retry realtime_ invoice events
1678 my $error = $self->retry_realtime;
1680 $dbh->rollback if $oldAutoCommit;
1685 unless ( $import || $skip_fuzzyfiles ) {
1686 $error = $self->queue_fuzzyfiles_update;
1688 $dbh->rollback if $oldAutoCommit;
1689 return "updating fuzzy search cache: $error";
1693 # tax district update in cust_location
1695 # cust_main exports!
1697 my $export_args = $options{'export_args'} || [];
1700 map qsearch( 'part_export', {exportnum=>$_} ),
1701 $conf->config('cust_main-exports'); #, $agentnum
1703 foreach my $part_export ( @part_export ) {
1704 my $error = $part_export->export_replace( $self, $old, @$export_args);
1706 $dbh->rollback if $oldAutoCommit;
1707 return "exporting to ". $part_export->exporttype.
1708 " (transaction rolled back): $error";
1712 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1717 =item queue_fuzzyfiles_update
1719 Used by insert & replace to update the fuzzy search cache
1723 use FS::cust_main::Search;
1724 sub queue_fuzzyfiles_update {
1727 local $SIG{HUP} = 'IGNORE';
1728 local $SIG{INT} = 'IGNORE';
1729 local $SIG{QUIT} = 'IGNORE';
1730 local $SIG{TERM} = 'IGNORE';
1731 local $SIG{TSTP} = 'IGNORE';
1732 local $SIG{PIPE} = 'IGNORE';
1734 my $oldAutoCommit = $FS::UID::AutoCommit;
1735 local $FS::UID::AutoCommit = 0;
1738 my @locations = $self->bill_location;
1739 push @locations, $self->ship_location if $self->has_ship_address;
1740 foreach my $location (@locations) {
1741 my $queue = new FS::queue {
1742 'job' => 'FS::cust_main::Search::append_fuzzyfiles'
1744 my @args = map $location->get($_), @FS::cust_main::Search::fuzzyfields;
1745 my $error = $queue->insert( @args );
1747 $dbh->rollback if $oldAutoCommit;
1748 return "queueing job (transaction rolled back): $error";
1752 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1759 Checks all fields to make sure this is a valid customer record. If there is
1760 an error, returns the error, otherwise returns false. Called by the insert
1761 and replace methods.
1768 warn "$me check BEFORE: \n". $self->_dump
1772 $self->ut_numbern('custnum')
1773 || $self->ut_number('agentnum')
1774 || $self->ut_textn('agent_custid')
1775 || $self->ut_number('refnum')
1776 || $self->ut_foreign_key('bill_locationnum', 'cust_location','locationnum')
1777 || $self->ut_foreign_key('ship_locationnum', 'cust_location','locationnum')
1778 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1779 || $self->ut_textn('custbatch')
1780 || $self->ut_name('last')
1781 || $self->ut_name('first')
1782 || $self->ut_snumbern('signupdate')
1783 || $self->ut_snumbern('birthdate')
1784 || $self->ut_snumbern('spouse_birthdate')
1785 || $self->ut_snumbern('anniversary_date')
1786 || $self->ut_textn('company')
1787 || $self->ut_anything('comments')
1788 || $self->ut_numbern('referral_custnum')
1789 || $self->ut_textn('stateid')
1790 || $self->ut_textn('stateid_state')
1791 || $self->ut_textn('invoice_terms')
1792 || $self->ut_floatn('cdr_termination_percentage')
1793 || $self->ut_floatn('credit_limit')
1794 || $self->ut_numbern('billday')
1795 || $self->ut_enum('edit_subject', [ '', 'Y' ] )
1796 || $self->ut_enum('calling_list_exempt', [ '', 'Y' ] )
1797 || $self->ut_enum('invoice_noemail', [ '', 'Y' ] )
1798 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1801 #barf. need message catalogs. i18n. etc.
1802 $error .= "Please select an advertising source."
1803 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1804 return $error if $error;
1806 return "Unknown agent"
1807 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1809 return "Unknown refnum"
1810 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1812 return "Unknown referring custnum: ". $self->referral_custnum
1813 unless ! $self->referral_custnum
1814 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1816 if ( $self->ss eq '' ) {
1821 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1822 or return "Illegal social security number: ". $self->ss;
1823 $self->ss("$1-$2-$3");
1826 # cust_main_county verification now handled by cust_location check
1829 $self->ut_phonen('daytime', $self->country)
1830 || $self->ut_phonen('night', $self->country)
1831 || $self->ut_phonen('fax', $self->country)
1832 || $self->ut_phonen('mobile', $self->country)
1834 return $error if $error;
1836 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1838 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1841 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1843 : FS::Msgcat::_gettext('daytime');
1844 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1846 : FS::Msgcat::_gettext('night');
1848 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1850 : FS::Msgcat::_gettext('mobile');
1852 return "$daytime_label, $night_label or $mobile_label is required"
1856 #ship_ fields are gone
1858 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1859 # or return "Illegal payby: ". $self->payby;
1861 FS::payby->can_payby($self->table, $self->payby)
1862 or return "Illegal payby: ". $self->payby;
1864 $error = $self->ut_numbern('paystart_month')
1865 || $self->ut_numbern('paystart_year')
1866 || $self->ut_numbern('payissue')
1867 || $self->ut_textn('paytype')
1869 return $error if $error;
1871 if ( $self->payip eq '' ) {
1874 $error = $self->ut_ip('payip');
1875 return $error if $error;
1878 # If it is encrypted and the private key is not availaible then we can't
1879 # check the credit card.
1880 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1882 # Need some kind of global flag to accept invalid cards, for testing
1884 if ( !$import && $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1886 my $payinfo = $self->payinfo;
1887 $payinfo =~ s/\D//g;
1888 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1889 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1891 $self->payinfo($payinfo);
1893 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1895 return gettext('unknown_card_type')
1896 if $self->payinfo !~ /^99\d{14}$/ #token
1897 && cardtype($self->payinfo) eq "Unknown";
1899 unless ( $ignore_banned_card ) {
1900 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1902 if ( $ban->bantype eq 'warn' ) {
1903 #or others depending on value of $ban->reason ?
1904 return '_duplicate_card'.
1905 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1906 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1907 ' (ban# '. $ban->bannum. ')'
1908 unless $self->override_ban_warn;
1910 return 'Banned credit card: banned on '.
1911 time2str('%a %h %o at %r', $ban->_date).
1912 ' by '. $ban->otaker.
1913 ' (ban# '. $ban->bannum. ')';
1918 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1919 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1920 $self->paycvv =~ /^(\d{4})$/
1921 or return "CVV2 (CID) for American Express cards is four digits.";
1924 $self->paycvv =~ /^(\d{3})$/
1925 or return "CVV2 (CVC2/CID) is three digits.";
1932 my $cardtype = cardtype($payinfo);
1933 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1935 return "Start date or issue number is required for $cardtype cards"
1936 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1938 return "Start month must be between 1 and 12"
1939 if $self->paystart_month
1940 and $self->paystart_month < 1 || $self->paystart_month > 12;
1942 return "Start year must be 1990 or later"
1943 if $self->paystart_year
1944 and $self->paystart_year < 1990;
1946 return "Issue number must be beween 1 and 99"
1948 and $self->payissue < 1 || $self->payissue > 99;
1951 $self->paystart_month('');
1952 $self->paystart_year('');
1953 $self->payissue('');
1956 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1958 my $payinfo = $self->payinfo;
1959 $payinfo =~ s/[^\d\@\.]//g;
1960 if ( $conf->config('echeck-country') eq 'CA' ) {
1961 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1962 or return 'invalid echeck account@branch.bank';
1963 $payinfo = "$1\@$2.$3";
1964 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1965 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1966 $payinfo = "$1\@$2";
1968 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1969 $payinfo = "$1\@$2";
1971 $self->payinfo($payinfo);
1974 unless ( $ignore_banned_card ) {
1975 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1977 if ( $ban->bantype eq 'warn' ) {
1978 #or others depending on value of $ban->reason ?
1979 return '_duplicate_ach' unless $self->override_ban_warn;
1981 return 'Banned ACH account: banned on '.
1982 time2str('%a %h %o at %r', $ban->_date).
1983 ' by '. $ban->otaker.
1984 ' (ban# '. $ban->bannum. ')';
1989 } elsif ( $self->payby eq 'LECB' ) {
1991 my $payinfo = $self->payinfo;
1992 $payinfo =~ s/\D//g;
1993 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1995 $self->payinfo($payinfo);
1998 } elsif ( $self->payby eq 'BILL' ) {
2000 $error = $self->ut_textn('payinfo');
2001 return "Illegal P.O. number: ". $self->payinfo if $error;
2004 } elsif ( $self->payby eq 'COMP' ) {
2006 my $curuser = $FS::CurrentUser::CurrentUser;
2007 if ( ! $self->custnum
2008 && ! $curuser->access_right('Complimentary customer')
2011 return "You are not permitted to create complimentary accounts."
2014 $error = $self->ut_textn('payinfo');
2015 return "Illegal comp account issuer: ". $self->payinfo if $error;
2018 } elsif ( $self->payby eq 'PREPAY' ) {
2020 my $payinfo = $self->payinfo;
2021 $payinfo =~ s/\W//g; #anything else would just confuse things
2022 $self->payinfo($payinfo);
2023 $error = $self->ut_alpha('payinfo');
2024 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2025 return "Unknown prepayment identifier"
2026 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2031 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2032 return "Expiration date required"
2033 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
2037 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2038 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2039 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2040 ( $m, $y ) = ( $2, "19$1" );
2041 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2042 ( $m, $y ) = ( $3, "20$2" );
2044 return "Illegal expiration date: ". $self->paydate;
2046 $m = sprintf('%02d',$m);
2047 $self->paydate("$y-$m-01");
2048 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2049 return gettext('expired_card')
2051 && !$ignore_expired_card
2052 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2055 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2056 ( ! $conf->exists('require_cardname')
2057 || $self->payby !~ /^(CARD|DCRD)$/ )
2059 $self->payname( $self->first. " ". $self->getfield('last') );
2061 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2062 or return gettext('illegal_name'). " payname: ". $self->payname;
2066 return "Please select an invoicing locale"
2069 && $conf->exists('cust_main-require_locale');
2071 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2072 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2076 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2078 warn "$me check AFTER: \n". $self->_dump
2081 $self->SUPER::check;
2086 Returns a list of fields which have ship_ duplicates.
2091 qw( last first company
2092 address1 address2 city county state zip country
2094 daytime night fax mobile
2098 =item has_ship_address
2100 Returns true if this customer record has a separate shipping address.
2104 sub has_ship_address {
2106 $self->bill_locationnum != $self->ship_locationnum;
2111 Returns a list of key/value pairs, with the following keys: address1,
2112 adddress2, city, county, state, zip, country, district, and geocode. The
2113 shipping address is used if present.
2119 $self->ship_location->location_hash;
2124 Returns all locations (see L<FS::cust_location>) for this customer.
2130 qsearch('cust_location', { 'custnum' => $self->custnum,
2131 'prospectnum' => '' } );
2136 Returns all contacts (see L<FS::contact>) for this customer.
2140 #already used :/ sub contact {
2143 qsearch('contact', { 'custnum' => $self->custnum } );
2148 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2149 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2150 on success or a list of errors.
2156 grep { $_->unsuspend } $self->suspended_pkgs;
2161 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2163 Returns a list: an empty list on success or a list of errors.
2169 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2172 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2174 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2175 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2176 of a list of pkgparts; the hashref has the following keys:
2180 =item pkgparts - listref of pkgparts
2182 =item (other options are passed to the suspend method)
2187 Returns a list: an empty list on success or a list of errors.
2191 sub suspend_if_pkgpart {
2193 my (@pkgparts, %opt);
2194 if (ref($_[0]) eq 'HASH'){
2195 @pkgparts = @{$_[0]{pkgparts}};
2200 grep { $_->suspend(%opt) }
2201 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2202 $self->unsuspended_pkgs;
2205 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2207 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2208 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2209 instead of a list of pkgparts; the hashref has the following keys:
2213 =item pkgparts - listref of pkgparts
2215 =item (other options are passed to the suspend method)
2219 Returns a list: an empty list on success or a list of errors.
2223 sub suspend_unless_pkgpart {
2225 my (@pkgparts, %opt);
2226 if (ref($_[0]) eq 'HASH'){
2227 @pkgparts = @{$_[0]{pkgparts}};
2232 grep { $_->suspend(%opt) }
2233 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2234 $self->unsuspended_pkgs;
2237 =item cancel [ OPTION => VALUE ... ]
2239 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2241 Available options are:
2245 =item quiet - can be set true to supress email cancellation notices.
2247 =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.
2249 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2251 =item nobill - can be set true to skip billing if it might otherwise be done.
2255 Always returns a list: an empty list on success or a list of errors.
2259 # nb that dates are not specified as valid options to this method
2262 my( $self, %opt ) = @_;
2264 warn "$me cancel called on customer ". $self->custnum. " with options ".
2265 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2268 return ( 'access denied' )
2269 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2271 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2273 #should try decryption (we might have the private key)
2274 # and if not maybe queue a job for the server that does?
2275 return ( "Can't (yet) ban encrypted credit cards" )
2276 if $self->is_encrypted($self->payinfo);
2278 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2279 my $error = $ban->insert;
2280 return ( $error ) if $error;
2284 my @pkgs = $self->ncancelled_pkgs;
2286 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2288 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2289 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2293 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2294 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2297 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2300 sub _banned_pay_hashref {
2311 'payby' => $payby2ban{$self->payby},
2312 'payinfo' => $self->payinfo,
2313 #don't ever *search* on reason! #'reason' =>
2317 sub _new_banned_pay_hashref {
2319 my $hr = $self->_banned_pay_hashref;
2320 $hr->{payinfo} = md5_base64($hr->{payinfo});
2326 Returns all notes (see L<FS::cust_main_note>) for this customer.
2331 my($self,$orderby_classnum) = (shift,shift);
2332 my $orderby = "_DATE DESC";
2333 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2334 qsearch( 'cust_main_note',
2335 { 'custnum' => $self->custnum },
2337 "ORDER BY $orderby",
2343 Returns the agent (see L<FS::agent>) for this customer.
2349 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2354 Returns the agent name (see L<FS::agent>) for this customer.
2360 $self->agent->agent;
2365 Returns any tags associated with this customer, as FS::cust_tag objects,
2366 or an empty list if there are no tags.
2372 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2377 Returns any tags associated with this customer, as FS::part_tag objects,
2378 or an empty list if there are no tags.
2384 map $_->part_tag, $self->cust_tag;
2390 Returns the customer class, as an FS::cust_class object, or the empty string
2391 if there is no customer class.
2397 if ( $self->classnum ) {
2398 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2406 Returns the customer category name, or the empty string if there is no customer
2413 my $cust_class = $self->cust_class;
2415 ? $cust_class->categoryname
2421 Returns the customer class name, or the empty string if there is no customer
2428 my $cust_class = $self->cust_class;
2430 ? $cust_class->classname
2434 =item BILLING METHODS
2436 Documentation on billing methods has been moved to
2437 L<FS::cust_main::Billing>.
2439 =item REALTIME BILLING METHODS
2441 Documentation on realtime billing methods has been moved to
2442 L<FS::cust_main::Billing_Realtime>.
2446 Removes the I<paycvv> field from the database directly.
2448 If there is an error, returns the error, otherwise returns false.
2454 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2455 or return dbh->errstr;
2456 $sth->execute($self->custnum)
2457 or return $sth->errstr;
2462 =item batch_card OPTION => VALUE...
2464 Adds a payment for this invoice to the pending credit card batch (see
2465 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2466 runs the payment using a realtime gateway.
2471 my ($self, %options) = @_;
2474 if (exists($options{amount})) {
2475 $amount = $options{amount};
2477 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2479 return '' unless $amount > 0;
2481 my $invnum = delete $options{invnum};
2482 my $payby = $options{payby} || $self->payby; #still dubious
2484 if ($options{'realtime'}) {
2485 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2491 my $oldAutoCommit = $FS::UID::AutoCommit;
2492 local $FS::UID::AutoCommit = 0;
2495 #this needs to handle mysql as well as Pg, like svc_acct.pm
2496 #(make it into a common function if folks need to do batching with mysql)
2497 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2498 or return "Cannot lock pay_batch: " . $dbh->errstr;
2502 'payby' => FS::payby->payby2payment($payby),
2504 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2506 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2508 unless ( $pay_batch ) {
2509 $pay_batch = new FS::pay_batch \%pay_batch;
2510 my $error = $pay_batch->insert;
2512 $dbh->rollback if $oldAutoCommit;
2513 die "error creating new batch: $error\n";
2517 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2518 'batchnum' => $pay_batch->batchnum,
2519 'custnum' => $self->custnum,
2522 foreach (qw( address1 address2 city state zip country latitude longitude
2523 payby payinfo paydate payname ))
2525 $options{$_} = '' unless exists($options{$_});
2528 my $loc = $self->bill_location;
2530 my $cust_pay_batch = new FS::cust_pay_batch ( {
2531 'batchnum' => $pay_batch->batchnum,
2532 'invnum' => $invnum || 0, # is there a better value?
2533 # this field should be
2535 # cust_bill_pay_batch now
2536 'custnum' => $self->custnum,
2537 'last' => $self->getfield('last'),
2538 'first' => $self->getfield('first'),
2539 'address1' => $options{address1} || $loc->address1,
2540 'address2' => $options{address2} || $loc->address2,
2541 'city' => $options{city} || $loc->city,
2542 'state' => $options{state} || $loc->state,
2543 'zip' => $options{zip} || $loc->zip,
2544 'country' => $options{country} || $loc->country,
2545 'payby' => $options{payby} || $loc->payby,
2546 'payinfo' => $options{payinfo} || $loc->payinfo,
2547 'exp' => $options{paydate} || $loc->paydate,
2548 'payname' => $options{payname} || $loc->payname,
2549 'amount' => $amount, # consolidating
2552 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2553 if $old_cust_pay_batch;
2556 if ($old_cust_pay_batch) {
2557 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2559 $error = $cust_pay_batch->insert;
2563 $dbh->rollback if $oldAutoCommit;
2567 my $unapplied = $self->total_unapplied_credits
2568 + $self->total_unapplied_payments
2569 + $self->in_transit_payments;
2570 foreach my $cust_bill ($self->open_cust_bill) {
2571 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2572 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2573 'invnum' => $cust_bill->invnum,
2574 'paybatchnum' => $cust_pay_batch->paybatchnum,
2575 'amount' => $cust_bill->owed,
2578 if ($unapplied >= $cust_bill_pay_batch->amount){
2579 $unapplied -= $cust_bill_pay_batch->amount;
2582 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2583 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2585 $error = $cust_bill_pay_batch->insert;
2587 $dbh->rollback if $oldAutoCommit;
2592 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2598 Returns the total owed for this customer on all invoices
2599 (see L<FS::cust_bill/owed>).
2605 $self->total_owed_date(2145859200); #12/31/2037
2608 =item total_owed_date TIME
2610 Returns the total owed for this customer on all invoices with date earlier than
2611 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2612 see L<Time::Local> and L<Date::Parse> for conversion functions.
2616 sub total_owed_date {
2620 my $custnum = $self->custnum;
2622 my $owed_sql = FS::cust_bill->owed_sql;
2625 SELECT SUM($owed_sql) FROM cust_bill
2626 WHERE custnum = $custnum
2630 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2634 =item total_owed_pkgnum PKGNUM
2636 Returns the total owed on all invoices for this customer's specific package
2637 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2641 sub total_owed_pkgnum {
2642 my( $self, $pkgnum ) = @_;
2643 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2646 =item total_owed_date_pkgnum TIME PKGNUM
2648 Returns the total owed for this customer's specific package when using
2649 experimental package balances on all invoices with date earlier than
2650 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2651 see L<Time::Local> and L<Date::Parse> for conversion functions.
2655 sub total_owed_date_pkgnum {
2656 my( $self, $time, $pkgnum ) = @_;
2659 foreach my $cust_bill (
2660 grep { $_->_date <= $time }
2661 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2663 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2665 sprintf( "%.2f", $total_bill );
2671 Returns the total amount of all payments.
2678 $total += $_->paid foreach $self->cust_pay;
2679 sprintf( "%.2f", $total );
2682 =item total_unapplied_credits
2684 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2685 customer. See L<FS::cust_credit/credited>.
2687 =item total_credited
2689 Old name for total_unapplied_credits. Don't use.
2693 sub total_credited {
2694 #carp "total_credited deprecated, use total_unapplied_credits";
2695 shift->total_unapplied_credits(@_);
2698 sub total_unapplied_credits {
2701 my $custnum = $self->custnum;
2703 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2706 SELECT SUM($unapplied_sql) FROM cust_credit
2707 WHERE custnum = $custnum
2710 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2714 =item total_unapplied_credits_pkgnum PKGNUM
2716 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2717 customer. See L<FS::cust_credit/credited>.
2721 sub total_unapplied_credits_pkgnum {
2722 my( $self, $pkgnum ) = @_;
2723 my $total_credit = 0;
2724 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2725 sprintf( "%.2f", $total_credit );
2729 =item total_unapplied_payments
2731 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2732 See L<FS::cust_pay/unapplied>.
2736 sub total_unapplied_payments {
2739 my $custnum = $self->custnum;
2741 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2744 SELECT SUM($unapplied_sql) FROM cust_pay
2745 WHERE custnum = $custnum
2748 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2752 =item total_unapplied_payments_pkgnum PKGNUM
2754 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2755 specific package when using experimental package balances. See
2756 L<FS::cust_pay/unapplied>.
2760 sub total_unapplied_payments_pkgnum {
2761 my( $self, $pkgnum ) = @_;
2762 my $total_unapplied = 0;
2763 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2764 sprintf( "%.2f", $total_unapplied );
2768 =item total_unapplied_refunds
2770 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2771 customer. See L<FS::cust_refund/unapplied>.
2775 sub total_unapplied_refunds {
2777 my $custnum = $self->custnum;
2779 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2782 SELECT SUM($unapplied_sql) FROM cust_refund
2783 WHERE custnum = $custnum
2786 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2792 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2793 total_unapplied_credits minus total_unapplied_payments).
2799 $self->balance_date_range;
2802 =item balance_date TIME
2804 Returns the balance for this customer, only considering invoices with date
2805 earlier than TIME (total_owed_date minus total_credited minus
2806 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2807 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2814 $self->balance_date_range(shift);
2817 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2819 Returns the balance for this customer, optionally considering invoices with
2820 date earlier than START_TIME, and not later than END_TIME
2821 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2823 Times are specified as SQL fragments or numeric
2824 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2825 L<Date::Parse> for conversion functions. The empty string can be passed
2826 to disable that time constraint completely.
2828 Available options are:
2832 =item unapplied_date
2834 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)
2840 sub balance_date_range {
2842 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2843 ') FROM cust_main WHERE custnum='. $self->custnum;
2844 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2847 =item balance_pkgnum PKGNUM
2849 Returns the balance for this customer's specific package when using
2850 experimental package balances (total_owed plus total_unrefunded, minus
2851 total_unapplied_credits minus total_unapplied_payments)
2855 sub balance_pkgnum {
2856 my( $self, $pkgnum ) = @_;
2859 $self->total_owed_pkgnum($pkgnum)
2860 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2861 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2862 - $self->total_unapplied_credits_pkgnum($pkgnum)
2863 - $self->total_unapplied_payments_pkgnum($pkgnum)
2867 =item in_transit_payments
2869 Returns the total of requests for payments for this customer pending in
2870 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2874 sub in_transit_payments {
2876 my $in_transit_payments = 0;
2877 foreach my $pay_batch ( qsearch('pay_batch', {
2880 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2881 'batchnum' => $pay_batch->batchnum,
2882 'custnum' => $self->custnum,
2884 $in_transit_payments += $cust_pay_batch->amount;
2887 sprintf( "%.2f", $in_transit_payments );
2892 Returns a hash of useful information for making a payment.
2902 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2903 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2904 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2908 For credit card transactions:
2920 For electronic check transactions:
2935 $return{balance} = $self->balance;
2937 $return{payname} = $self->payname
2938 || ( $self->first. ' '. $self->get('last') );
2940 $return{$_} = $self->bill_location->$_
2941 for qw(address1 address2 city state zip);
2943 $return{payby} = $self->payby;
2944 $return{stateid_state} = $self->stateid_state;
2946 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2947 $return{card_type} = cardtype($self->payinfo);
2948 $return{payinfo} = $self->paymask;
2950 @return{'month', 'year'} = $self->paydate_monthyear;
2954 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2955 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2956 $return{payinfo1} = $payinfo1;
2957 $return{payinfo2} = $payinfo2;
2958 $return{paytype} = $self->paytype;
2959 $return{paystate} = $self->paystate;
2963 #doubleclick protection
2965 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2971 =item paydate_monthyear
2973 Returns a two-element list consisting of the month and year of this customer's
2974 paydate (credit card expiration date for CARD customers)
2978 sub paydate_monthyear {
2980 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2982 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2991 Returns the exact time in seconds corresponding to the payment method
2992 expiration date. For CARD/DCRD customers this is the end of the month;
2993 for others (COMP is the only other payby that uses paydate) it's the start.
2994 Returns 0 if the paydate is empty or set to the far future.
3000 my ($month, $year) = $self->paydate_monthyear;
3001 return 0 if !$year or $year >= 2037;
3002 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3004 if ( $month == 13 ) {
3008 return timelocal(0,0,0,1,$month-1,$year) - 1;
3011 return timelocal(0,0,0,1,$month-1,$year);
3015 =item paydate_epoch_sql
3017 Class method. Returns an SQL expression to obtain the payment expiration date
3018 as a number of seconds.
3022 # Special expiration date behavior for non-CARD/DCRD customers has been
3023 # carefully preserved. Do we really use that?
3024 sub paydate_epoch_sql {
3026 my $table = shift || 'cust_main';
3027 my ($case1, $case2);
3028 if ( driver_name eq 'Pg' ) {
3029 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3030 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3032 elsif ( lc(driver_name) eq 'mysql' ) {
3033 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3034 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3037 return "CASE WHEN $table.payby IN('CARD','DCRD')
3043 =item tax_exemption TAXNAME
3048 my( $self, $taxname ) = @_;
3050 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3051 'taxname' => $taxname,
3056 =item cust_main_exemption
3060 sub cust_main_exemption {
3062 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3065 =item invoicing_list [ ARRAYREF ]
3067 If an arguement is given, sets these email addresses as invoice recipients
3068 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3069 (except as warnings), so use check_invoicing_list first.
3071 Returns a list of email addresses (with svcnum entries expanded).
3073 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3074 check it without disturbing anything by passing nothing.
3076 This interface may change in the future.
3080 sub invoicing_list {
3081 my( $self, $arrayref ) = @_;
3084 my @cust_main_invoice;
3085 if ( $self->custnum ) {
3086 @cust_main_invoice =
3087 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3089 @cust_main_invoice = ();
3091 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3092 #warn $cust_main_invoice->destnum;
3093 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3094 #warn $cust_main_invoice->destnum;
3095 my $error = $cust_main_invoice->delete;
3096 warn $error if $error;
3099 if ( $self->custnum ) {
3100 @cust_main_invoice =
3101 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3103 @cust_main_invoice = ();
3105 my %seen = map { $_->address => 1 } @cust_main_invoice;
3106 foreach my $address ( @{$arrayref} ) {
3107 next if exists $seen{$address} && $seen{$address};
3108 $seen{$address} = 1;
3109 my $cust_main_invoice = new FS::cust_main_invoice ( {
3110 'custnum' => $self->custnum,
3113 my $error = $cust_main_invoice->insert;
3114 warn $error if $error;
3118 if ( $self->custnum ) {
3120 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3127 =item check_invoicing_list ARRAYREF
3129 Checks these arguements as valid input for the invoicing_list method. If there
3130 is an error, returns the error, otherwise returns false.
3134 sub check_invoicing_list {
3135 my( $self, $arrayref ) = @_;
3137 foreach my $address ( @$arrayref ) {
3139 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3140 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3143 my $cust_main_invoice = new FS::cust_main_invoice ( {
3144 'custnum' => $self->custnum,
3147 my $error = $self->custnum
3148 ? $cust_main_invoice->check
3149 : $cust_main_invoice->checkdest
3151 return $error if $error;
3155 return "Email address required"
3156 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3157 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3162 =item set_default_invoicing_list
3164 Sets the invoicing list to all accounts associated with this customer,
3165 overwriting any previous invoicing list.
3169 sub set_default_invoicing_list {
3171 $self->invoicing_list($self->all_emails);
3176 Returns the email addresses of all accounts provisioned for this customer.
3183 foreach my $cust_pkg ( $self->all_pkgs ) {
3184 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3186 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3187 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3189 $list{$_}=1 foreach map { $_->email } @svc_acct;
3194 =item invoicing_list_addpost
3196 Adds postal invoicing to this customer. If this customer is already configured
3197 to receive postal invoices, does nothing.
3201 sub invoicing_list_addpost {
3203 return if grep { $_ eq 'POST' } $self->invoicing_list;
3204 my @invoicing_list = $self->invoicing_list;
3205 push @invoicing_list, 'POST';
3206 $self->invoicing_list(\@invoicing_list);
3209 =item invoicing_list_emailonly
3211 Returns the list of email invoice recipients (invoicing_list without non-email
3212 destinations such as POST and FAX).
3216 sub invoicing_list_emailonly {
3218 warn "$me invoicing_list_emailonly called"
3220 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3223 =item invoicing_list_emailonly_scalar
3225 Returns the list of email invoice recipients (invoicing_list without non-email
3226 destinations such as POST and FAX) as a comma-separated scalar.
3230 sub invoicing_list_emailonly_scalar {
3232 warn "$me invoicing_list_emailonly_scalar called"
3234 join(', ', $self->invoicing_list_emailonly);
3237 =item referral_custnum_cust_main
3239 Returns the customer who referred this customer (or the empty string, if
3240 this customer was not referred).
3242 Note the difference with referral_cust_main method: This method,
3243 referral_custnum_cust_main returns the single customer (if any) who referred
3244 this customer, while referral_cust_main returns an array of customers referred
3249 sub referral_custnum_cust_main {
3251 return '' unless $self->referral_custnum;
3252 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3255 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3257 Returns an array of customers referred by this customer (referral_custnum set
3258 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3259 customers referred by customers referred by this customer and so on, inclusive.
3260 The default behavior is DEPTH 1 (no recursion).
3262 Note the difference with referral_custnum_cust_main method: This method,
3263 referral_cust_main, returns an array of customers referred BY this customer,
3264 while referral_custnum_cust_main returns the single customer (if any) who
3265 referred this customer.
3269 sub referral_cust_main {
3271 my $depth = @_ ? shift : 1;
3272 my $exclude = @_ ? shift : {};
3275 map { $exclude->{$_->custnum}++; $_; }
3276 grep { ! $exclude->{ $_->custnum } }
3277 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3281 map { $_->referral_cust_main($depth-1, $exclude) }
3288 =item referral_cust_main_ncancelled
3290 Same as referral_cust_main, except only returns customers with uncancelled
3295 sub referral_cust_main_ncancelled {
3297 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3300 =item referral_cust_pkg [ DEPTH ]
3302 Like referral_cust_main, except returns a flat list of all unsuspended (and
3303 uncancelled) packages for each customer. The number of items in this list may
3304 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3308 sub referral_cust_pkg {
3310 my $depth = @_ ? shift : 1;
3312 map { $_->unsuspended_pkgs }
3313 grep { $_->unsuspended_pkgs }
3314 $self->referral_cust_main($depth);
3317 =item referring_cust_main
3319 Returns the single cust_main record for the customer who referred this customer
3320 (referral_custnum), or false.
3324 sub referring_cust_main {
3326 return '' unless $self->referral_custnum;
3327 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3330 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3332 Applies a credit to this customer. If there is an error, returns the error,
3333 otherwise returns false.
3335 REASON can be a text string, an FS::reason object, or a scalar reference to
3336 a reasonnum. If a text string, it will be automatically inserted as a new
3337 reason, and a 'reason_type' option must be passed to indicate the
3338 FS::reason_type for the new reason.
3340 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3342 Any other options are passed to FS::cust_credit::insert.
3347 my( $self, $amount, $reason, %options ) = @_;
3349 my $cust_credit = new FS::cust_credit {
3350 'custnum' => $self->custnum,
3351 'amount' => $amount,
3354 if ( ref($reason) ) {
3356 if ( ref($reason) eq 'SCALAR' ) {
3357 $cust_credit->reasonnum( $$reason );
3359 $cust_credit->reasonnum( $reason->reasonnum );
3363 $cust_credit->set('reason', $reason)
3366 for (qw( addlinfo eventnum )) {
3367 $cust_credit->$_( delete $options{$_} )
3368 if exists($options{$_});
3371 $cust_credit->insert(%options);
3375 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3377 Creates a one-time charge for this customer. If there is an error, returns
3378 the error, otherwise returns false.
3380 New-style, with a hashref of options:
3382 my $error = $cust_main->charge(
3386 'start_date' => str2time('7/4/2009'),
3387 'pkg' => 'Description',
3388 'comment' => 'Comment',
3389 'additional' => [], #extra invoice detail
3390 'classnum' => 1, #pkg_class
3392 'setuptax' => '', # or 'Y' for tax exempt
3395 'taxclass' => 'Tax class',
3398 'taxproduct' => 2, #part_pkg_taxproduct
3399 'override' => {}, #XXX describe
3401 #will be filled in with the new object
3402 'cust_pkg_ref' => \$cust_pkg,
3404 #generate an invoice immediately
3406 'invoice_terms' => '', #with these terms
3412 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3418 my ( $amount, $quantity, $start_date, $classnum );
3419 my ( $pkg, $comment, $additional );
3420 my ( $setuptax, $taxclass ); #internal taxes
3421 my ( $taxproduct, $override ); #vendor (CCH) taxes
3423 my $cust_pkg_ref = '';
3424 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3425 if ( ref( $_[0] ) ) {
3426 $amount = $_[0]->{amount};
3427 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3428 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3429 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3430 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3431 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3432 : '$'. sprintf("%.2f",$amount);
3433 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3434 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3435 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3436 $additional = $_[0]->{additional} || [];
3437 $taxproduct = $_[0]->{taxproductnum};
3438 $override = { '' => $_[0]->{tax_override} };
3439 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3440 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3441 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3446 $pkg = @_ ? shift : 'One-time charge';
3447 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3449 $taxclass = @_ ? shift : '';
3453 local $SIG{HUP} = 'IGNORE';
3454 local $SIG{INT} = 'IGNORE';
3455 local $SIG{QUIT} = 'IGNORE';
3456 local $SIG{TERM} = 'IGNORE';
3457 local $SIG{TSTP} = 'IGNORE';
3458 local $SIG{PIPE} = 'IGNORE';
3460 my $oldAutoCommit = $FS::UID::AutoCommit;
3461 local $FS::UID::AutoCommit = 0;
3464 my $part_pkg = new FS::part_pkg ( {
3466 'comment' => $comment,
3470 'classnum' => ( $classnum ? $classnum : '' ),
3471 'setuptax' => $setuptax,
3472 'taxclass' => $taxclass,
3473 'taxproductnum' => $taxproduct,
3476 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3477 ( 0 .. @$additional - 1 )
3479 'additional_count' => scalar(@$additional),
3480 'setup_fee' => $amount,
3483 my $error = $part_pkg->insert( options => \%options,
3484 tax_overrides => $override,
3487 $dbh->rollback if $oldAutoCommit;
3491 my $pkgpart = $part_pkg->pkgpart;
3492 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3493 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3494 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3495 $error = $type_pkgs->insert;
3497 $dbh->rollback if $oldAutoCommit;
3502 my $cust_pkg = new FS::cust_pkg ( {
3503 'custnum' => $self->custnum,
3504 'pkgpart' => $pkgpart,
3505 'quantity' => $quantity,
3506 'start_date' => $start_date,
3507 'no_auto' => $no_auto,
3510 $error = $cust_pkg->insert;
3512 $dbh->rollback if $oldAutoCommit;
3514 } elsif ( $cust_pkg_ref ) {
3515 ${$cust_pkg_ref} = $cust_pkg;
3519 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3520 'pkg_list' => [ $cust_pkg ],
3523 $dbh->rollback if $oldAutoCommit;
3528 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3533 #=item charge_postal_fee
3535 #Applies a one time charge this customer. If there is an error,
3536 #returns the error, returns the cust_pkg charge object or false
3537 #if there was no charge.
3541 # This should be a customer event. For that to work requires that bill
3542 # also be a customer event.
3544 sub charge_postal_fee {
3547 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3548 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3550 my $cust_pkg = new FS::cust_pkg ( {
3551 'custnum' => $self->custnum,
3552 'pkgpart' => $pkgpart,
3556 my $error = $cust_pkg->insert;
3557 $error ? $error : $cust_pkg;
3560 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3562 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3564 Optionally, a list or hashref of additional arguments to the qsearch call can
3571 my $opt = ref($_[0]) ? shift : { @_ };
3573 #return $self->num_cust_bill unless wantarray || keys %$opt;
3575 $opt->{'table'} = 'cust_bill';
3576 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3577 $opt->{'hashref'}{'custnum'} = $self->custnum;
3578 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3580 map { $_ } #behavior of sort undefined in scalar context
3581 sort { $a->_date <=> $b->_date }
3585 =item open_cust_bill
3587 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3592 sub open_cust_bill {
3596 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3602 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3604 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3608 sub legacy_cust_bill {
3611 #return $self->num_legacy_cust_bill unless wantarray;
3613 map { $_ } #behavior of sort undefined in scalar context
3614 sort { $a->_date <=> $b->_date }
3615 qsearch({ 'table' => 'legacy_cust_bill',
3616 'hashref' => { 'custnum' => $self->custnum, },
3617 'order_by' => 'ORDER BY _date ASC',
3621 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3623 Returns all the statements (see L<FS::cust_statement>) for this customer.
3625 Optionally, a list or hashref of additional arguments to the qsearch call can
3630 sub cust_statement {
3632 my $opt = ref($_[0]) ? shift : { @_ };
3634 #return $self->num_cust_statement unless wantarray || keys %$opt;
3636 $opt->{'table'} = 'cust_statement';
3637 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3638 $opt->{'hashref'}{'custnum'} = $self->custnum;
3639 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3641 map { $_ } #behavior of sort undefined in scalar context
3642 sort { $a->_date <=> $b->_date }
3646 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3648 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3650 Optionally, a list or hashref of additional arguments to the qsearch call can
3651 be passed following the SVCDB.
3658 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3659 warn "$me svc_x requires a svcdb";
3662 my $opt = ref($_[0]) ? shift : { @_ };
3664 $opt->{'table'} = $svcdb;
3665 $opt->{'addl_from'} =
3666 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3667 ($opt->{'addl_from'} || '');
3669 my $custnum = $self->custnum;
3670 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3671 my $where = "cust_pkg.custnum = $custnum";
3673 my $extra_sql = $opt->{'extra_sql'} || '';
3674 if ( keys %{ $opt->{'hashref'} } ) {
3675 $extra_sql = " AND $where $extra_sql";
3678 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3679 $extra_sql = "WHERE $where AND $1";
3682 $extra_sql = "WHERE $where $extra_sql";
3685 $opt->{'extra_sql'} = $extra_sql;
3690 # required for use as an eventtable;
3693 $self->svc_x('svc_acct', @_);
3698 Returns all the credits (see L<FS::cust_credit>) for this customer.
3704 map { $_ } #return $self->num_cust_credit unless wantarray;
3705 sort { $a->_date <=> $b->_date }
3706 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3709 =item cust_credit_pkgnum
3711 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3712 package when using experimental package balances.
3716 sub cust_credit_pkgnum {
3717 my( $self, $pkgnum ) = @_;
3718 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3719 sort { $a->_date <=> $b->_date }
3720 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3721 'pkgnum' => $pkgnum,
3728 Returns all the payments (see L<FS::cust_pay>) for this customer.
3734 return $self->num_cust_pay unless wantarray;
3735 sort { $a->_date <=> $b->_date }
3736 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3741 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3742 called automatically when the cust_pay method is used in a scalar context.
3748 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3749 my $sth = dbh->prepare($sql) or die dbh->errstr;
3750 $sth->execute($self->custnum) or die $sth->errstr;
3751 $sth->fetchrow_arrayref->[0];
3754 =item cust_pay_pkgnum
3756 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3757 package when using experimental package balances.
3761 sub cust_pay_pkgnum {
3762 my( $self, $pkgnum ) = @_;
3763 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3764 sort { $a->_date <=> $b->_date }
3765 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3766 'pkgnum' => $pkgnum,
3773 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3779 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3780 sort { $a->_date <=> $b->_date }
3781 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3784 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3786 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
3788 Optionally, a list or hashref of additional arguments to the qsearch call can
3793 sub cust_pay_batch {
3795 my $opt = ref($_[0]) ? shift : { @_ };
3797 #return $self->num_cust_statement unless wantarray || keys %$opt;
3799 $opt->{'table'} = 'cust_pay_batch';
3800 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3801 $opt->{'hashref'}{'custnum'} = $self->custnum;
3802 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3804 map { $_ } #behavior of sort undefined in scalar context
3805 sort { $a->paybatchnum <=> $b->paybatchnum }
3809 =item cust_pay_pending
3811 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3812 (without status "done").
3816 sub cust_pay_pending {
3818 return $self->num_cust_pay_pending unless wantarray;
3819 sort { $a->_date <=> $b->_date }
3820 qsearch( 'cust_pay_pending', {
3821 'custnum' => $self->custnum,
3822 'status' => { op=>'!=', value=>'done' },
3827 =item cust_pay_pending_attempt
3829 Returns all payment attempts / declined payments for this customer, as pending
3830 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3831 a corresponding payment (see L<FS::cust_pay>).
3835 sub cust_pay_pending_attempt {
3837 return $self->num_cust_pay_pending_attempt unless wantarray;
3838 sort { $a->_date <=> $b->_date }
3839 qsearch( 'cust_pay_pending', {
3840 'custnum' => $self->custnum,
3847 =item num_cust_pay_pending
3849 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3850 customer (without status "done"). Also called automatically when the
3851 cust_pay_pending method is used in a scalar context.
3855 sub num_cust_pay_pending {
3858 " SELECT COUNT(*) FROM cust_pay_pending ".
3859 " WHERE custnum = ? AND status != 'done' ",
3864 =item num_cust_pay_pending_attempt
3866 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3867 customer, with status "done" but without a corresp. Also called automatically when the
3868 cust_pay_pending method is used in a scalar context.
3872 sub num_cust_pay_pending_attempt {
3875 " SELECT COUNT(*) FROM cust_pay_pending ".
3876 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3883 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3889 map { $_ } #return $self->num_cust_refund unless wantarray;
3890 sort { $a->_date <=> $b->_date }
3891 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3894 =item display_custnum
3896 Returns the displayed customer number for this customer: agent_custid if
3897 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3901 sub display_custnum {
3904 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3905 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3906 if ( $special eq 'CoStAg' ) {
3907 $prefix = uc( join('',
3909 ($self->state =~ /^(..)/),
3910 $prefix || ($self->agent->agent =~ /^(..)/)
3913 elsif ( $special eq 'CoStCl' ) {
3914 $prefix = uc( join('',
3916 ($self->state =~ /^(..)/),
3917 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3920 # add any others here if needed
3923 my $length = $conf->config('cust_main-custnum-display_length');
3924 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3925 return $self->agent_custid;
3926 } elsif ( $prefix ) {
3927 $length = 8 if !defined($length);
3929 sprintf('%0'.$length.'d', $self->custnum)
3930 } elsif ( $length ) {
3931 return sprintf('%0'.$length.'d', $self->custnum);
3933 return $self->custnum;
3939 Returns a name string for this customer, either "Company (Last, First)" or
3946 my $name = $self->contact;
3947 $name = $self->company. " ($name)" if $self->company;
3951 =item service_contact
3953 Returns the L<FS::contact> object for this customer that has the 'Service'
3954 contact class, or undef if there is no such contact. Deprecated; don't use
3959 sub service_contact {
3961 if ( !exists($self->{service_contact}) ) {
3962 my $classnum = $self->scalar_sql(
3963 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3964 ) || 0; #if it's zero, qsearchs will return nothing
3965 $self->{service_contact} = qsearchs('contact', {
3966 'classnum' => $classnum, 'custnum' => $self->custnum
3969 $self->{service_contact};
3974 Returns a name string for this (service/shipping) contact, either
3975 "Company (Last, First)" or "Last, First".
3982 my $name = $self->ship_contact;
3983 $name = $self->company. " ($name)" if $self->company;
3989 Returns a name string for this customer, either "Company" or "First Last".
3995 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3998 =item ship_name_short
4000 Returns a name string for this (service/shipping) contact, either "Company"
4005 sub ship_name_short {
4007 $self->service_contact
4008 ? $self->ship_contact_firstlast
4014 Returns this customer's full (billing) contact name only, "Last, First"
4020 $self->get('last'). ', '. $self->first;
4025 Returns this customer's full (shipping) contact name only, "Last, First"
4031 my $contact = $self->service_contact || $self;
4032 $contact->get('last') . ', ' . $contact->get('first');
4035 =item contact_firstlast
4037 Returns this customers full (billing) contact name only, "First Last".
4041 sub contact_firstlast {
4043 $self->first. ' '. $self->get('last');
4046 =item ship_contact_firstlast
4048 Returns this customer's full (shipping) contact name only, "First Last".
4052 sub ship_contact_firstlast {
4054 my $contact = $self->service_contact || $self;
4055 $contact->get('first') . ' '. $contact->get('last');
4060 Returns this customer's full country name
4066 code2country($self->country);
4069 =item geocode DATA_VENDOR
4071 Returns a value for the customer location as encoded by DATA_VENDOR.
4072 Currently this only makes sense for "CCH" as DATA_VENDOR.
4080 Returns a status string for this customer, currently:
4084 =item prospect - No packages have ever been ordered
4086 =item ordered - Recurring packages all are new (not yet billed).
4088 =item active - One or more recurring packages is active
4090 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4092 =item suspended - All non-cancelled recurring packages are suspended
4094 =item cancelled - All recurring packages are cancelled
4098 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4099 cust_main-status_module configuration option.
4103 sub status { shift->cust_status(@_); }
4107 for my $status ( FS::cust_main->statuses() ) {
4108 my $method = $status.'_sql';
4109 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4110 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4111 $sth->execute( ($self->custnum) x $numnum )
4112 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4113 return $status if $sth->fetchrow_arrayref->[0];
4117 =item ucfirst_cust_status
4119 =item ucfirst_status
4121 Returns the status with the first character capitalized.
4125 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4127 sub ucfirst_cust_status {
4129 ucfirst($self->cust_status);
4134 Returns a hex triplet color string for this customer's status.
4138 sub statuscolor { shift->cust_statuscolor(@_); }
4140 sub cust_statuscolor {
4142 __PACKAGE__->statuscolors->{$self->cust_status};
4147 Returns an array of hashes representing the customer's RT tickets.
4154 my $num = $conf->config('cust_main-max_tickets') || 10;
4157 if ( $conf->config('ticket_system') ) {
4158 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4160 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4164 foreach my $priority (
4165 $conf->config('ticket_system-custom_priority_field-values'), ''
4167 last if scalar(@tickets) >= $num;
4169 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4170 $num - scalar(@tickets),
4180 # Return services representing svc_accts in customer support packages
4181 sub support_services {
4183 my %packages = map { $_ => 1 } $conf->config('support_packages');
4185 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4186 grep { $_->part_svc->svcdb eq 'svc_acct' }
4187 map { $_->cust_svc }
4188 grep { exists $packages{ $_->pkgpart } }
4189 $self->ncancelled_pkgs;
4193 # Return a list of latitude/longitude for one of the services (if any)
4194 sub service_coordinates {
4198 grep { $_->latitude && $_->longitude }
4200 map { $_->cust_svc }
4201 $self->ncancelled_pkgs;
4203 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4208 Returns a masked version of the named field
4213 my ($self,$field) = @_;
4217 'x'x(length($self->getfield($field))-4).
4218 substr($self->getfield($field), (length($self->getfield($field))-4));
4224 =head1 CLASS METHODS
4230 Class method that returns the list of possible status strings for customers
4231 (see L<the status method|/status>). For example:
4233 @statuses = FS::cust_main->statuses();
4239 keys %{ $self->statuscolors };
4242 =item cust_status_sql
4244 Returns an SQL fragment to determine the status of a cust_main record, as a
4249 sub cust_status_sql {
4251 for my $status ( FS::cust_main->statuses() ) {
4252 my $method = $status.'_sql';
4253 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4262 Returns an SQL expression identifying prospective cust_main records (customers
4263 with no packages ever ordered)
4267 use vars qw($select_count_pkgs);
4268 $select_count_pkgs =
4269 "SELECT COUNT(*) FROM cust_pkg
4270 WHERE cust_pkg.custnum = cust_main.custnum";
4272 sub select_count_pkgs_sql {
4277 " 0 = ( $select_count_pkgs ) ";
4282 Returns an SQL expression identifying ordered cust_main records (customers with
4283 no active packages, but recurring packages not yet setup or one time charges
4289 FS::cust_main->none_active_sql.
4290 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4295 Returns an SQL expression identifying active cust_main records (customers with
4296 active recurring packages).
4301 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4304 =item none_active_sql
4306 Returns an SQL expression identifying cust_main records with no active
4307 recurring packages. This includes customers of status prospect, ordered,
4308 inactive, and suspended.
4312 sub none_active_sql {
4313 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4318 Returns an SQL expression identifying inactive cust_main records (customers with
4319 no active recurring packages, but otherwise unsuspended/uncancelled).
4324 FS::cust_main->none_active_sql.
4325 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4331 Returns an SQL expression identifying suspended cust_main records.
4336 sub suspended_sql { susp_sql(@_); }
4338 FS::cust_main->none_active_sql.
4339 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4345 Returns an SQL expression identifying cancelled cust_main records.
4349 sub cancel_sql { shift->cancelled_sql(@_); }
4352 =item uncancelled_sql
4354 Returns an SQL expression identifying un-cancelled cust_main records.
4358 sub uncancelled_sql { uncancel_sql(@_); }
4359 sub uncancel_sql { "
4360 ( 0 < ( $select_count_pkgs
4361 AND ( cust_pkg.cancel IS NULL
4362 OR cust_pkg.cancel = 0
4365 OR 0 = ( $select_count_pkgs )
4371 Returns an SQL fragment to retreive the balance.
4376 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4377 WHERE cust_bill.custnum = cust_main.custnum )
4378 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4379 WHERE cust_pay.custnum = cust_main.custnum )
4380 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4381 WHERE cust_credit.custnum = cust_main.custnum )
4382 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4383 WHERE cust_refund.custnum = cust_main.custnum )
4386 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4388 Returns an SQL fragment to retreive the balance for this customer, optionally
4389 considering invoices with date earlier than START_TIME, and not
4390 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4391 total_unapplied_payments).
4393 Times are specified as SQL fragments or numeric
4394 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4395 L<Date::Parse> for conversion functions. The empty string can be passed
4396 to disable that time constraint completely.
4398 Available options are:
4402 =item unapplied_date
4404 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)
4409 set to true to remove all customer comparison clauses, for totals
4414 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4419 JOIN clause (typically used with the total option)
4423 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4424 time will be ignored. Note that START_TIME and END_TIME only limit the date
4425 range for invoices and I<unapplied> payments, credits, and refunds.
4431 sub balance_date_sql {
4432 my( $class, $start, $end, %opt ) = @_;
4434 my $cutoff = $opt{'cutoff'};
4436 my $owed = FS::cust_bill->owed_sql($cutoff);
4437 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4438 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4439 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4441 my $j = $opt{'join'} || '';
4443 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4444 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4445 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4446 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4448 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4449 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4450 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4451 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4456 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4458 Returns an SQL fragment to retreive the total unapplied payments for this
4459 customer, only considering payments with date earlier than START_TIME, and
4460 optionally not later than END_TIME.
4462 Times are specified as SQL fragments or numeric
4463 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4464 L<Date::Parse> for conversion functions. The empty string can be passed
4465 to disable that time constraint completely.
4467 Available options are:
4471 sub unapplied_payments_date_sql {
4472 my( $class, $start, $end, %opt ) = @_;
4474 my $cutoff = $opt{'cutoff'};
4476 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4478 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4479 'unapplied_date'=>1 );
4481 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4484 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4486 Helper method for balance_date_sql; name (and usage) subject to change
4487 (suggestions welcome).
4489 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4490 cust_refund, cust_credit or cust_pay).
4492 If TABLE is "cust_bill" or the unapplied_date option is true, only
4493 considers records with date earlier than START_TIME, and optionally not
4494 later than END_TIME .
4498 sub _money_table_where {
4499 my( $class, $table, $start, $end, %opt ) = @_;
4502 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4503 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4504 push @where, "$table._date <= $start" if defined($start) && length($start);
4505 push @where, "$table._date > $end" if defined($end) && length($end);
4507 push @where, @{$opt{'where'}} if $opt{'where'};
4508 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4514 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4515 use FS::cust_main::Search;
4518 FS::cust_main::Search->search(@_);
4533 #warn join('-',keys %$param);
4534 my $fh = $param->{filehandle};
4535 my $agentnum = $param->{agentnum};
4536 my $format = $param->{format};
4538 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4541 if ( $format eq 'simple' ) {
4542 @fields = qw( custnum agent_custid amount pkg );
4544 die "unknown format $format";
4547 eval "use Text::CSV_XS;";
4550 my $csv = new Text::CSV_XS;
4557 local $SIG{HUP} = 'IGNORE';
4558 local $SIG{INT} = 'IGNORE';
4559 local $SIG{QUIT} = 'IGNORE';
4560 local $SIG{TERM} = 'IGNORE';
4561 local $SIG{TSTP} = 'IGNORE';
4562 local $SIG{PIPE} = 'IGNORE';
4564 my $oldAutoCommit = $FS::UID::AutoCommit;
4565 local $FS::UID::AutoCommit = 0;
4568 #while ( $columns = $csv->getline($fh) ) {
4570 while ( defined($line=<$fh>) ) {
4572 $csv->parse($line) or do {
4573 $dbh->rollback if $oldAutoCommit;
4574 return "can't parse: ". $csv->error_input();
4577 my @columns = $csv->fields();
4578 #warn join('-',@columns);
4581 foreach my $field ( @fields ) {
4582 $row{$field} = shift @columns;
4585 if ( $row{custnum} && $row{agent_custid} ) {
4586 dbh->rollback if $oldAutoCommit;
4587 return "can't specify custnum with agent_custid $row{agent_custid}";
4591 if ( $row{agent_custid} && $agentnum ) {
4592 %hash = ( 'agent_custid' => $row{agent_custid},
4593 'agentnum' => $agentnum,
4597 if ( $row{custnum} ) {
4598 %hash = ( 'custnum' => $row{custnum} );
4601 unless ( scalar(keys %hash) ) {
4602 $dbh->rollback if $oldAutoCommit;
4603 return "can't find customer without custnum or agent_custid and agentnum";
4606 my $cust_main = qsearchs('cust_main', { %hash } );
4607 unless ( $cust_main ) {
4608 $dbh->rollback if $oldAutoCommit;
4609 my $custnum = $row{custnum} || $row{agent_custid};
4610 return "unknown custnum $custnum";
4613 if ( $row{'amount'} > 0 ) {
4614 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4616 $dbh->rollback if $oldAutoCommit;
4620 } elsif ( $row{'amount'} < 0 ) {
4621 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4624 $dbh->rollback if $oldAutoCommit;
4634 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4636 return "Empty file!" unless $imported;
4642 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4644 Deprecated. Use event notification and message templates
4645 (L<FS::msg_template>) instead.
4647 Sends a templated email notification to the customer (see L<Text::Template>).
4649 OPTIONS is a hash and may include
4651 I<from> - the email sender (default is invoice_from)
4653 I<to> - comma-separated scalar or arrayref of recipients
4654 (default is invoicing_list)
4656 I<subject> - The subject line of the sent email notification
4657 (default is "Notice from company_name")
4659 I<extra_fields> - a hashref of name/value pairs which will be substituted
4662 The following variables are vavailable in the template.
4664 I<$first> - the customer first name
4665 I<$last> - the customer last name
4666 I<$company> - the customer company
4667 I<$payby> - a description of the method of payment for the customer
4668 # would be nice to use FS::payby::shortname
4669 I<$payinfo> - the account information used to collect for this customer
4670 I<$expdate> - the expiration of the customer payment in seconds from epoch
4675 my ($self, $template, %options) = @_;
4677 return unless $conf->exists($template);
4679 my $from = $conf->config('invoice_from', $self->agentnum)
4680 if $conf->exists('invoice_from', $self->agentnum);
4681 $from = $options{from} if exists($options{from});
4683 my $to = join(',', $self->invoicing_list_emailonly);
4684 $to = $options{to} if exists($options{to});
4686 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4687 if $conf->exists('company_name', $self->agentnum);
4688 $subject = $options{subject} if exists($options{subject});
4690 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4691 SOURCE => [ map "$_\n",
4692 $conf->config($template)]
4694 or die "can't create new Text::Template object: Text::Template::ERROR";
4695 $notify_template->compile()
4696 or die "can't compile template: Text::Template::ERROR";
4698 $FS::notify_template::_template::company_name =
4699 $conf->config('company_name', $self->agentnum);
4700 $FS::notify_template::_template::company_address =
4701 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4703 my $paydate = $self->paydate || '2037-12-31';
4704 $FS::notify_template::_template::first = $self->first;
4705 $FS::notify_template::_template::last = $self->last;
4706 $FS::notify_template::_template::company = $self->company;
4707 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4708 my $payby = $self->payby;
4709 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4710 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4712 #credit cards expire at the end of the month/year of their exp date
4713 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4714 $FS::notify_template::_template::payby = 'credit card';
4715 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4716 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4718 }elsif ($payby eq 'COMP') {
4719 $FS::notify_template::_template::payby = 'complimentary account';
4721 $FS::notify_template::_template::payby = 'current method';
4723 $FS::notify_template::_template::expdate = $expire_time;
4725 for (keys %{$options{extra_fields}}){
4727 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4730 send_email(from => $from,
4732 subject => $subject,
4733 body => $notify_template->fill_in( PACKAGE =>
4734 'FS::notify_template::_template' ),
4739 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4741 Generates a templated notification to the customer (see L<Text::Template>).
4743 OPTIONS is a hash and may include
4745 I<extra_fields> - a hashref of name/value pairs which will be substituted
4746 into the template. These values may override values mentioned below
4747 and those from the customer record.
4749 The following variables are available in the template instead of or in addition
4750 to the fields of the customer record.
4752 I<$payby> - a description of the method of payment for the customer
4753 # would be nice to use FS::payby::shortname
4754 I<$payinfo> - the masked account information used to collect for this customer
4755 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4756 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4760 # a lot like cust_bill::print_latex
4761 sub generate_letter {
4762 my ($self, $template, %options) = @_;
4764 return unless $conf->exists($template);
4766 my $letter_template = new Text::Template
4768 SOURCE => [ map "$_\n", $conf->config($template)],
4769 DELIMITERS => [ '[@--', '--@]' ],
4771 or die "can't create new Text::Template object: Text::Template::ERROR";
4773 $letter_template->compile()
4774 or die "can't compile template: Text::Template::ERROR";
4776 my %letter_data = map { $_ => $self->$_ } $self->fields;
4777 $letter_data{payinfo} = $self->mask_payinfo;
4779 #my $paydate = $self->paydate || '2037-12-31';
4780 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4782 my $payby = $self->payby;
4783 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4784 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4786 #credit cards expire at the end of the month/year of their exp date
4787 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4788 $letter_data{payby} = 'credit card';
4789 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4790 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4792 }elsif ($payby eq 'COMP') {
4793 $letter_data{payby} = 'complimentary account';
4795 $letter_data{payby} = 'current method';
4797 $letter_data{expdate} = $expire_time;
4799 for (keys %{$options{extra_fields}}){
4800 $letter_data{$_} = $options{extra_fields}->{$_};
4803 unless(exists($letter_data{returnaddress})){
4804 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4805 $self->agent_template)
4807 if ( length($retadd) ) {
4808 $letter_data{returnaddress} = $retadd;
4809 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4810 $letter_data{returnaddress} =
4811 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4815 ( $conf->config('company_name', $self->agentnum),
4816 $conf->config('company_address', $self->agentnum),
4820 $letter_data{returnaddress} = '~';
4824 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4826 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4828 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4830 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4834 ) or die "can't open temp file: $!\n";
4835 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4836 or die "can't write temp file: $!\n";
4838 $letter_data{'logo_file'} = $lh->filename;
4840 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4844 ) or die "can't open temp file: $!\n";
4846 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4848 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4849 return ($1, $letter_data{'logo_file'});
4853 =item print_ps TEMPLATE
4855 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4861 my($file, $lfile) = $self->generate_letter(@_);
4862 my $ps = FS::Misc::generate_ps($file);
4863 unlink($file.'.tex');
4869 =item print TEMPLATE
4871 Prints the filled in template.
4873 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4877 sub queueable_print {
4880 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4881 or die "invalid customer number: " . $opt{custvnum};
4883 my $error = $self->print( $opt{template} );
4884 die $error if $error;
4888 my ($self, $template) = (shift, shift);
4889 do_print [ $self->print_ps($template) ];
4892 #these three subs should just go away once agent stuff is all config overrides
4894 sub agent_template {
4896 $self->_agent_plandata('agent_templatename');
4899 sub agent_invoice_from {
4901 $self->_agent_plandata('agent_invoice_from');
4904 sub _agent_plandata {
4905 my( $self, $option ) = @_;
4907 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4908 #agent-specific Conf
4910 use FS::part_event::Condition;
4912 my $agentnum = $self->agentnum;
4914 my $regexp = regexp_sql();
4916 my $part_event_option =
4918 'select' => 'part_event_option.*',
4919 'table' => 'part_event_option',
4921 LEFT JOIN part_event USING ( eventpart )
4922 LEFT JOIN part_event_option AS peo_agentnum
4923 ON ( part_event.eventpart = peo_agentnum.eventpart
4924 AND peo_agentnum.optionname = 'agentnum'
4925 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4927 LEFT JOIN part_event_condition
4928 ON ( part_event.eventpart = part_event_condition.eventpart
4929 AND part_event_condition.conditionname = 'cust_bill_age'
4931 LEFT JOIN part_event_condition_option
4932 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4933 AND part_event_condition_option.optionname = 'age'
4936 #'hashref' => { 'optionname' => $option },
4937 #'hashref' => { 'part_event_option.optionname' => $option },
4939 " WHERE part_event_option.optionname = ". dbh->quote($option).
4940 " AND action = 'cust_bill_send_agent' ".
4941 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4942 " AND peo_agentnum.optionname = 'agentnum' ".
4943 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4945 CASE WHEN part_event_condition_option.optionname IS NULL
4947 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4949 , part_event.weight".
4953 unless ( $part_event_option ) {
4954 return $self->agent->invoice_template || ''
4955 if $option eq 'agent_templatename';
4959 $part_event_option->optionvalue;
4963 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4965 Subroutine (not a method), designed to be called from the queue.
4967 Takes a list of options and values.
4969 Pulls up the customer record via the custnum option and calls bill_and_collect.
4974 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4976 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4977 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4979 $cust_main->bill_and_collect( %args );
4982 sub process_bill_and_collect {
4984 my $param = thaw(decode_base64(shift));
4985 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4986 or die "custnum '$param->{custnum}' not found!\n";
4987 $param->{'job'} = $job;
4988 $param->{'fatal'} = 1; # runs from job queue, will be caught
4989 $param->{'retry'} = 1;
4991 $cust_main->bill_and_collect( %$param );
4994 =item process_censustract_update CUSTNUM
4996 Queueable function to update the census tract to the current year (as set in
4997 the 'census_year' configuration variable) and retrieve the new tract code.
5001 sub process_censustract_update {
5002 eval "use FS::Misc::Geo qw(get_censustract)";
5004 my $custnum = shift;
5005 my $cust_main = qsearchs( 'cust_main', { custnum => $custnum })
5006 or die "custnum '$custnum' not found!\n";
5008 my $new_year = $conf->config('census_year') or return;
5009 my $new_tract = get_censustract({ $cust_main->location_hash }, $new_year);
5010 if ( $new_tract =~ /^\d/ ) {
5011 # then it's a tract code
5012 $cust_main->set('censustract', $new_tract);
5013 $cust_main->set('censusyear', $new_year);
5015 local($ignore_expired_card) = 1;
5016 local($ignore_illegal_zip) = 1;
5017 local($ignore_banned_card) = 1;
5018 local($skip_fuzzyfiles) = 1;
5019 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5020 my $error = $cust_main->replace;
5021 die $error if $error;
5024 # it's an error message
5030 #starting to take quite a while for big dbs
5031 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5032 # - seq scan of cust_main on signupdate... index signupdate? will that help?
5033 # - seq scan of cust_main on paydate... index on substrings? maybe set an
5034 # upgrade journal flag now that we have that, yyyy-m-dd paydates are ancient
5035 # - seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5036 # upgrade journal again? this is also an ancient problem
5037 # - otaker upgrade? journal and call it good? (double check to make sure
5038 # we're not still setting otaker here)
5040 #only going to get worse with new location stuff...
5042 sub _upgrade_data { #class method
5043 my ($class, %opts) = @_;
5046 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5049 #this seems to be the only expensive one.. why does it take so long?
5050 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5052 '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';
5053 FS::upgrade_journal->set_done('cust_main__signupdate');
5056 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5058 # fix yyyy-m-dd formatted paydates
5059 if ( driver_name =~ /^mysql/i ) {
5061 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5062 } else { # the SQL standard
5064 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5066 FS::upgrade_journal->set_done('cust_main__paydate');
5069 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5071 push @statements, #fix the weird BILL with a cc# in payinfo problem
5073 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5075 FS::upgrade_journal->set_done('cust_main__payinfo');
5080 foreach my $sql ( @statements ) {
5081 my $sth = dbh->prepare($sql) or die dbh->errstr;
5082 $sth->execute or die $sth->errstr;
5083 #warn ( (time - $t). " seconds\n" );
5087 local($ignore_expired_card) = 1;
5088 local($ignore_banned_card) = 1;
5089 local($skip_fuzzyfiles) = 1;
5090 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5091 $class->_upgrade_otaker(%opts);
5093 FS::cust_main::Location->_upgrade_data(%opts);
5103 The delete method should possibly take an FS::cust_main object reference
5104 instead of a scalar customer number.
5106 Bill and collect options should probably be passed as references instead of a
5109 There should probably be a configuration file with a list of allowed credit
5112 No multiple currency support (probably a larger project than just this module).
5114 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5116 Birthdates rely on negative epoch values.
5118 The payby for card/check batches is broken. With mixed batching, bad
5121 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5125 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5126 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5127 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.