2 use base qw( FS::cust_main::Packages
4 FS::cust_main::NationalID
6 FS::cust_main::Billing_Realtime
7 FS::cust_main::Billing_Discount
8 FS::cust_main::Billing_ThirdParty
9 FS::cust_main::Location
10 FS::cust_main::Credit_Limit
12 FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
13 FS::geocode_Mixin FS::Quotable_Mixin FS::Sales_Mixin
21 use Scalar::Util qw( blessed );
22 use Time::Local qw(timelocal);
25 use Digest::MD5 qw(md5_base64);
28 use File::Temp; #qw( tempfile );
29 use Business::CreditCard 0.28;
31 use FS::UID qw( dbh driver_name );
32 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
34 use FS::Misc qw( generate_email send_email generate_ps do_print );
35 use FS::Msgcat qw(gettext);
42 use FS::cust_bill_void;
43 use FS::legacy_cust_bill;
45 use FS::cust_pay_pending;
46 use FS::cust_pay_void;
47 use FS::cust_pay_batch;
50 use FS::part_referral;
51 use FS::cust_main_county;
52 use FS::cust_location;
55 use FS::cust_main_exemption;
56 use FS::cust_tax_adjustment;
57 use FS::cust_tax_location;
58 use FS::agent_currency;
59 use FS::cust_main_invoice;
61 use FS::prepay_credit;
67 use FS::payment_gateway;
68 use FS::agent_payment_gateway;
70 use FS::cust_main_note;
71 use FS::cust_attachment;
74 use FS::upgrade_journal;
78 # 1 is mostly method/subroutine entry and options
79 # 2 traces progress of some operations
80 # 3 is even more information including possibly sensitive data
82 our $me = '[FS::cust_main]';
85 our $ignore_expired_card = 0;
86 our $ignore_banned_card = 0;
87 our $ignore_invalid_card = 0;
89 our $skip_fuzzyfiles = 0;
91 our $ucfirst_nowarn = 0;
93 our @encrypted_fields = ('payinfo', 'paycvv');
94 sub nohistory_fields { ('payinfo', 'paycvv'); }
96 our @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
99 #ask FS::UID to run this stuff for us later
100 #$FS::UID::callback{'FS::cust_main'} = sub {
101 install_callback FS::UID sub {
102 $conf = new FS::Conf;
103 #yes, need it for stuff below (prolly should be cached)
104 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
109 my ( $hashref, $cache ) = @_;
110 if ( exists $hashref->{'pkgnum'} ) {
111 #@{ $self->{'_pkgnum'} } = ();
112 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
113 $self->{'_pkgnum'} = $subcache;
114 #push @{ $self->{'_pkgnum'} },
115 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
121 FS::cust_main - Object methods for cust_main records
127 $record = new FS::cust_main \%hash;
128 $record = new FS::cust_main { 'column' => 'value' };
130 $error = $record->insert;
132 $error = $new_record->replace($old_record);
134 $error = $record->delete;
136 $error = $record->check;
138 @cust_pkg = $record->all_pkgs;
140 @cust_pkg = $record->ncancelled_pkgs;
142 @cust_pkg = $record->suspended_pkgs;
144 $error = $record->bill;
145 $error = $record->bill %options;
146 $error = $record->bill 'time' => $time;
148 $error = $record->collect;
149 $error = $record->collect %options;
150 $error = $record->collect 'invoice_time' => $time,
155 An FS::cust_main object represents a customer. FS::cust_main inherits from
156 FS::Record. The following fields are currently supported:
162 Primary key (assigned automatically for new customers)
166 Agent (see L<FS::agent>)
170 Advertising source (see L<FS::part_referral>)
182 Cocial security number (optional)
206 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
210 Payment Information (See L<FS::payinfo_Mixin> for data format)
214 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
218 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
222 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
226 Start date month (maestro/solo cards only)
230 Start date year (maestro/solo cards only)
234 Issue number (maestro/solo cards only)
238 Name on card or billing name
242 IP address from which payment information was received
246 Tax exempt, empty or `Y'
250 Order taker (see L<FS::access_user>)
256 =item referral_custnum
258 Referring customer number
262 Enable individual CDR spooling, empty or `Y'
266 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
270 Discourage individual CDR printing, empty or `Y'
274 Allow self-service editing of ticket subjects, empty or 'Y'
276 =item calling_list_exempt
278 Do not call, empty or 'Y'
288 Creates a new customer. To add the customer to the database, see L<"insert">.
290 Note that this stores the hash reference, not a distinct copy of the hash it
291 points to. You can ask the object for a copy with the I<hash> method.
295 sub table { 'cust_main'; }
297 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
299 Adds this customer to the database. If there is an error, returns the error,
300 otherwise returns false.
302 Usually the customer's location will not yet exist in the database, and
303 the C<bill_location> and C<ship_location> pseudo-fields must be set to
304 uninserted L<FS::cust_location> objects. These will be inserted and linked
305 (in both directions) to the new customer record. If they're references
306 to the same object, they will become the same location.
308 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
309 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
310 are inserted atomicly, or the transaction is rolled back. Passing an empty
311 hash reference is equivalent to not supplying this parameter. There should be
312 a better explanation of this, but until then, here's an example:
315 tie %hash, 'Tie::RefHash'; #this part is important
317 $cust_pkg => [ $svc_acct ],
320 $cust_main->insert( \%hash );
322 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
323 be set as the invoicing list (see L<"invoicing_list">). Errors return as
324 expected and rollback the entire transaction; it is not necessary to call
325 check_invoicing_list first. The invoicing_list is set after the records in the
326 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
327 invoicing_list destination to the newly-created svc_acct. Here's an example:
329 $cust_main->insert( {}, [ $email, 'POST' ] );
331 Currently available options are: I<depend_jobnum>, I<noexport>,
332 I<tax_exemption> and I<prospectnum>.
334 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
335 on the supplied jobnum (they will not run until the specific job completes).
336 This can be used to defer provisioning until some action completes (such
337 as running the customer's credit card successfully).
339 The I<noexport> option is deprecated. If I<noexport> is set true, no
340 provisioning jobs (exports) are scheduled. (You can schedule them later with
341 the B<reexport> method.)
343 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
344 of tax names and exemption numbers. FS::cust_main_exemption records will be
345 created and inserted.
347 If I<prospectnum> is set, moves contacts and locations from that prospect.
349 If I<contact> is set to an arrayref of FS::contact objects, inserts those
350 new contacts with this new customer.
356 my $cust_pkgs = @_ ? shift : {};
357 my $invoicing_list = @_ ? shift : '';
359 warn "$me insert called with options ".
360 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
363 local $SIG{HUP} = 'IGNORE';
364 local $SIG{INT} = 'IGNORE';
365 local $SIG{QUIT} = 'IGNORE';
366 local $SIG{TERM} = 'IGNORE';
367 local $SIG{TSTP} = 'IGNORE';
368 local $SIG{PIPE} = 'IGNORE';
370 my $oldAutoCommit = $FS::UID::AutoCommit;
371 local $FS::UID::AutoCommit = 0;
374 my $prepay_identifier = '';
375 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
377 if ( $self->payby eq 'PREPAY' ) {
379 $self->payby('BILL');
380 $prepay_identifier = $self->payinfo;
383 warn " looking up prepaid card $prepay_identifier\n"
386 my $error = $self->get_prepay( $prepay_identifier,
387 'amount_ref' => \$amount,
388 'seconds_ref' => \$seconds,
389 'upbytes_ref' => \$upbytes,
390 'downbytes_ref' => \$downbytes,
391 'totalbytes_ref' => \$totalbytes,
394 $dbh->rollback if $oldAutoCommit;
395 #return "error applying prepaid card (transaction rolled back): $error";
399 $payby = 'PREP' if $amount;
401 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|PPAL)$/ ) {
404 $self->payby('BILL');
405 $amount = $self->paid;
410 foreach my $l (qw(bill_location ship_location)) {
412 my $loc = delete $self->hashref->{$l} or next;
414 if ( !$loc->locationnum ) {
415 # warn the location that we're going to insert it with no custnum
416 $loc->set(custnum_pending => 1);
417 warn " inserting $l\n"
419 my $error = $loc->insert;
421 $dbh->rollback if $oldAutoCommit;
422 my $label = $l eq 'ship_location' ? 'service' : 'billing';
423 return "$error (in $label location)";
426 } elsif ( $loc->prospectnum ) {
428 $loc->prospectnum('');
429 $loc->set(custnum_pending => 1);
430 my $error = $loc->replace;
432 $dbh->rollback if $oldAutoCommit;
433 my $label = $l eq 'ship_location' ? 'service' : 'billing';
434 return "$error (moving $label location)";
437 } elsif ( ($loc->custnum || 0) > 0 ) {
438 # then it somehow belongs to another customer--shouldn't happen
439 $dbh->rollback if $oldAutoCommit;
440 return "$l belongs to customer ".$loc->custnum;
442 # else it already belongs to this customer
443 # (happens when ship_location is identical to bill_location)
445 $self->set($l.'num', $loc->locationnum);
447 if ( $self->get($l.'num') eq '' ) {
448 $dbh->rollback if $oldAutoCommit;
453 warn " inserting $self\n"
456 $self->signupdate(time) unless $self->signupdate;
458 $self->auto_agent_custid()
459 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
461 my $error = $self->SUPER::insert;
463 $dbh->rollback if $oldAutoCommit;
464 #return "inserting cust_main record (transaction rolled back): $error";
468 # now set cust_location.custnum
469 foreach my $l (qw(bill_location ship_location)) {
470 warn " setting $l.custnum\n"
472 my $loc = $self->$l or next;
473 unless ( $loc->custnum ) {
474 $loc->set(custnum => $self->custnum);
475 $error ||= $loc->replace;
479 $dbh->rollback if $oldAutoCommit;
480 return "error setting $l custnum: $error";
484 warn " setting invoicing list\n"
487 if ( $invoicing_list ) {
488 $error = $self->check_invoicing_list( $invoicing_list );
490 $dbh->rollback if $oldAutoCommit;
491 #return "checking invoicing_list (transaction rolled back): $error";
494 $self->invoicing_list( $invoicing_list );
497 warn " setting customer tags\n"
500 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
501 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
502 'custnum' => $self->custnum };
503 my $error = $cust_tag->insert;
505 $dbh->rollback if $oldAutoCommit;
510 my $prospectnum = delete $options{'prospectnum'};
511 if ( $prospectnum ) {
513 warn " moving contacts and locations from prospect $prospectnum\n"
517 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
518 unless ( $prospect_main ) {
519 $dbh->rollback if $oldAutoCommit;
520 return "Unknown prospectnum $prospectnum";
522 $prospect_main->custnum($self->custnum);
523 $prospect_main->disabled('Y');
524 my $error = $prospect_main->replace;
526 $dbh->rollback if $oldAutoCommit;
530 my @contact = $prospect_main->contact;
531 my @cust_location = $prospect_main->cust_location;
532 my @qual = $prospect_main->qual;
534 foreach my $r ( @contact, @cust_location, @qual ) {
536 $r->custnum($self->custnum);
537 my $error = $r->replace;
539 $dbh->rollback if $oldAutoCommit;
546 my $contact = delete $options{'contact'};
549 foreach my $c ( @$contact ) {
550 $c->custnum($self->custnum);
551 my $error = $c->insert;
553 $dbh->rollback if $oldAutoCommit;
561 warn " setting cust_main_exemption\n"
564 my $tax_exemption = delete $options{'tax_exemption'};
565 if ( $tax_exemption ) {
567 $tax_exemption = { map { $_ => '' } @$tax_exemption }
568 if ref($tax_exemption) eq 'ARRAY';
570 foreach my $taxname ( keys %$tax_exemption ) {
571 my $cust_main_exemption = new FS::cust_main_exemption {
572 'custnum' => $self->custnum,
573 'taxname' => $taxname,
574 'exempt_number' => $tax_exemption->{$taxname},
576 my $error = $cust_main_exemption->insert;
578 $dbh->rollback if $oldAutoCommit;
579 return "inserting cust_main_exemption (transaction rolled back): $error";
584 warn " ordering packages\n"
587 $error = $self->order_pkgs( $cust_pkgs,
589 'seconds_ref' => \$seconds,
590 'upbytes_ref' => \$upbytes,
591 'downbytes_ref' => \$downbytes,
592 'totalbytes_ref' => \$totalbytes,
595 $dbh->rollback if $oldAutoCommit;
600 $dbh->rollback if $oldAutoCommit;
601 return "No svc_acct record to apply pre-paid time";
603 if ( $upbytes || $downbytes || $totalbytes ) {
604 $dbh->rollback if $oldAutoCommit;
605 return "No svc_acct record to apply pre-paid data";
609 warn " inserting initial $payby payment of $amount\n"
611 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
613 $dbh->rollback if $oldAutoCommit;
614 return "inserting payment (transaction rolled back): $error";
618 unless ( $import || $skip_fuzzyfiles ) {
619 warn " queueing fuzzyfiles update\n"
621 $error = $self->queue_fuzzyfiles_update;
623 $dbh->rollback if $oldAutoCommit;
624 return "updating fuzzy search cache: $error";
628 # FS::geocode_Mixin::after_insert or something?
629 if ( $conf->config('tax_district_method') and !$import ) {
630 # if anything non-empty, try to look it up
631 my $queue = new FS::queue {
632 'job' => 'FS::geocode_Mixin::process_district_update',
633 'custnum' => $self->custnum,
635 my $error = $queue->insert( ref($self), $self->custnum );
637 $dbh->rollback if $oldAutoCommit;
638 return "queueing tax district update: $error";
643 warn " exporting\n" if $DEBUG > 1;
645 my $export_args = $options{'export_args'} || [];
648 map qsearch( 'part_export', {exportnum=>$_} ),
649 $conf->config('cust_main-exports'); #, $agentnum
651 foreach my $part_export ( @part_export ) {
652 my $error = $part_export->export_insert($self, @$export_args);
654 $dbh->rollback if $oldAutoCommit;
655 return "exporting to ". $part_export->exporttype.
656 " (transaction rolled back): $error";
660 #foreach my $depend_jobnum ( @$depend_jobnums ) {
661 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
663 # foreach my $jobnum ( @jobnums ) {
664 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
665 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
667 # my $error = $queue->depend_insert($depend_jobnum);
669 # $dbh->rollback if $oldAutoCommit;
670 # return "error queuing job dependancy: $error";
677 #if ( exists $options{'jobnums'} ) {
678 # push @{ $options{'jobnums'} }, @jobnums;
681 warn " insert complete; committing transaction\n"
684 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
689 use File::CounterFile;
690 sub auto_agent_custid {
693 my $format = $conf->config('cust_main-auto_agent_custid');
695 if ( $format eq '1YMMXXXXXXXX' ) {
697 my $counter = new File::CounterFile 'cust_main.agent_custid';
700 my $ym = 100000000000 + time2str('%y%m00000000', time);
701 if ( $ym > $counter->value ) {
702 $counter->{'value'} = $agent_custid = $ym;
703 $counter->{'updated'} = 1;
705 $agent_custid = $counter->inc;
711 die "Unknown cust_main-auto_agent_custid format: $format";
714 $self->agent_custid($agent_custid);
718 =item PACKAGE METHODS
720 Documentation on customer package methods has been moved to
721 L<FS::cust_main::Packages>.
723 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
725 Recharges this (existing) customer with the specified prepaid card (see
726 L<FS::prepay_credit>), specified either by I<identifier> or as an
727 FS::prepay_credit object. If there is an error, returns the error, otherwise
730 Optionally, five scalar references can be passed as well. They will have their
731 values filled in with the amount, number of seconds, and number of upload,
732 download, and total bytes applied by this prepaid card.
736 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
737 #the only place that uses these args
738 sub recharge_prepay {
739 my( $self, $prepay_credit, $amountref, $secondsref,
740 $upbytesref, $downbytesref, $totalbytesref ) = @_;
742 local $SIG{HUP} = 'IGNORE';
743 local $SIG{INT} = 'IGNORE';
744 local $SIG{QUIT} = 'IGNORE';
745 local $SIG{TERM} = 'IGNORE';
746 local $SIG{TSTP} = 'IGNORE';
747 local $SIG{PIPE} = 'IGNORE';
749 my $oldAutoCommit = $FS::UID::AutoCommit;
750 local $FS::UID::AutoCommit = 0;
753 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
755 my $error = $self->get_prepay( $prepay_credit,
756 'amount_ref' => \$amount,
757 'seconds_ref' => \$seconds,
758 'upbytes_ref' => \$upbytes,
759 'downbytes_ref' => \$downbytes,
760 'totalbytes_ref' => \$totalbytes,
762 || $self->increment_seconds($seconds)
763 || $self->increment_upbytes($upbytes)
764 || $self->increment_downbytes($downbytes)
765 || $self->increment_totalbytes($totalbytes)
766 || $self->insert_cust_pay_prepay( $amount,
768 ? $prepay_credit->identifier
773 $dbh->rollback if $oldAutoCommit;
777 if ( defined($amountref) ) { $$amountref = $amount; }
778 if ( defined($secondsref) ) { $$secondsref = $seconds; }
779 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
780 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
781 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
783 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
788 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
790 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
791 specified either by I<identifier> or as an FS::prepay_credit object.
793 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
794 incremented by the values of the prepaid card.
796 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
797 check or set this customer's I<agentnum>.
799 If there is an error, returns the error, otherwise returns false.
805 my( $self, $prepay_credit, %opt ) = @_;
807 local $SIG{HUP} = 'IGNORE';
808 local $SIG{INT} = 'IGNORE';
809 local $SIG{QUIT} = 'IGNORE';
810 local $SIG{TERM} = 'IGNORE';
811 local $SIG{TSTP} = 'IGNORE';
812 local $SIG{PIPE} = 'IGNORE';
814 my $oldAutoCommit = $FS::UID::AutoCommit;
815 local $FS::UID::AutoCommit = 0;
818 unless ( ref($prepay_credit) ) {
820 my $identifier = $prepay_credit;
822 $prepay_credit = qsearchs(
824 { 'identifier' => $identifier },
829 unless ( $prepay_credit ) {
830 $dbh->rollback if $oldAutoCommit;
831 return "Invalid prepaid card: ". $identifier;
836 if ( $prepay_credit->agentnum ) {
837 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
838 $dbh->rollback if $oldAutoCommit;
839 return "prepaid card not valid for agent ". $self->agentnum;
841 $self->agentnum($prepay_credit->agentnum);
844 my $error = $prepay_credit->delete;
846 $dbh->rollback if $oldAutoCommit;
847 return "removing prepay_credit (transaction rolled back): $error";
850 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
851 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
853 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
858 =item increment_upbytes SECONDS
860 Updates this customer's single or primary account (see L<FS::svc_acct>) by
861 the specified number of upbytes. If there is an error, returns the error,
862 otherwise returns false.
866 sub increment_upbytes {
867 _increment_column( shift, 'upbytes', @_);
870 =item increment_downbytes SECONDS
872 Updates this customer's single or primary account (see L<FS::svc_acct>) by
873 the specified number of downbytes. If there is an error, returns the error,
874 otherwise returns false.
878 sub increment_downbytes {
879 _increment_column( shift, 'downbytes', @_);
882 =item increment_totalbytes SECONDS
884 Updates this customer's single or primary account (see L<FS::svc_acct>) by
885 the specified number of totalbytes. If there is an error, returns the error,
886 otherwise returns false.
890 sub increment_totalbytes {
891 _increment_column( shift, 'totalbytes', @_);
894 =item increment_seconds SECONDS
896 Updates this customer's single or primary account (see L<FS::svc_acct>) by
897 the specified number of seconds. If there is an error, returns the error,
898 otherwise returns false.
902 sub increment_seconds {
903 _increment_column( shift, 'seconds', @_);
906 =item _increment_column AMOUNT
908 Updates this customer's single or primary account (see L<FS::svc_acct>) by
909 the specified number of seconds or bytes. If there is an error, returns
910 the error, otherwise returns false.
914 sub _increment_column {
915 my( $self, $column, $amount ) = @_;
916 warn "$me increment_column called: $column, $amount\n"
919 return '' unless $amount;
921 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
922 $self->ncancelled_pkgs;
925 return 'No packages with primary or single services found'.
926 ' to apply pre-paid time';
927 } elsif ( scalar(@cust_pkg) > 1 ) {
928 #maybe have a way to specify the package/account?
929 return 'Multiple packages found to apply pre-paid time';
932 my $cust_pkg = $cust_pkg[0];
933 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
937 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
940 return 'No account found to apply pre-paid time';
941 } elsif ( scalar(@cust_svc) > 1 ) {
942 return 'Multiple accounts found to apply pre-paid time';
945 my $svc_acct = $cust_svc[0]->svc_x;
946 warn " found service svcnum ". $svc_acct->pkgnum.
947 ' ('. $svc_acct->email. ")\n"
950 $column = "increment_$column";
951 $svc_acct->$column($amount);
955 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
957 Inserts a prepayment in the specified amount for this customer. An optional
958 second argument can specify the prepayment identifier for tracking purposes.
959 If there is an error, returns the error, otherwise returns false.
963 sub insert_cust_pay_prepay {
964 shift->insert_cust_pay('PREP', @_);
967 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
969 Inserts a cash payment in the specified amount for this customer. An optional
970 second argument can specify the payment identifier for tracking purposes.
971 If there is an error, returns the error, otherwise returns false.
975 sub insert_cust_pay_cash {
976 shift->insert_cust_pay('CASH', @_);
979 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
981 Inserts a Western Union payment in the specified amount for this customer. An
982 optional second argument can specify the prepayment identifier for tracking
983 purposes. If there is an error, returns the error, otherwise returns false.
987 sub insert_cust_pay_west {
988 shift->insert_cust_pay('WEST', @_);
991 sub insert_cust_pay {
992 my( $self, $payby, $amount ) = splice(@_, 0, 3);
993 my $payinfo = scalar(@_) ? shift : '';
995 my $cust_pay = new FS::cust_pay {
996 'custnum' => $self->custnum,
997 'paid' => sprintf('%.2f', $amount),
998 #'_date' => #date the prepaid card was purchased???
1000 'payinfo' => $payinfo,
1006 =item delete [ OPTION => VALUE ... ]
1008 This deletes the customer. If there is an error, returns the error, otherwise
1011 This will completely remove all traces of the customer record. This is not
1012 what you want when a customer cancels service; for that, cancel all of the
1013 customer's packages (see L</cancel>).
1015 If the customer has any uncancelled packages, you need to pass a new (valid)
1016 customer number for those packages to be transferred to, as the "new_customer"
1017 option. Cancelled packages will be deleted. Did I mention that this is NOT
1018 what you want when a customer cancels service and that you really should be
1019 looking at L<FS::cust_pkg/cancel>?
1021 You can't delete a customer with invoices (see L<FS::cust_bill>),
1022 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1023 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1024 set the "delete_financials" option to a true value.
1029 my( $self, %opt ) = @_;
1031 local $SIG{HUP} = 'IGNORE';
1032 local $SIG{INT} = 'IGNORE';
1033 local $SIG{QUIT} = 'IGNORE';
1034 local $SIG{TERM} = 'IGNORE';
1035 local $SIG{TSTP} = 'IGNORE';
1036 local $SIG{PIPE} = 'IGNORE';
1038 my $oldAutoCommit = $FS::UID::AutoCommit;
1039 local $FS::UID::AutoCommit = 0;
1042 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1043 $dbh->rollback if $oldAutoCommit;
1044 return "Can't delete a master agent customer";
1047 #use FS::access_user
1048 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1049 $dbh->rollback if $oldAutoCommit;
1050 return "Can't delete a master employee customer";
1053 tie my %financial_tables, 'Tie::IxHash',
1054 'cust_bill' => 'invoices',
1055 'cust_statement' => 'statements',
1056 'cust_credit' => 'credits',
1057 'cust_pay' => 'payments',
1058 'cust_refund' => 'refunds',
1061 foreach my $table ( keys %financial_tables ) {
1063 my @records = $self->$table();
1065 if ( @records && ! $opt{'delete_financials'} ) {
1066 $dbh->rollback if $oldAutoCommit;
1067 return "Can't delete a customer with ". $financial_tables{$table};
1070 foreach my $record ( @records ) {
1071 my $error = $record->delete;
1073 $dbh->rollback if $oldAutoCommit;
1074 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1080 my @cust_pkg = $self->ncancelled_pkgs;
1082 my $new_custnum = $opt{'new_custnum'};
1083 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1084 $dbh->rollback if $oldAutoCommit;
1085 return "Invalid new customer number: $new_custnum";
1087 foreach my $cust_pkg ( @cust_pkg ) {
1088 my %hash = $cust_pkg->hash;
1089 $hash{'custnum'} = $new_custnum;
1090 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1091 my $error = $new_cust_pkg->replace($cust_pkg,
1092 options => { $cust_pkg->options },
1095 $dbh->rollback if $oldAutoCommit;
1100 my @cancelled_cust_pkg = $self->all_pkgs;
1101 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1102 my $error = $cust_pkg->delete;
1104 $dbh->rollback if $oldAutoCommit;
1109 #cust_tax_adjustment in financials?
1110 #cust_pay_pending? ouch
1112 foreach my $table (qw(
1113 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1114 cust_location cust_main_note cust_tax_adjustment
1115 cust_pay_void cust_pay_batch queue cust_tax_exempt
1117 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1118 my $error = $record->delete;
1120 $dbh->rollback if $oldAutoCommit;
1126 my $sth = $dbh->prepare(
1127 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1129 my $errstr = $dbh->errstr;
1130 $dbh->rollback if $oldAutoCommit;
1133 $sth->execute($self->custnum) or do {
1134 my $errstr = $sth->errstr;
1135 $dbh->rollback if $oldAutoCommit;
1141 my $ticket_dbh = '';
1142 if ($conf->config('ticket_system') eq 'RT_Internal') {
1144 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1145 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1146 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1147 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1150 if ( $ticket_dbh ) {
1152 my $ticket_sth = $ticket_dbh->prepare(
1153 'DELETE FROM Links WHERE Target = ?'
1155 my $errstr = $ticket_dbh->errstr;
1156 $dbh->rollback if $oldAutoCommit;
1159 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1161 my $errstr = $ticket_sth->errstr;
1162 $dbh->rollback if $oldAutoCommit;
1166 #check and see if the customer is the only link on the ticket, and
1167 #if so, set the ticket to deleted status in RT?
1168 #maybe someday, for now this will at least fix tickets not displaying
1172 #delete the customer record
1174 my $error = $self->SUPER::delete;
1176 $dbh->rollback if $oldAutoCommit;
1180 # cust_main exports!
1182 #my $export_args = $options{'export_args'} || [];
1185 map qsearch( 'part_export', {exportnum=>$_} ),
1186 $conf->config('cust_main-exports'); #, $agentnum
1188 foreach my $part_export ( @part_export ) {
1189 my $error = $part_export->export_delete( $self ); #, @$export_args);
1191 $dbh->rollback if $oldAutoCommit;
1192 return "exporting to ". $part_export->exporttype.
1193 " (transaction rolled back): $error";
1197 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1202 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1204 This merges this customer into the provided new custnum, and then deletes the
1205 customer. If there is an error, returns the error, otherwise returns false.
1207 The source customer's name, company name, phone numbers, agent,
1208 referring customer, customer class, advertising source, order taker, and
1209 billing information (except balance) are discarded.
1211 All packages are moved to the target customer. Packages with package locations
1212 are preserved. Packages without package locations are moved to a new package
1213 location with the source customer's service/shipping address.
1215 All invoices, statements, payments, credits and refunds are moved to the target
1216 customer. The source customer's balance is added to the target customer.
1218 All notes, attachments, tickets and customer tags are moved to the target
1221 Change history is not currently moved.
1226 my( $self, $new_custnum, %opt ) = @_;
1228 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1230 my $new_cust_main = qsearchs( 'cust_main', { 'custnum' => $new_custnum } )
1231 or return "Invalid new customer number: $new_custnum";
1233 return 'Access denied: "Merge customer across agents" access right required to merge into a customer of a different agent'
1234 if $self->agentnum != $new_cust_main->agentnum
1235 && ! $FS::CurrentUser::CurrentUser->access_right('Merge customer across agents');
1237 local $SIG{HUP} = 'IGNORE';
1238 local $SIG{INT} = 'IGNORE';
1239 local $SIG{QUIT} = 'IGNORE';
1240 local $SIG{TERM} = 'IGNORE';
1241 local $SIG{TSTP} = 'IGNORE';
1242 local $SIG{PIPE} = 'IGNORE';
1244 my $oldAutoCommit = $FS::UID::AutoCommit;
1245 local $FS::UID::AutoCommit = 0;
1248 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1249 $dbh->rollback if $oldAutoCommit;
1250 return "Can't merge a master agent customer";
1253 #use FS::access_user
1254 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1255 $dbh->rollback if $oldAutoCommit;
1256 return "Can't merge a master employee customer";
1259 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1260 'status' => { op=>'!=', value=>'done' },
1264 $dbh->rollback if $oldAutoCommit;
1265 return "Can't merge a customer with pending payments";
1268 tie my %financial_tables, 'Tie::IxHash',
1269 'cust_bill' => 'invoices',
1270 'cust_bill_void' => 'voided invoices',
1271 'cust_statement' => 'statements',
1272 'cust_credit' => 'credits',
1273 'cust_credit_void' => 'voided credits',
1274 'cust_pay' => 'payments',
1275 'cust_pay_void' => 'voided payments',
1276 'cust_refund' => 'refunds',
1279 foreach my $table ( keys %financial_tables ) {
1281 my @records = $self->$table();
1283 foreach my $record ( @records ) {
1284 $record->custnum($new_custnum);
1285 my $error = $record->replace;
1287 $dbh->rollback if $oldAutoCommit;
1288 return "Error merging ". $financial_tables{$table}. ": $error\n";
1294 my $name = $self->ship_name; #?
1296 my $locationnum = '';
1297 foreach my $cust_pkg ( $self->all_pkgs ) {
1298 $cust_pkg->custnum($new_custnum);
1300 unless ( $cust_pkg->locationnum ) {
1301 unless ( $locationnum ) {
1302 my $cust_location = new FS::cust_location {
1303 $self->location_hash,
1304 'custnum' => $new_custnum,
1306 my $error = $cust_location->insert;
1308 $dbh->rollback if $oldAutoCommit;
1311 $locationnum = $cust_location->locationnum;
1313 $cust_pkg->locationnum($locationnum);
1316 my $error = $cust_pkg->replace;
1318 $dbh->rollback if $oldAutoCommit;
1322 # add customer (ship) name to svc_phone.phone_name if blank
1323 my @cust_svc = $cust_pkg->cust_svc;
1324 foreach my $cust_svc (@cust_svc) {
1325 my($label, $value, $svcdb) = $cust_svc->label;
1326 next unless $svcdb eq 'svc_phone';
1327 my $svc_phone = $cust_svc->svc_x;
1328 next if $svc_phone->phone_name;
1329 $svc_phone->phone_name($name);
1330 my $error = $svc_phone->replace;
1332 $dbh->rollback if $oldAutoCommit;
1340 # cust_tax_exempt (texas tax exemptions)
1341 # cust_recon (some sort of not-well understood thing for OnPac)
1343 #these are moved over
1344 foreach my $table (qw(
1345 cust_tag cust_location contact cust_attachment cust_main_note
1346 cust_tax_adjustment cust_pay_batch queue
1348 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1349 $record->custnum($new_custnum);
1350 my $error = $record->replace;
1352 $dbh->rollback if $oldAutoCommit;
1358 #these aren't preserved
1359 foreach my $table (qw(
1360 cust_main_exemption cust_main_invoice
1362 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1363 my $error = $record->delete;
1365 $dbh->rollback if $oldAutoCommit;
1372 my $sth = $dbh->prepare(
1373 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1375 my $errstr = $dbh->errstr;
1376 $dbh->rollback if $oldAutoCommit;
1379 $sth->execute($new_custnum, $self->custnum) or do {
1380 my $errstr = $sth->errstr;
1381 $dbh->rollback if $oldAutoCommit;
1387 my $ticket_dbh = '';
1388 if ($conf->config('ticket_system') eq 'RT_Internal') {
1390 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1391 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1392 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1393 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1396 if ( $ticket_dbh ) {
1398 my $ticket_sth = $ticket_dbh->prepare(
1399 'UPDATE Links SET Target = ? WHERE Target = ?'
1401 my $errstr = $ticket_dbh->errstr;
1402 $dbh->rollback if $oldAutoCommit;
1405 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1406 'freeside://freeside/cust_main/'.$self->custnum)
1408 my $errstr = $ticket_sth->errstr;
1409 $dbh->rollback if $oldAutoCommit;
1415 #delete the customer record
1417 my $error = $self->delete;
1419 $dbh->rollback if $oldAutoCommit;
1423 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1428 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1430 Replaces the OLD_RECORD with this one in the database. If there is an error,
1431 returns the error, otherwise returns false.
1433 To change the customer's address, set the pseudo-fields C<bill_location> and
1434 C<ship_location>. The address will still only change if at least one of the
1435 address fields differs from the existing values.
1437 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1438 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1439 expected and rollback the entire transaction; it is not necessary to call
1440 check_invoicing_list first. Here's an example:
1442 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1444 Currently available options are: I<tax_exemption>.
1446 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1447 of tax names and exemption numbers. FS::cust_main_exemption records will be
1448 deleted and inserted as appropriate.
1455 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1457 : $self->replace_old;
1461 warn "$me replace called\n"
1464 my $curuser = $FS::CurrentUser::CurrentUser;
1465 if ( $self->payby eq 'COMP'
1466 && $self->payby ne $old->payby
1467 && ! $curuser->access_right('Complimentary customer')
1470 return "You are not permitted to create complimentary accounts.";
1473 local($ignore_expired_card) = 1
1474 if $old->payby =~ /^(CARD|DCRD)$/
1475 && $self->payby =~ /^(CARD|DCRD)$/
1476 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1478 local($ignore_banned_card) = 1
1479 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1480 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1481 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1483 return "Invoicing locale is required"
1486 && $conf->exists('cust_main-require_locale');
1488 local $SIG{HUP} = 'IGNORE';
1489 local $SIG{INT} = 'IGNORE';
1490 local $SIG{QUIT} = 'IGNORE';
1491 local $SIG{TERM} = 'IGNORE';
1492 local $SIG{TSTP} = 'IGNORE';
1493 local $SIG{PIPE} = 'IGNORE';
1495 my $oldAutoCommit = $FS::UID::AutoCommit;
1496 local $FS::UID::AutoCommit = 0;
1499 for my $l (qw(bill_location ship_location)) {
1500 my $old_loc = $old->$l;
1501 my $new_loc = $self->$l;
1503 # find the existing location if there is one
1504 $new_loc->set('custnum' => $self->custnum);
1505 my $error = $new_loc->find_or_insert;
1507 $dbh->rollback if $oldAutoCommit;
1510 $self->set($l.'num', $new_loc->locationnum);
1513 # replace the customer record
1514 my $error = $self->SUPER::replace($old);
1517 $dbh->rollback if $oldAutoCommit;
1521 # now move packages to the new service location
1522 $self->set('ship_location', ''); #flush cache
1523 if ( $old->ship_locationnum and # should only be null during upgrade...
1524 $old->ship_locationnum != $self->ship_locationnum ) {
1525 $error = $old->ship_location->move_to($self->ship_location);
1527 $dbh->rollback if $oldAutoCommit;
1531 # don't move packages based on the billing location, but
1532 # disable it if it's no longer in use
1533 if ( $old->bill_locationnum and
1534 $old->bill_locationnum != $self->bill_locationnum ) {
1535 $error = $old->bill_location->disable_if_unused;
1537 $dbh->rollback if $oldAutoCommit;
1542 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1543 my $invoicing_list = shift @param;
1544 $error = $self->check_invoicing_list( $invoicing_list );
1546 $dbh->rollback if $oldAutoCommit;
1549 $self->invoicing_list( $invoicing_list );
1552 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1554 #this could be more efficient than deleting and re-inserting, if it matters
1555 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1556 my $error = $cust_tag->delete;
1558 $dbh->rollback if $oldAutoCommit;
1562 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1563 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1564 'custnum' => $self->custnum };
1565 my $error = $cust_tag->insert;
1567 $dbh->rollback if $oldAutoCommit;
1574 my %options = @param;
1576 my $tax_exemption = delete $options{'tax_exemption'};
1577 if ( $tax_exemption ) {
1579 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1580 if ref($tax_exemption) eq 'ARRAY';
1582 my %cust_main_exemption =
1583 map { $_->taxname => $_ }
1584 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1586 foreach my $taxname ( keys %$tax_exemption ) {
1588 if ( $cust_main_exemption{$taxname} &&
1589 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1592 delete $cust_main_exemption{$taxname};
1596 my $cust_main_exemption = new FS::cust_main_exemption {
1597 'custnum' => $self->custnum,
1598 'taxname' => $taxname,
1599 'exempt_number' => $tax_exemption->{$taxname},
1601 my $error = $cust_main_exemption->insert;
1603 $dbh->rollback if $oldAutoCommit;
1604 return "inserting cust_main_exemption (transaction rolled back): $error";
1608 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1609 my $error = $cust_main_exemption->delete;
1611 $dbh->rollback if $oldAutoCommit;
1612 return "deleting cust_main_exemption (transaction rolled back): $error";
1618 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1619 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1620 && $self->get('payinfo') !~ /^99\d{14}$/
1622 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1627 # card/check/lec info has changed, want to retry realtime_ invoice events
1628 my $error = $self->retry_realtime;
1630 $dbh->rollback if $oldAutoCommit;
1635 unless ( $import || $skip_fuzzyfiles ) {
1636 $error = $self->queue_fuzzyfiles_update;
1638 $dbh->rollback if $oldAutoCommit;
1639 return "updating fuzzy search cache: $error";
1643 # tax district update in cust_location
1645 # cust_main exports!
1647 my $export_args = $options{'export_args'} || [];
1650 map qsearch( 'part_export', {exportnum=>$_} ),
1651 $conf->config('cust_main-exports'); #, $agentnum
1653 foreach my $part_export ( @part_export ) {
1654 my $error = $part_export->export_replace( $self, $old, @$export_args);
1656 $dbh->rollback if $oldAutoCommit;
1657 return "exporting to ". $part_export->exporttype.
1658 " (transaction rolled back): $error";
1662 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1667 =item queue_fuzzyfiles_update
1669 Used by insert & replace to update the fuzzy search cache
1673 use FS::cust_main::Search;
1674 sub queue_fuzzyfiles_update {
1677 local $SIG{HUP} = 'IGNORE';
1678 local $SIG{INT} = 'IGNORE';
1679 local $SIG{QUIT} = 'IGNORE';
1680 local $SIG{TERM} = 'IGNORE';
1681 local $SIG{TSTP} = 'IGNORE';
1682 local $SIG{PIPE} = 'IGNORE';
1684 my $oldAutoCommit = $FS::UID::AutoCommit;
1685 local $FS::UID::AutoCommit = 0;
1688 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1689 my $queue = new FS::queue {
1690 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1692 my @args = "cust_main.$field", $self->get($field);
1693 my $error = $queue->insert( @args );
1695 $dbh->rollback if $oldAutoCommit;
1696 return "queueing job (transaction rolled back): $error";
1701 push @locations, $self->bill_location if $self->bill_locationnum;
1702 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1703 foreach my $location (@locations) {
1704 my $queue = new FS::queue {
1705 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1707 my @args = 'cust_location.address1', $location->address1;
1708 my $error = $queue->insert( @args );
1710 $dbh->rollback if $oldAutoCommit;
1711 return "queueing job (transaction rolled back): $error";
1715 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1722 Checks all fields to make sure this is a valid customer record. If there is
1723 an error, returns the error, otherwise returns false. Called by the insert
1724 and replace methods.
1731 warn "$me check BEFORE: \n". $self->_dump
1735 $self->ut_numbern('custnum')
1736 || $self->ut_number('agentnum')
1737 || $self->ut_textn('agent_custid')
1738 || $self->ut_number('refnum')
1739 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1740 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1741 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1742 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1743 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1744 || $self->ut_textn('custbatch')
1745 || $self->ut_name('last')
1746 || $self->ut_name('first')
1747 || $self->ut_snumbern('signupdate')
1748 || $self->ut_snumbern('birthdate')
1749 || $self->ut_namen('spouse_last')
1750 || $self->ut_namen('spouse_first')
1751 || $self->ut_snumbern('spouse_birthdate')
1752 || $self->ut_snumbern('anniversary_date')
1753 || $self->ut_textn('company')
1754 || $self->ut_textn('ship_company')
1755 || $self->ut_anything('comments')
1756 || $self->ut_numbern('referral_custnum')
1757 || $self->ut_textn('stateid')
1758 || $self->ut_textn('stateid_state')
1759 || $self->ut_textn('invoice_terms')
1760 || $self->ut_floatn('cdr_termination_percentage')
1761 || $self->ut_floatn('credit_limit')
1762 || $self->ut_numbern('billday')
1763 || $self->ut_numbern('prorate_day')
1764 || $self->ut_flag('edit_subject')
1765 || $self->ut_flag('calling_list_exempt')
1766 || $self->ut_flag('invoice_noemail')
1767 || $self->ut_flag('message_noemail')
1768 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1769 || $self->ut_currencyn('currency')
1772 foreach (qw(company ship_company)) {
1773 my $company = $self->get($_);
1774 $company =~ s/^\s+//;
1775 $company =~ s/\s+$//;
1776 $company =~ s/\s+/ /g;
1777 $self->set($_, $company);
1780 #barf. need message catalogs. i18n. etc.
1781 $error .= "Please select an advertising source."
1782 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1783 return $error if $error;
1785 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1786 or return "Unknown agent";
1788 if ( $self->currency ) {
1789 my $agent_currency = qsearchs( 'agent_currency', {
1790 'agentnum' => $agent->agentnum,
1791 'currency' => $self->currency,
1793 or return "Agent ". $agent->agent.
1794 " not permitted to offer ". $self->currency. " invoicing";
1797 return "Unknown refnum"
1798 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1800 return "Unknown referring custnum: ". $self->referral_custnum
1801 unless ! $self->referral_custnum
1802 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1804 if ( $self->ss eq '' ) {
1809 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1810 or return "Illegal social security number: ". $self->ss;
1811 $self->ss("$1-$2-$3");
1814 # cust_main_county verification now handled by cust_location check
1817 $self->ut_phonen('daytime', $self->country)
1818 || $self->ut_phonen('night', $self->country)
1819 || $self->ut_phonen('fax', $self->country)
1820 || $self->ut_phonen('mobile', $self->country)
1822 return $error if $error;
1824 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1826 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1829 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1831 : FS::Msgcat::_gettext('daytime');
1832 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1834 : FS::Msgcat::_gettext('night');
1836 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1838 : FS::Msgcat::_gettext('mobile');
1840 return "$daytime_label, $night_label or $mobile_label is required"
1844 ### start of stuff moved to cust_payby
1845 # then mostly kept here to support upgrades (can remove in 5.x)
1846 # but modified to allow everything to be empty
1848 if ( $self->payby ) {
1849 FS::payby->can_payby($self->table, $self->payby)
1850 or return "Illegal payby: ". $self->payby;
1855 $error = $self->ut_numbern('paystart_month')
1856 || $self->ut_numbern('paystart_year')
1857 || $self->ut_numbern('payissue')
1858 || $self->ut_textn('paytype')
1860 return $error if $error;
1862 if ( $self->payip eq '' ) {
1865 $error = $self->ut_ip('payip');
1866 return $error if $error;
1869 # If it is encrypted and the private key is not availaible then we can't
1870 # check the credit card.
1871 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1873 # Need some kind of global flag to accept invalid cards, for testing
1875 if ( !$import && !$ignore_invalid_card && $check_payinfo &&
1876 $self->payby =~ /^(CARD|DCRD)$/ ) {
1878 my $payinfo = $self->payinfo;
1879 $payinfo =~ s/\D//g;
1880 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1881 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1883 $self->payinfo($payinfo);
1885 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1887 return gettext('unknown_card_type')
1888 if $self->payinfo !~ /^99\d{14}$/ #token
1889 && cardtype($self->payinfo) eq "Unknown";
1891 unless ( $ignore_banned_card ) {
1892 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1894 if ( $ban->bantype eq 'warn' ) {
1895 #or others depending on value of $ban->reason ?
1896 return '_duplicate_card'.
1897 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1898 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1899 ' (ban# '. $ban->bannum. ')'
1900 unless $self->override_ban_warn;
1902 return 'Banned credit card: banned on '.
1903 time2str('%a %h %o at %r', $ban->_date).
1904 ' by '. $ban->otaker.
1905 ' (ban# '. $ban->bannum. ')';
1910 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1911 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1912 $self->paycvv =~ /^(\d{4})$/
1913 or return "CVV2 (CID) for American Express cards is four digits.";
1916 $self->paycvv =~ /^(\d{3})$/
1917 or return "CVV2 (CVC2/CID) is three digits.";
1924 my $cardtype = cardtype($payinfo);
1925 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1927 return "Start date or issue number is required for $cardtype cards"
1928 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1930 return "Start month must be between 1 and 12"
1931 if $self->paystart_month
1932 and $self->paystart_month < 1 || $self->paystart_month > 12;
1934 return "Start year must be 1990 or later"
1935 if $self->paystart_year
1936 and $self->paystart_year < 1990;
1938 return "Issue number must be beween 1 and 99"
1940 and $self->payissue < 1 || $self->payissue > 99;
1943 $self->paystart_month('');
1944 $self->paystart_year('');
1945 $self->payissue('');
1948 } elsif ( !$ignore_invalid_card && $check_payinfo &&
1949 $self->payby =~ /^(CHEK|DCHK)$/ ) {
1951 my $payinfo = $self->payinfo;
1952 $payinfo =~ s/[^\d\@\.]//g;
1953 if ( $conf->config('echeck-country') eq 'CA' ) {
1954 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1955 or return 'invalid echeck account@branch.bank';
1956 $payinfo = "$1\@$2.$3";
1957 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1958 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1959 $payinfo = "$1\@$2";
1961 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1962 $payinfo = "$1\@$2";
1964 $self->payinfo($payinfo);
1967 unless ( $ignore_banned_card ) {
1968 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1970 if ( $ban->bantype eq 'warn' ) {
1971 #or others depending on value of $ban->reason ?
1972 return '_duplicate_ach' unless $self->override_ban_warn;
1974 return 'Banned ACH account: banned on '.
1975 time2str('%a %h %o at %r', $ban->_date).
1976 ' by '. $ban->otaker.
1977 ' (ban# '. $ban->bannum. ')';
1982 } elsif ( $self->payby eq 'LECB' ) {
1984 my $payinfo = $self->payinfo;
1985 $payinfo =~ s/\D//g;
1986 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1988 $self->payinfo($payinfo);
1991 } elsif ( $self->payby eq 'BILL' ) {
1993 $error = $self->ut_textn('payinfo');
1994 return "Illegal P.O. number: ". $self->payinfo if $error;
1997 } elsif ( $self->payby eq 'COMP' ) {
1999 my $curuser = $FS::CurrentUser::CurrentUser;
2000 if ( ! $self->custnum
2001 && ! $curuser->access_right('Complimentary customer')
2004 return "You are not permitted to create complimentary accounts."
2007 $error = $self->ut_textn('payinfo');
2008 return "Illegal comp account issuer: ". $self->payinfo if $error;
2011 } elsif ( $self->payby eq 'PREPAY' ) {
2013 my $payinfo = $self->payinfo;
2014 $payinfo =~ s/\W//g; #anything else would just confuse things
2015 $self->payinfo($payinfo);
2016 $error = $self->ut_alpha('payinfo');
2017 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2018 return "Unknown prepayment identifier"
2019 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2024 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2025 return "Expiration date required"
2026 # shouldn't payinfo_check do this?
2027 unless ! $self->payby
2028 || $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2032 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2033 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2034 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2035 ( $m, $y ) = ( $2, "19$1" );
2036 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2037 ( $m, $y ) = ( $3, "20$2" );
2039 return "Illegal expiration date: ". $self->paydate;
2041 $m = sprintf('%02d',$m);
2042 $self->paydate("$y-$m-01");
2043 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2044 return gettext('expired_card')
2046 && !$ignore_expired_card
2047 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2050 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2051 ( ! $conf->exists('require_cardname')
2052 || $self->payby !~ /^(CARD|DCRD)$/ )
2054 $self->payname( $self->first. " ". $self->getfield('last') );
2057 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2058 $self->payname =~ /^([\w \,\.\-\']*)$/
2059 or return gettext('illegal_name'). " payname: ". $self->payname;
2062 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2063 or return gettext('illegal_name'). " payname: ". $self->payname;
2069 ### end of stuff moved to cust_payby
2071 return "Please select an invoicing locale"
2074 && $conf->exists('cust_main-require_locale');
2076 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2077 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2081 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2083 warn "$me check AFTER: \n". $self->_dump
2086 $self->SUPER::check;
2091 Returns a list of fields which have ship_ duplicates.
2096 qw( last first company
2098 address1 address2 city county state zip country
2100 daytime night fax mobile
2104 =item has_ship_address
2106 Returns true if this customer record has a separate shipping address.
2110 sub has_ship_address {
2112 $self->bill_locationnum != $self->ship_locationnum;
2117 Returns a list of key/value pairs, with the following keys: address1,
2118 adddress2, city, county, state, zip, country, district, and geocode. The
2119 shipping address is used if present.
2125 $self->ship_location->location_hash;
2130 Returns all locations (see L<FS::cust_location>) for this customer.
2136 qsearch('cust_location', { 'custnum' => $self->custnum,
2137 'prospectnum' => '' } );
2142 Returns all contacts (see L<FS::contact>) for this customer.
2146 #already used :/ sub contact {
2149 qsearch('contact', { 'custnum' => $self->custnum } );
2154 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2161 'table' => 'cust_payby',
2162 'hashref' => { 'custnum' => $self->custnum },
2163 'order_by' => 'ORDER BY weight ASC',
2169 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2170 and L<FS::cust_pkg>) for this customer, except those on hold.
2172 Returns a list: an empty list on success or a list of errors.
2178 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2183 Unsuspends all suspended packages in the on-hold state (those without setup
2184 dates) for this customer.
2190 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2195 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2197 Returns a list: an empty list on success or a list of errors.
2203 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2206 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2208 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2209 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2210 of a list of pkgparts; the hashref has the following keys:
2214 =item pkgparts - listref of pkgparts
2216 =item (other options are passed to the suspend method)
2221 Returns a list: an empty list on success or a list of errors.
2225 sub suspend_if_pkgpart {
2227 my (@pkgparts, %opt);
2228 if (ref($_[0]) eq 'HASH'){
2229 @pkgparts = @{$_[0]{pkgparts}};
2234 grep { $_->suspend(%opt) }
2235 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2236 $self->unsuspended_pkgs;
2239 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2241 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2242 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2243 instead of a list of pkgparts; the hashref has the following keys:
2247 =item pkgparts - listref of pkgparts
2249 =item (other options are passed to the suspend method)
2253 Returns a list: an empty list on success or a list of errors.
2257 sub suspend_unless_pkgpart {
2259 my (@pkgparts, %opt);
2260 if (ref($_[0]) eq 'HASH'){
2261 @pkgparts = @{$_[0]{pkgparts}};
2266 grep { $_->suspend(%opt) }
2267 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2268 $self->unsuspended_pkgs;
2271 =item cancel [ OPTION => VALUE ... ]
2273 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2275 Available options are:
2279 =item quiet - can be set true to supress email cancellation notices.
2281 =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.
2283 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2285 =item nobill - can be set true to skip billing if it might otherwise be done.
2289 Always returns a list: an empty list on success or a list of errors.
2293 # nb that dates are not specified as valid options to this method
2296 my( $self, %opt ) = @_;
2298 warn "$me cancel called on customer ". $self->custnum. " with options ".
2299 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2302 return ( 'access denied' )
2303 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2305 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2307 #should try decryption (we might have the private key)
2308 # and if not maybe queue a job for the server that does?
2309 return ( "Can't (yet) ban encrypted credit cards" )
2310 if $self->is_encrypted($self->payinfo);
2312 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2313 my $error = $ban->insert;
2314 return ( $error ) if $error;
2318 my @pkgs = $self->ncancelled_pkgs;
2320 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2322 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2323 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2327 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2328 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2331 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2334 sub _banned_pay_hashref {
2345 'payby' => $payby2ban{$self->payby},
2346 'payinfo' => $self->payinfo,
2347 #don't ever *search* on reason! #'reason' =>
2351 sub _new_banned_pay_hashref {
2353 my $hr = $self->_banned_pay_hashref;
2354 $hr->{payinfo} = md5_base64($hr->{payinfo});
2360 Returns all notes (see L<FS::cust_main_note>) for this customer.
2365 my($self,$orderby_classnum) = (shift,shift);
2366 my $orderby = "_DATE DESC";
2367 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2368 qsearch( 'cust_main_note',
2369 { 'custnum' => $self->custnum },
2371 "ORDER BY $orderby",
2377 Returns the agent (see L<FS::agent>) for this customer.
2381 Returns the agent name (see L<FS::agent>) for this customer.
2387 $self->agent->agent;
2392 Returns any tags associated with this customer, as FS::cust_tag objects,
2393 or an empty list if there are no tags.
2397 Returns any tags associated with this customer, as FS::part_tag objects,
2398 or an empty list if there are no tags.
2404 map $_->part_tag, $self->cust_tag;
2410 Returns the customer class, as an FS::cust_class object, or the empty string
2411 if there is no customer class.
2415 Returns the customer category name, or the empty string if there is no customer
2422 my $cust_class = $self->cust_class;
2424 ? $cust_class->categoryname
2430 Returns the customer class name, or the empty string if there is no customer
2437 my $cust_class = $self->cust_class;
2439 ? $cust_class->classname
2445 Returns the external tax status, as an FS::tax_status object, or the empty
2446 string if there is no tax status.
2452 if ( $self->taxstatusnum ) {
2453 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2461 Returns the tax status code if there is one.
2467 my $tax_status = $self->tax_status;
2469 ? $tax_status->taxstatus
2473 =item BILLING METHODS
2475 Documentation on billing methods has been moved to
2476 L<FS::cust_main::Billing>.
2478 =item REALTIME BILLING METHODS
2480 Documentation on realtime billing methods has been moved to
2481 L<FS::cust_main::Billing_Realtime>.
2485 Removes the I<paycvv> field from the database directly.
2487 If there is an error, returns the error, otherwise returns false.
2493 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2494 or return dbh->errstr;
2495 $sth->execute($self->custnum)
2496 or return $sth->errstr;
2501 =item batch_card OPTION => VALUE...
2503 Adds a payment for this invoice to the pending credit card batch (see
2504 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2505 runs the payment using a realtime gateway.
2507 Options may include:
2509 B<amount>: the amount to be paid; defaults to the customer's balance minus
2510 any payments in transit.
2512 B<payby>: the payment method; defaults to cust_main.payby
2514 B<realtime>: runs this as a realtime payment instead of adding it to a
2517 B<invnum>: sets cust_pay_batch.invnum.
2519 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2520 the billing address for the payment; defaults to the customer's billing
2523 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2524 date, and name; defaults to those fields in cust_main.
2529 my ($self, %options) = @_;
2532 if (exists($options{amount})) {
2533 $amount = $options{amount};
2535 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2537 return '' unless $amount > 0;
2539 my $invnum = delete $options{invnum};
2540 my $payby = $options{payby} || $self->payby; #still dubious
2542 if ($options{'realtime'}) {
2543 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2549 my $oldAutoCommit = $FS::UID::AutoCommit;
2550 local $FS::UID::AutoCommit = 0;
2553 #this needs to handle mysql as well as Pg, like svc_acct.pm
2554 #(make it into a common function if folks need to do batching with mysql)
2555 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2556 or return "Cannot lock pay_batch: " . $dbh->errstr;
2560 'payby' => FS::payby->payby2payment($payby),
2562 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2564 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2566 unless ( $pay_batch ) {
2567 $pay_batch = new FS::pay_batch \%pay_batch;
2568 my $error = $pay_batch->insert;
2570 $dbh->rollback if $oldAutoCommit;
2571 die "error creating new batch: $error\n";
2575 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2576 'batchnum' => $pay_batch->batchnum,
2577 'custnum' => $self->custnum,
2580 foreach (qw( address1 address2 city state zip country latitude longitude
2581 payby payinfo paydate payname ))
2583 $options{$_} = '' unless exists($options{$_});
2586 my $loc = $self->bill_location;
2588 my $cust_pay_batch = new FS::cust_pay_batch ( {
2589 'batchnum' => $pay_batch->batchnum,
2590 'invnum' => $invnum || 0, # is there a better value?
2591 # this field should be
2593 # cust_bill_pay_batch now
2594 'custnum' => $self->custnum,
2595 'last' => $self->getfield('last'),
2596 'first' => $self->getfield('first'),
2597 'address1' => $options{address1} || $loc->address1,
2598 'address2' => $options{address2} || $loc->address2,
2599 'city' => $options{city} || $loc->city,
2600 'state' => $options{state} || $loc->state,
2601 'zip' => $options{zip} || $loc->zip,
2602 'country' => $options{country} || $loc->country,
2603 'payby' => $options{payby} || $self->payby,
2604 'payinfo' => $options{payinfo} || $self->payinfo,
2605 'exp' => $options{paydate} || $self->paydate,
2606 'payname' => $options{payname} || $self->payname,
2607 'amount' => $amount, # consolidating
2610 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2611 if $old_cust_pay_batch;
2614 if ($old_cust_pay_batch) {
2615 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2617 $error = $cust_pay_batch->insert;
2621 $dbh->rollback if $oldAutoCommit;
2625 my $unapplied = $self->total_unapplied_credits
2626 + $self->total_unapplied_payments
2627 + $self->in_transit_payments;
2628 foreach my $cust_bill ($self->open_cust_bill) {
2629 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2630 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2631 'invnum' => $cust_bill->invnum,
2632 'paybatchnum' => $cust_pay_batch->paybatchnum,
2633 'amount' => $cust_bill->owed,
2636 if ($unapplied >= $cust_bill_pay_batch->amount){
2637 $unapplied -= $cust_bill_pay_batch->amount;
2640 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2641 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2643 $error = $cust_bill_pay_batch->insert;
2645 $dbh->rollback if $oldAutoCommit;
2650 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2656 Returns the total owed for this customer on all invoices
2657 (see L<FS::cust_bill/owed>).
2663 $self->total_owed_date(2145859200); #12/31/2037
2666 =item total_owed_date TIME
2668 Returns the total owed for this customer on all invoices with date earlier than
2669 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2670 see L<Time::Local> and L<Date::Parse> for conversion functions.
2674 sub total_owed_date {
2678 my $custnum = $self->custnum;
2680 my $owed_sql = FS::cust_bill->owed_sql;
2683 SELECT SUM($owed_sql) FROM cust_bill
2684 WHERE custnum = $custnum
2688 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2692 =item total_owed_pkgnum PKGNUM
2694 Returns the total owed on all invoices for this customer's specific package
2695 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2699 sub total_owed_pkgnum {
2700 my( $self, $pkgnum ) = @_;
2701 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2704 =item total_owed_date_pkgnum TIME PKGNUM
2706 Returns the total owed for this customer's specific package when using
2707 experimental package balances on all invoices with date earlier than
2708 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2709 see L<Time::Local> and L<Date::Parse> for conversion functions.
2713 sub total_owed_date_pkgnum {
2714 my( $self, $time, $pkgnum ) = @_;
2717 foreach my $cust_bill (
2718 grep { $_->_date <= $time }
2719 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2721 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2723 sprintf( "%.2f", $total_bill );
2729 Returns the total amount of all payments.
2736 $total += $_->paid foreach $self->cust_pay;
2737 sprintf( "%.2f", $total );
2740 =item total_unapplied_credits
2742 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2743 customer. See L<FS::cust_credit/credited>.
2745 =item total_credited
2747 Old name for total_unapplied_credits. Don't use.
2751 sub total_credited {
2752 #carp "total_credited deprecated, use total_unapplied_credits";
2753 shift->total_unapplied_credits(@_);
2756 sub total_unapplied_credits {
2759 my $custnum = $self->custnum;
2761 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2764 SELECT SUM($unapplied_sql) FROM cust_credit
2765 WHERE custnum = $custnum
2768 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2772 =item total_unapplied_credits_pkgnum PKGNUM
2774 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2775 customer. See L<FS::cust_credit/credited>.
2779 sub total_unapplied_credits_pkgnum {
2780 my( $self, $pkgnum ) = @_;
2781 my $total_credit = 0;
2782 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2783 sprintf( "%.2f", $total_credit );
2787 =item total_unapplied_payments
2789 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2790 See L<FS::cust_pay/unapplied>.
2794 sub total_unapplied_payments {
2797 my $custnum = $self->custnum;
2799 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2802 SELECT SUM($unapplied_sql) FROM cust_pay
2803 WHERE custnum = $custnum
2806 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2810 =item total_unapplied_payments_pkgnum PKGNUM
2812 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2813 specific package when using experimental package balances. See
2814 L<FS::cust_pay/unapplied>.
2818 sub total_unapplied_payments_pkgnum {
2819 my( $self, $pkgnum ) = @_;
2820 my $total_unapplied = 0;
2821 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2822 sprintf( "%.2f", $total_unapplied );
2826 =item total_unapplied_refunds
2828 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2829 customer. See L<FS::cust_refund/unapplied>.
2833 sub total_unapplied_refunds {
2835 my $custnum = $self->custnum;
2837 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2840 SELECT SUM($unapplied_sql) FROM cust_refund
2841 WHERE custnum = $custnum
2844 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2850 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2851 total_unapplied_credits minus total_unapplied_payments).
2857 $self->balance_date_range;
2860 =item balance_date TIME
2862 Returns the balance for this customer, only considering invoices with date
2863 earlier than TIME (total_owed_date minus total_credited minus
2864 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2865 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2872 $self->balance_date_range(shift);
2875 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2877 Returns the balance for this customer, optionally considering invoices with
2878 date earlier than START_TIME, and not later than END_TIME
2879 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2881 Times are specified as SQL fragments or numeric
2882 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2883 L<Date::Parse> for conversion functions. The empty string can be passed
2884 to disable that time constraint completely.
2886 Accepts the same options as L<balance_date_sql>:
2890 =item unapplied_date
2892 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)
2896 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2897 time will be ignored. Note that START_TIME and END_TIME only limit the date
2898 range for invoices and I<unapplied> payments, credits, and refunds.
2904 sub balance_date_range {
2906 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2907 ') FROM cust_main WHERE custnum='. $self->custnum;
2908 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2911 =item balance_pkgnum PKGNUM
2913 Returns the balance for this customer's specific package when using
2914 experimental package balances (total_owed plus total_unrefunded, minus
2915 total_unapplied_credits minus total_unapplied_payments)
2919 sub balance_pkgnum {
2920 my( $self, $pkgnum ) = @_;
2923 $self->total_owed_pkgnum($pkgnum)
2924 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2925 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2926 - $self->total_unapplied_credits_pkgnum($pkgnum)
2927 - $self->total_unapplied_payments_pkgnum($pkgnum)
2931 =item in_transit_payments
2933 Returns the total of requests for payments for this customer pending in
2934 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2938 sub in_transit_payments {
2940 my $in_transit_payments = 0;
2941 foreach my $pay_batch ( qsearch('pay_batch', {
2944 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2945 'batchnum' => $pay_batch->batchnum,
2946 'custnum' => $self->custnum,
2948 $in_transit_payments += $cust_pay_batch->amount;
2951 sprintf( "%.2f", $in_transit_payments );
2956 Returns a hash of useful information for making a payment.
2966 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2967 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2968 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2972 For credit card transactions:
2984 For electronic check transactions:
2999 $return{balance} = $self->balance;
3001 $return{payname} = $self->payname
3002 || ( $self->first. ' '. $self->get('last') );
3004 $return{$_} = $self->bill_location->$_
3005 for qw(address1 address2 city state zip);
3007 $return{payby} = $self->payby;
3008 $return{stateid_state} = $self->stateid_state;
3010 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
3011 $return{card_type} = cardtype($self->payinfo);
3012 $return{payinfo} = $self->paymask;
3014 @return{'month', 'year'} = $self->paydate_monthyear;
3018 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
3019 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
3020 $return{payinfo1} = $payinfo1;
3021 $return{payinfo2} = $payinfo2;
3022 $return{paytype} = $self->paytype;
3023 $return{paystate} = $self->paystate;
3027 #doubleclick protection
3029 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3035 =item paydate_monthyear
3037 Returns a two-element list consisting of the month and year of this customer's
3038 paydate (credit card expiration date for CARD customers)
3042 sub paydate_monthyear {
3044 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3046 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3055 Returns the exact time in seconds corresponding to the payment method
3056 expiration date. For CARD/DCRD customers this is the end of the month;
3057 for others (COMP is the only other payby that uses paydate) it's the start.
3058 Returns 0 if the paydate is empty or set to the far future.
3064 my ($month, $year) = $self->paydate_monthyear;
3065 return 0 if !$year or $year >= 2037;
3066 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3068 if ( $month == 13 ) {
3072 return timelocal(0,0,0,1,$month-1,$year) - 1;
3075 return timelocal(0,0,0,1,$month-1,$year);
3079 =item paydate_epoch_sql
3081 Class method. Returns an SQL expression to obtain the payment expiration date
3082 as a number of seconds.
3086 # Special expiration date behavior for non-CARD/DCRD customers has been
3087 # carefully preserved. Do we really use that?
3088 sub paydate_epoch_sql {
3090 my $table = shift || 'cust_main';
3091 my ($case1, $case2);
3092 if ( driver_name eq 'Pg' ) {
3093 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3094 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3096 elsif ( lc(driver_name) eq 'mysql' ) {
3097 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3098 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3101 return "CASE WHEN $table.payby IN('CARD','DCRD')
3107 =item tax_exemption TAXNAME
3112 my( $self, $taxname ) = @_;
3114 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3115 'taxname' => $taxname,
3120 =item cust_main_exemption
3122 =item invoicing_list [ ARRAYREF ]
3124 If an arguement is given, sets these email addresses as invoice recipients
3125 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3126 (except as warnings), so use check_invoicing_list first.
3128 Returns a list of email addresses (with svcnum entries expanded).
3130 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3131 check it without disturbing anything by passing nothing.
3133 This interface may change in the future.
3137 sub invoicing_list {
3138 my( $self, $arrayref ) = @_;
3141 my @cust_main_invoice;
3142 if ( $self->custnum ) {
3143 @cust_main_invoice =
3144 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3146 @cust_main_invoice = ();
3148 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3149 #warn $cust_main_invoice->destnum;
3150 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3151 #warn $cust_main_invoice->destnum;
3152 my $error = $cust_main_invoice->delete;
3153 warn $error if $error;
3156 if ( $self->custnum ) {
3157 @cust_main_invoice =
3158 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3160 @cust_main_invoice = ();
3162 my %seen = map { $_->address => 1 } @cust_main_invoice;
3163 foreach my $address ( @{$arrayref} ) {
3164 next if exists $seen{$address} && $seen{$address};
3165 $seen{$address} = 1;
3166 my $cust_main_invoice = new FS::cust_main_invoice ( {
3167 'custnum' => $self->custnum,
3170 my $error = $cust_main_invoice->insert;
3171 warn $error if $error;
3175 if ( $self->custnum ) {
3177 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3184 =item check_invoicing_list ARRAYREF
3186 Checks these arguements as valid input for the invoicing_list method. If there
3187 is an error, returns the error, otherwise returns false.
3191 sub check_invoicing_list {
3192 my( $self, $arrayref ) = @_;
3194 foreach my $address ( @$arrayref ) {
3196 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3197 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3200 my $cust_main_invoice = new FS::cust_main_invoice ( {
3201 'custnum' => $self->custnum,
3204 my $error = $self->custnum
3205 ? $cust_main_invoice->check
3206 : $cust_main_invoice->checkdest
3208 return $error if $error;
3212 return "Email address required"
3213 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3214 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3219 =item set_default_invoicing_list
3221 Sets the invoicing list to all accounts associated with this customer,
3222 overwriting any previous invoicing list.
3226 sub set_default_invoicing_list {
3228 $self->invoicing_list($self->all_emails);
3233 Returns the email addresses of all accounts provisioned for this customer.
3240 foreach my $cust_pkg ( $self->all_pkgs ) {
3241 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3243 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3244 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3246 $list{$_}=1 foreach map { $_->email } @svc_acct;
3251 =item invoicing_list_addpost
3253 Adds postal invoicing to this customer. If this customer is already configured
3254 to receive postal invoices, does nothing.
3258 sub invoicing_list_addpost {
3260 return if grep { $_ eq 'POST' } $self->invoicing_list;
3261 my @invoicing_list = $self->invoicing_list;
3262 push @invoicing_list, 'POST';
3263 $self->invoicing_list(\@invoicing_list);
3266 =item invoicing_list_emailonly
3268 Returns the list of email invoice recipients (invoicing_list without non-email
3269 destinations such as POST and FAX).
3273 sub invoicing_list_emailonly {
3275 warn "$me invoicing_list_emailonly called"
3277 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3280 =item invoicing_list_emailonly_scalar
3282 Returns the list of email invoice recipients (invoicing_list without non-email
3283 destinations such as POST and FAX) as a comma-separated scalar.
3287 sub invoicing_list_emailonly_scalar {
3289 warn "$me invoicing_list_emailonly_scalar called"
3291 join(', ', $self->invoicing_list_emailonly);
3294 =item referral_custnum_cust_main
3296 Returns the customer who referred this customer (or the empty string, if
3297 this customer was not referred).
3299 Note the difference with referral_cust_main method: This method,
3300 referral_custnum_cust_main returns the single customer (if any) who referred
3301 this customer, while referral_cust_main returns an array of customers referred
3306 sub referral_custnum_cust_main {
3308 return '' unless $self->referral_custnum;
3309 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3312 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3314 Returns an array of customers referred by this customer (referral_custnum set
3315 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3316 customers referred by customers referred by this customer and so on, inclusive.
3317 The default behavior is DEPTH 1 (no recursion).
3319 Note the difference with referral_custnum_cust_main method: This method,
3320 referral_cust_main, returns an array of customers referred BY this customer,
3321 while referral_custnum_cust_main returns the single customer (if any) who
3322 referred this customer.
3326 sub referral_cust_main {
3328 my $depth = @_ ? shift : 1;
3329 my $exclude = @_ ? shift : {};
3332 map { $exclude->{$_->custnum}++; $_; }
3333 grep { ! $exclude->{ $_->custnum } }
3334 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3338 map { $_->referral_cust_main($depth-1, $exclude) }
3345 =item referral_cust_main_ncancelled
3347 Same as referral_cust_main, except only returns customers with uncancelled
3352 sub referral_cust_main_ncancelled {
3354 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3357 =item referral_cust_pkg [ DEPTH ]
3359 Like referral_cust_main, except returns a flat list of all unsuspended (and
3360 uncancelled) packages for each customer. The number of items in this list may
3361 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3365 sub referral_cust_pkg {
3367 my $depth = @_ ? shift : 1;
3369 map { $_->unsuspended_pkgs }
3370 grep { $_->unsuspended_pkgs }
3371 $self->referral_cust_main($depth);
3374 =item referring_cust_main
3376 Returns the single cust_main record for the customer who referred this customer
3377 (referral_custnum), or false.
3381 sub referring_cust_main {
3383 return '' unless $self->referral_custnum;
3384 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3387 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3389 Applies a credit to this customer. If there is an error, returns the error,
3390 otherwise returns false.
3392 REASON can be a text string, an FS::reason object, or a scalar reference to
3393 a reasonnum. If a text string, it will be automatically inserted as a new
3394 reason, and a 'reason_type' option must be passed to indicate the
3395 FS::reason_type for the new reason.
3397 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3398 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3399 I<commission_pkgnum>.
3401 Any other options are passed to FS::cust_credit::insert.
3406 my( $self, $amount, $reason, %options ) = @_;
3408 my $cust_credit = new FS::cust_credit {
3409 'custnum' => $self->custnum,
3410 'amount' => $amount,
3413 if ( ref($reason) ) {
3415 if ( ref($reason) eq 'SCALAR' ) {
3416 $cust_credit->reasonnum( $$reason );
3418 $cust_credit->reasonnum( $reason->reasonnum );
3422 $cust_credit->set('reason', $reason)
3425 $cust_credit->$_( delete $options{$_} )
3426 foreach grep exists($options{$_}),
3427 qw( addlinfo eventnum ),
3428 map "commission_$_", qw( agentnum salesnum pkgnum );
3430 $cust_credit->insert(%options);
3434 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3436 Creates a one-time charge for this customer. If there is an error, returns
3437 the error, otherwise returns false.
3439 New-style, with a hashref of options:
3441 my $error = $cust_main->charge(
3445 'start_date' => str2time('7/4/2009'),
3446 'pkg' => 'Description',
3447 'comment' => 'Comment',
3448 'additional' => [], #extra invoice detail
3449 'classnum' => 1, #pkg_class
3451 'setuptax' => '', # or 'Y' for tax exempt
3453 'locationnum'=> 1234, # optional
3456 'taxclass' => 'Tax class',
3459 'taxproduct' => 2, #part_pkg_taxproduct
3460 'override' => {}, #XXX describe
3462 #will be filled in with the new object
3463 'cust_pkg_ref' => \$cust_pkg,
3465 #generate an invoice immediately
3467 'invoice_terms' => '', #with these terms
3473 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3479 my ( $amount, $quantity, $start_date, $classnum );
3480 my ( $pkg, $comment, $additional );
3481 my ( $setuptax, $taxclass ); #internal taxes
3482 my ( $taxproduct, $override ); #vendor (CCH) taxes
3484 my $cust_pkg_ref = '';
3485 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3487 if ( ref( $_[0] ) ) {
3488 $amount = $_[0]->{amount};
3489 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3490 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3491 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3492 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3493 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3494 : '$'. sprintf("%.2f",$amount);
3495 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3496 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3497 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3498 $additional = $_[0]->{additional} || [];
3499 $taxproduct = $_[0]->{taxproductnum};
3500 $override = { '' => $_[0]->{tax_override} };
3501 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3502 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3503 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3504 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3509 $pkg = @_ ? shift : 'One-time charge';
3510 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3512 $taxclass = @_ ? shift : '';
3516 local $SIG{HUP} = 'IGNORE';
3517 local $SIG{INT} = 'IGNORE';
3518 local $SIG{QUIT} = 'IGNORE';
3519 local $SIG{TERM} = 'IGNORE';
3520 local $SIG{TSTP} = 'IGNORE';
3521 local $SIG{PIPE} = 'IGNORE';
3523 my $oldAutoCommit = $FS::UID::AutoCommit;
3524 local $FS::UID::AutoCommit = 0;
3527 my $part_pkg = new FS::part_pkg ( {
3529 'comment' => $comment,
3533 'classnum' => ( $classnum ? $classnum : '' ),
3534 'setuptax' => $setuptax,
3535 'taxclass' => $taxclass,
3536 'taxproductnum' => $taxproduct,
3539 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3540 ( 0 .. @$additional - 1 )
3542 'additional_count' => scalar(@$additional),
3543 'setup_fee' => $amount,
3546 my $error = $part_pkg->insert( options => \%options,
3547 tax_overrides => $override,
3550 $dbh->rollback if $oldAutoCommit;
3554 my $pkgpart = $part_pkg->pkgpart;
3555 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3556 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3557 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3558 $error = $type_pkgs->insert;
3560 $dbh->rollback if $oldAutoCommit;
3565 my $cust_pkg = new FS::cust_pkg ( {
3566 'custnum' => $self->custnum,
3567 'pkgpart' => $pkgpart,
3568 'quantity' => $quantity,
3569 'start_date' => $start_date,
3570 'no_auto' => $no_auto,
3571 'locationnum'=> $locationnum,
3574 $error = $cust_pkg->insert;
3576 $dbh->rollback if $oldAutoCommit;
3578 } elsif ( $cust_pkg_ref ) {
3579 ${$cust_pkg_ref} = $cust_pkg;
3583 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3584 'pkg_list' => [ $cust_pkg ],
3587 $dbh->rollback if $oldAutoCommit;
3592 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3597 #=item charge_postal_fee
3599 #Applies a one time charge this customer. If there is an error,
3600 #returns the error, returns the cust_pkg charge object or false
3601 #if there was no charge.
3605 # This should be a customer event. For that to work requires that bill
3606 # also be a customer event.
3608 sub charge_postal_fee {
3611 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3612 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3614 my $cust_pkg = new FS::cust_pkg ( {
3615 'custnum' => $self->custnum,
3616 'pkgpart' => $pkgpart,
3620 my $error = $cust_pkg->insert;
3621 $error ? $error : $cust_pkg;
3624 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3626 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3628 Optionally, a list or hashref of additional arguments to the qsearch call can
3635 my $opt = ref($_[0]) ? shift : { @_ };
3637 #return $self->num_cust_bill unless wantarray || keys %$opt;
3639 $opt->{'table'} = 'cust_bill';
3640 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3641 $opt->{'hashref'}{'custnum'} = $self->custnum;
3642 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3644 map { $_ } #behavior of sort undefined in scalar context
3645 sort { $a->_date <=> $b->_date }
3649 =item open_cust_bill
3651 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3656 sub open_cust_bill {
3660 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3666 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3668 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3672 sub legacy_cust_bill {
3675 #return $self->num_legacy_cust_bill unless wantarray;
3677 map { $_ } #behavior of sort undefined in scalar context
3678 sort { $a->_date <=> $b->_date }
3679 qsearch({ 'table' => 'legacy_cust_bill',
3680 'hashref' => { 'custnum' => $self->custnum, },
3681 'order_by' => 'ORDER BY _date ASC',
3685 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3687 Returns all the statements (see L<FS::cust_statement>) for this customer.
3689 Optionally, a list or hashref of additional arguments to the qsearch call can
3694 =item cust_bill_void
3696 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3700 sub cust_bill_void {
3703 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3704 sort { $a->_date <=> $b->_date }
3705 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3708 sub cust_statement {
3710 my $opt = ref($_[0]) ? shift : { @_ };
3712 #return $self->num_cust_statement unless wantarray || keys %$opt;
3714 $opt->{'table'} = 'cust_statement';
3715 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3716 $opt->{'hashref'}{'custnum'} = $self->custnum;
3717 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3719 map { $_ } #behavior of sort undefined in scalar context
3720 sort { $a->_date <=> $b->_date }
3724 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3726 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3728 Optionally, a list or hashref of additional arguments to the qsearch call can
3729 be passed following the SVCDB.
3736 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3737 warn "$me svc_x requires a svcdb";
3740 my $opt = ref($_[0]) ? shift : { @_ };
3742 $opt->{'table'} = $svcdb;
3743 $opt->{'addl_from'} =
3744 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3745 ($opt->{'addl_from'} || '');
3747 my $custnum = $self->custnum;
3748 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3749 my $where = "cust_pkg.custnum = $custnum";
3751 my $extra_sql = $opt->{'extra_sql'} || '';
3752 if ( keys %{ $opt->{'hashref'} } ) {
3753 $extra_sql = " AND $where $extra_sql";
3756 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3757 $extra_sql = "WHERE $where AND $1";
3760 $extra_sql = "WHERE $where $extra_sql";
3763 $opt->{'extra_sql'} = $extra_sql;
3768 # required for use as an eventtable;
3771 $self->svc_x('svc_acct', @_);
3776 Returns all the credits (see L<FS::cust_credit>) for this customer.
3782 map { $_ } #return $self->num_cust_credit unless wantarray;
3783 sort { $a->_date <=> $b->_date }
3784 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3787 =item cust_credit_pkgnum
3789 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3790 package when using experimental package balances.
3794 sub cust_credit_pkgnum {
3795 my( $self, $pkgnum ) = @_;
3796 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3797 sort { $a->_date <=> $b->_date }
3798 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3799 'pkgnum' => $pkgnum,
3804 =item cust_credit_void
3806 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3810 sub cust_credit_void {
3813 sort { $a->_date <=> $b->_date }
3814 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3819 Returns all the payments (see L<FS::cust_pay>) for this customer.
3825 my $opt = ref($_[0]) ? shift : { @_ };
3827 return $self->num_cust_pay unless wantarray || keys %$opt;
3829 $opt->{'table'} = 'cust_pay';
3830 $opt->{'hashref'}{'custnum'} = $self->custnum;
3832 map { $_ } #behavior of sort undefined in scalar context
3833 sort { $a->_date <=> $b->_date }
3840 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3841 called automatically when the cust_pay method is used in a scalar context.
3847 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3848 my $sth = dbh->prepare($sql) or die dbh->errstr;
3849 $sth->execute($self->custnum) or die $sth->errstr;
3850 $sth->fetchrow_arrayref->[0];
3853 =item unapplied_cust_pay
3855 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3859 sub unapplied_cust_pay {
3863 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3869 =item cust_pay_pkgnum
3871 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3872 package when using experimental package balances.
3876 sub cust_pay_pkgnum {
3877 my( $self, $pkgnum ) = @_;
3878 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3879 sort { $a->_date <=> $b->_date }
3880 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3881 'pkgnum' => $pkgnum,
3888 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3894 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3895 sort { $a->_date <=> $b->_date }
3896 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3899 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3901 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3903 Optionally, a list or hashref of additional arguments to the qsearch call can
3908 sub cust_pay_batch {
3910 my $opt = ref($_[0]) ? shift : { @_ };
3912 #return $self->num_cust_statement unless wantarray || keys %$opt;
3914 $opt->{'table'} = 'cust_pay_batch';
3915 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3916 $opt->{'hashref'}{'custnum'} = $self->custnum;
3917 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3919 map { $_ } #behavior of sort undefined in scalar context
3920 sort { $a->paybatchnum <=> $b->paybatchnum }
3924 =item cust_pay_pending
3926 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3927 (without status "done").
3931 sub cust_pay_pending {
3933 return $self->num_cust_pay_pending unless wantarray;
3934 sort { $a->_date <=> $b->_date }
3935 qsearch( 'cust_pay_pending', {
3936 'custnum' => $self->custnum,
3937 'status' => { op=>'!=', value=>'done' },
3942 =item cust_pay_pending_attempt
3944 Returns all payment attempts / declined payments for this customer, as pending
3945 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3946 a corresponding payment (see L<FS::cust_pay>).
3950 sub cust_pay_pending_attempt {
3952 return $self->num_cust_pay_pending_attempt unless wantarray;
3953 sort { $a->_date <=> $b->_date }
3954 qsearch( 'cust_pay_pending', {
3955 'custnum' => $self->custnum,
3962 =item num_cust_pay_pending
3964 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3965 customer (without status "done"). Also called automatically when the
3966 cust_pay_pending method is used in a scalar context.
3970 sub num_cust_pay_pending {
3973 " SELECT COUNT(*) FROM cust_pay_pending ".
3974 " WHERE custnum = ? AND status != 'done' ",
3979 =item num_cust_pay_pending_attempt
3981 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3982 customer, with status "done" but without a corresp. Also called automatically when the
3983 cust_pay_pending method is used in a scalar context.
3987 sub num_cust_pay_pending_attempt {
3990 " SELECT COUNT(*) FROM cust_pay_pending ".
3991 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3998 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4004 map { $_ } #return $self->num_cust_refund unless wantarray;
4005 sort { $a->_date <=> $b->_date }
4006 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4009 =item display_custnum
4011 Returns the displayed customer number for this customer: agent_custid if
4012 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
4016 sub display_custnum {
4019 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
4020 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
4021 if ( $special eq 'CoStAg' ) {
4022 $prefix = uc( join('',
4024 ($self->state =~ /^(..)/),
4025 $prefix || ($self->agent->agent =~ /^(..)/)
4028 elsif ( $special eq 'CoStCl' ) {
4029 $prefix = uc( join('',
4031 ($self->state =~ /^(..)/),
4032 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
4035 # add any others here if needed
4038 my $length = $conf->config('cust_main-custnum-display_length');
4039 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
4040 return $self->agent_custid;
4041 } elsif ( $prefix ) {
4042 $length = 8 if !defined($length);
4044 sprintf('%0'.$length.'d', $self->custnum)
4045 } elsif ( $length ) {
4046 return sprintf('%0'.$length.'d', $self->custnum);
4048 return $self->custnum;
4054 Returns a name string for this customer, either "Company (Last, First)" or
4061 my $name = $self->contact;
4062 $name = $self->company. " ($name)" if $self->company;
4066 =item service_contact
4068 Returns the L<FS::contact> object for this customer that has the 'Service'
4069 contact class, or undef if there is no such contact. Deprecated; don't use
4074 sub service_contact {
4076 if ( !exists($self->{service_contact}) ) {
4077 my $classnum = $self->scalar_sql(
4078 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4079 ) || 0; #if it's zero, qsearchs will return nothing
4080 $self->{service_contact} = qsearchs('contact', {
4081 'classnum' => $classnum, 'custnum' => $self->custnum
4084 $self->{service_contact};
4089 Returns a name string for this (service/shipping) contact, either
4090 "Company (Last, First)" or "Last, First".
4097 my $name = $self->ship_contact;
4098 $name = $self->company. " ($name)" if $self->company;
4104 Returns a name string for this customer, either "Company" or "First Last".
4110 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4113 =item ship_name_short
4115 Returns a name string for this (service/shipping) contact, either "Company"
4120 sub ship_name_short {
4122 $self->service_contact
4123 ? $self->ship_contact_firstlast
4129 Returns this customer's full (billing) contact name only, "Last, First"
4135 $self->get('last'). ', '. $self->first;
4140 Returns this customer's full (shipping) contact name only, "Last, First"
4146 my $contact = $self->service_contact || $self;
4147 $contact->get('last') . ', ' . $contact->get('first');
4150 =item contact_firstlast
4152 Returns this customers full (billing) contact name only, "First Last".
4156 sub contact_firstlast {
4158 $self->first. ' '. $self->get('last');
4161 =item ship_contact_firstlast
4163 Returns this customer's full (shipping) contact name only, "First Last".
4167 sub ship_contact_firstlast {
4169 my $contact = $self->service_contact || $self;
4170 $contact->get('first') . ' '. $contact->get('last');
4173 #XXX this doesn't work in 3.x+
4176 #Returns this customer's full country name
4182 # code2country($self->country);
4185 sub bill_country_full {
4187 code2country($self->bill_location->country);
4190 sub ship_country_full {
4192 code2country($self->ship_location->country);
4195 =item county_state_county [ PREFIX ]
4197 Returns a string consisting of just the county, state and country.
4201 sub county_state_country {
4204 if ( @_ && $_[0] && $self->has_ship_address ) {
4205 $locationnum = $self->ship_locationnum;
4207 $locationnum = $self->bill_locationnum;
4209 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4210 $cust_location->county_state_country;
4213 =item geocode DATA_VENDOR
4215 Returns a value for the customer location as encoded by DATA_VENDOR.
4216 Currently this only makes sense for "CCH" as DATA_VENDOR.
4224 Returns a status string for this customer, currently:
4230 No packages have ever been ordered. Displayed as "No packages".
4234 Recurring packages all are new (not yet billed).
4238 One or more recurring packages is active.
4242 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
4246 All non-cancelled recurring packages are suspended.
4250 All recurring packages are cancelled.
4254 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4255 cust_main-status_module configuration option.
4259 sub status { shift->cust_status(@_); }
4263 for my $status ( FS::cust_main->statuses() ) {
4264 my $method = $status.'_sql';
4265 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4266 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4267 $sth->execute( ($self->custnum) x $numnum )
4268 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4269 return $status if $sth->fetchrow_arrayref->[0];
4273 =item ucfirst_cust_status
4275 =item ucfirst_status
4277 Deprecated, use the cust_status_label method instead.
4279 Returns the status with the first character capitalized.
4283 sub ucfirst_status {
4284 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4285 local($ucfirst_nowarn) = 1;
4286 shift->ucfirst_cust_status(@_);
4289 sub ucfirst_cust_status {
4290 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4292 ucfirst($self->cust_status);
4295 =item cust_status_label
4299 Returns the display label for this status.
4303 sub status_label { shift->cust_status_label(@_); }
4305 sub cust_status_label {
4307 __PACKAGE__->statuslabels->{$self->cust_status};
4312 Returns a hex triplet color string for this customer's status.
4316 sub statuscolor { shift->cust_statuscolor(@_); }
4318 sub cust_statuscolor {
4320 __PACKAGE__->statuscolors->{$self->cust_status};
4323 =item tickets [ STATUS ]
4325 Returns an array of hashes representing the customer's RT tickets.
4327 An optional status (or arrayref or hashref of statuses) may be specified.
4333 my $status = ( @_ && $_[0] ) ? shift : '';
4335 my $num = $conf->config('cust_main-max_tickets') || 10;
4338 if ( $conf->config('ticket_system') ) {
4339 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4341 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4350 foreach my $priority (
4351 $conf->config('ticket_system-custom_priority_field-values'), ''
4353 last if scalar(@tickets) >= $num;
4355 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4356 $num - scalar(@tickets),
4367 # Return services representing svc_accts in customer support packages
4368 sub support_services {
4370 my %packages = map { $_ => 1 } $conf->config('support_packages');
4372 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4373 grep { $_->part_svc->svcdb eq 'svc_acct' }
4374 map { $_->cust_svc }
4375 grep { exists $packages{ $_->pkgpart } }
4376 $self->ncancelled_pkgs;
4380 # Return a list of latitude/longitude for one of the services (if any)
4381 sub service_coordinates {
4385 grep { $_->latitude && $_->longitude }
4387 map { $_->cust_svc }
4388 $self->ncancelled_pkgs;
4390 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4395 Returns a masked version of the named field
4400 my ($self,$field) = @_;
4404 'x'x(length($self->getfield($field))-4).
4405 substr($self->getfield($field), (length($self->getfield($field))-4));
4411 =head1 CLASS METHODS
4417 Class method that returns the list of possible status strings for customers
4418 (see L<the status method|/status>). For example:
4420 @statuses = FS::cust_main->statuses();
4426 keys %{ $self->statuscolors };
4429 =item cust_status_sql
4431 Returns an SQL fragment to determine the status of a cust_main record, as a
4436 sub cust_status_sql {
4438 for my $status ( FS::cust_main->statuses() ) {
4439 my $method = $status.'_sql';
4440 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4449 Returns an SQL expression identifying prospective cust_main records (customers
4450 with no packages ever ordered)
4454 use vars qw($select_count_pkgs);
4455 $select_count_pkgs =
4456 "SELECT COUNT(*) FROM cust_pkg
4457 WHERE cust_pkg.custnum = cust_main.custnum";
4459 sub select_count_pkgs_sql {
4464 " 0 = ( $select_count_pkgs ) ";
4469 Returns an SQL expression identifying ordered cust_main records (customers with
4470 no active packages, but recurring packages not yet setup or one time charges
4476 FS::cust_main->none_active_sql.
4477 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4482 Returns an SQL expression identifying active cust_main records (customers with
4483 active recurring packages).
4488 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4491 =item none_active_sql
4493 Returns an SQL expression identifying cust_main records with no active
4494 recurring packages. This includes customers of status prospect, ordered,
4495 inactive, and suspended.
4499 sub none_active_sql {
4500 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4505 Returns an SQL expression identifying inactive cust_main records (customers with
4506 no active recurring packages, but otherwise unsuspended/uncancelled).
4511 FS::cust_main->none_active_sql.
4512 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4518 Returns an SQL expression identifying suspended cust_main records.
4523 sub suspended_sql { susp_sql(@_); }
4525 FS::cust_main->none_active_sql.
4526 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4532 Returns an SQL expression identifying cancelled cust_main records.
4536 sub cancel_sql { shift->cancelled_sql(@_); }
4539 =item uncancelled_sql
4541 Returns an SQL expression identifying un-cancelled cust_main records.
4545 sub uncancelled_sql { uncancel_sql(@_); }
4546 sub uncancel_sql { "
4547 ( 0 < ( $select_count_pkgs
4548 AND ( cust_pkg.cancel IS NULL
4549 OR cust_pkg.cancel = 0
4552 OR 0 = ( $select_count_pkgs )
4558 Returns an SQL fragment to retreive the balance.
4563 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4564 WHERE cust_bill.custnum = cust_main.custnum )
4565 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4566 WHERE cust_pay.custnum = cust_main.custnum )
4567 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4568 WHERE cust_credit.custnum = cust_main.custnum )
4569 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4570 WHERE cust_refund.custnum = cust_main.custnum )
4573 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4575 Returns an SQL fragment to retreive the balance for this customer, optionally
4576 considering invoices with date earlier than START_TIME, and not
4577 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4578 total_unapplied_payments).
4580 Times are specified as SQL fragments or numeric
4581 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4582 L<Date::Parse> for conversion functions. The empty string can be passed
4583 to disable that time constraint completely.
4585 Available options are:
4589 =item unapplied_date
4591 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)
4596 set to true to remove all customer comparison clauses, for totals
4601 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4606 JOIN clause (typically used with the total option)
4610 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4611 time will be ignored. Note that START_TIME and END_TIME only limit the date
4612 range for invoices and I<unapplied> payments, credits, and refunds.
4618 sub balance_date_sql {
4619 my( $class, $start, $end, %opt ) = @_;
4621 my $cutoff = $opt{'cutoff'};
4623 my $owed = FS::cust_bill->owed_sql($cutoff);
4624 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4625 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4626 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4628 my $j = $opt{'join'} || '';
4630 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4631 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4632 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4633 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4635 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4636 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4637 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4638 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4643 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4645 Returns an SQL fragment to retreive the total unapplied payments for this
4646 customer, only considering payments with date earlier than START_TIME, and
4647 optionally not later than END_TIME.
4649 Times are specified as SQL fragments or numeric
4650 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4651 L<Date::Parse> for conversion functions. The empty string can be passed
4652 to disable that time constraint completely.
4654 Available options are:
4658 sub unapplied_payments_date_sql {
4659 my( $class, $start, $end, %opt ) = @_;
4661 my $cutoff = $opt{'cutoff'};
4663 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4665 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4666 'unapplied_date'=>1 );
4668 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4671 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4673 Helper method for balance_date_sql; name (and usage) subject to change
4674 (suggestions welcome).
4676 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4677 cust_refund, cust_credit or cust_pay).
4679 If TABLE is "cust_bill" or the unapplied_date option is true, only
4680 considers records with date earlier than START_TIME, and optionally not
4681 later than END_TIME .
4685 sub _money_table_where {
4686 my( $class, $table, $start, $end, %opt ) = @_;
4689 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4690 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4691 push @where, "$table._date <= $start" if defined($start) && length($start);
4692 push @where, "$table._date > $end" if defined($end) && length($end);
4694 push @where, @{$opt{'where'}} if $opt{'where'};
4695 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4701 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4702 use FS::cust_main::Search;
4705 FS::cust_main::Search->search(@_);
4714 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4716 Deprecated. Use event notification and message templates
4717 (L<FS::msg_template>) instead.
4719 Sends a templated email notification to the customer (see L<Text::Template>).
4721 OPTIONS is a hash and may include
4723 I<from> - the email sender (default is invoice_from)
4725 I<to> - comma-separated scalar or arrayref of recipients
4726 (default is invoicing_list)
4728 I<subject> - The subject line of the sent email notification
4729 (default is "Notice from company_name")
4731 I<extra_fields> - a hashref of name/value pairs which will be substituted
4734 The following variables are vavailable in the template.
4736 I<$first> - the customer first name
4737 I<$last> - the customer last name
4738 I<$company> - the customer company
4739 I<$payby> - a description of the method of payment for the customer
4740 # would be nice to use FS::payby::shortname
4741 I<$payinfo> - the account information used to collect for this customer
4742 I<$expdate> - the expiration of the customer payment in seconds from epoch
4747 my ($self, $template, %options) = @_;
4749 return unless $conf->exists($template);
4751 my $from = $conf->config('invoice_from', $self->agentnum)
4752 if $conf->exists('invoice_from', $self->agentnum);
4753 $from = $options{from} if exists($options{from});
4755 my $to = join(',', $self->invoicing_list_emailonly);
4756 $to = $options{to} if exists($options{to});
4758 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4759 if $conf->exists('company_name', $self->agentnum);
4760 $subject = $options{subject} if exists($options{subject});
4762 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4763 SOURCE => [ map "$_\n",
4764 $conf->config($template)]
4766 or die "can't create new Text::Template object: Text::Template::ERROR";
4767 $notify_template->compile()
4768 or die "can't compile template: Text::Template::ERROR";
4770 $FS::notify_template::_template::company_name =
4771 $conf->config('company_name', $self->agentnum);
4772 $FS::notify_template::_template::company_address =
4773 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4775 my $paydate = $self->paydate || '2037-12-31';
4776 $FS::notify_template::_template::first = $self->first;
4777 $FS::notify_template::_template::last = $self->last;
4778 $FS::notify_template::_template::company = $self->company;
4779 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4780 my $payby = $self->payby;
4781 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4782 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4784 #credit cards expire at the end of the month/year of their exp date
4785 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4786 $FS::notify_template::_template::payby = 'credit card';
4787 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4788 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4790 }elsif ($payby eq 'COMP') {
4791 $FS::notify_template::_template::payby = 'complimentary account';
4793 $FS::notify_template::_template::payby = 'current method';
4795 $FS::notify_template::_template::expdate = $expire_time;
4797 for (keys %{$options{extra_fields}}){
4799 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4802 send_email(from => $from,
4804 subject => $subject,
4805 body => $notify_template->fill_in( PACKAGE =>
4806 'FS::notify_template::_template' ),
4811 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4813 Generates a templated notification to the customer (see L<Text::Template>).
4815 OPTIONS is a hash and may include
4817 I<extra_fields> - a hashref of name/value pairs which will be substituted
4818 into the template. These values may override values mentioned below
4819 and those from the customer record.
4821 The following variables are available in the template instead of or in addition
4822 to the fields of the customer record.
4824 I<$payby> - a description of the method of payment for the customer
4825 # would be nice to use FS::payby::shortname
4826 I<$payinfo> - the masked account information used to collect for this customer
4827 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4828 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4832 # a lot like cust_bill::print_latex
4833 sub generate_letter {
4834 my ($self, $template, %options) = @_;
4836 return unless $conf->exists($template);
4838 my $letter_template = new Text::Template
4840 SOURCE => [ map "$_\n", $conf->config($template)],
4841 DELIMITERS => [ '[@--', '--@]' ],
4843 or die "can't create new Text::Template object: Text::Template::ERROR";
4845 $letter_template->compile()
4846 or die "can't compile template: Text::Template::ERROR";
4848 my %letter_data = map { $_ => $self->$_ } $self->fields;
4849 $letter_data{payinfo} = $self->mask_payinfo;
4851 #my $paydate = $self->paydate || '2037-12-31';
4852 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4854 my $payby = $self->payby;
4855 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4856 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4858 #credit cards expire at the end of the month/year of their exp date
4859 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4860 $letter_data{payby} = 'credit card';
4861 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4862 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4864 }elsif ($payby eq 'COMP') {
4865 $letter_data{payby} = 'complimentary account';
4867 $letter_data{payby} = 'current method';
4869 $letter_data{expdate} = $expire_time;
4871 for (keys %{$options{extra_fields}}){
4872 $letter_data{$_} = $options{extra_fields}->{$_};
4875 unless(exists($letter_data{returnaddress})){
4876 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4877 $self->agent_template)
4879 if ( length($retadd) ) {
4880 $letter_data{returnaddress} = $retadd;
4881 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4882 $letter_data{returnaddress} =
4883 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4887 ( $conf->config('company_name', $self->agentnum),
4888 $conf->config('company_address', $self->agentnum),
4892 $letter_data{returnaddress} = '~';
4896 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4898 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4900 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4902 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4906 ) or die "can't open temp file: $!\n";
4907 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4908 or die "can't write temp file: $!\n";
4910 $letter_data{'logo_file'} = $lh->filename;
4912 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4916 ) or die "can't open temp file: $!\n";
4918 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4920 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4921 return ($1, $letter_data{'logo_file'});
4925 =item print_ps TEMPLATE
4927 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4933 my($file, $lfile) = $self->generate_letter(@_);
4934 my $ps = FS::Misc::generate_ps($file);
4935 unlink($file.'.tex');
4941 =item print TEMPLATE
4943 Prints the filled in template.
4945 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4949 sub queueable_print {
4952 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4953 or die "invalid customer number: " . $opt{custnum};
4955 my $error = $self->print( { 'template' => $opt{template} } );
4956 die $error if $error;
4960 my ($self, $template) = (shift, shift);
4962 [ $self->print_ps($template) ],
4963 'agentnum' => $self->agentnum,
4967 #these three subs should just go away once agent stuff is all config overrides
4969 sub agent_template {
4971 $self->_agent_plandata('agent_templatename');
4974 sub agent_invoice_from {
4976 $self->_agent_plandata('agent_invoice_from');
4979 sub _agent_plandata {
4980 my( $self, $option ) = @_;
4982 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4983 #agent-specific Conf
4985 use FS::part_event::Condition;
4987 my $agentnum = $self->agentnum;
4989 my $regexp = regexp_sql();
4991 my $part_event_option =
4993 'select' => 'part_event_option.*',
4994 'table' => 'part_event_option',
4996 LEFT JOIN part_event USING ( eventpart )
4997 LEFT JOIN part_event_option AS peo_agentnum
4998 ON ( part_event.eventpart = peo_agentnum.eventpart
4999 AND peo_agentnum.optionname = 'agentnum'
5000 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5002 LEFT JOIN part_event_condition
5003 ON ( part_event.eventpart = part_event_condition.eventpart
5004 AND part_event_condition.conditionname = 'cust_bill_age'
5006 LEFT JOIN part_event_condition_option
5007 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5008 AND part_event_condition_option.optionname = 'age'
5011 #'hashref' => { 'optionname' => $option },
5012 #'hashref' => { 'part_event_option.optionname' => $option },
5014 " WHERE part_event_option.optionname = ". dbh->quote($option).
5015 " AND action = 'cust_bill_send_agent' ".
5016 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5017 " AND peo_agentnum.optionname = 'agentnum' ".
5018 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5020 CASE WHEN part_event_condition_option.optionname IS NULL
5022 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5024 , part_event.weight".
5028 unless ( $part_event_option ) {
5029 return $self->agent->invoice_template || ''
5030 if $option eq 'agent_templatename';
5034 $part_event_option->optionvalue;
5038 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5040 Subroutine (not a method), designed to be called from the queue.
5042 Takes a list of options and values.
5044 Pulls up the customer record via the custnum option and calls bill_and_collect.
5049 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5051 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5052 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5054 #without this errors don't get rolled back
5055 $args{'fatal'} = 1; # runs from job queue, will be caught
5057 $cust_main->bill_and_collect( %args );
5060 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5062 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5063 C<collect> part. This is used in batch tax calculation, where invoice
5064 generation and collection events have to be completely separated.
5068 sub queued_collect {
5070 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5072 $cust_main->collect(%args);
5075 sub process_bill_and_collect {
5078 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5079 or die "custnum '$param->{custnum}' not found!\n";
5080 $param->{'job'} = $job;
5081 $param->{'fatal'} = 1; # runs from job queue, will be caught
5082 $param->{'retry'} = 1;
5084 $cust_main->bill_and_collect( %$param );
5087 #starting to take quite a while for big dbs
5088 # (JRNL: journaled so it only happens once per database)
5089 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5090 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5091 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5092 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5093 # JRNL leading/trailing spaces in first, last, company
5094 # JRNL migrate to cust_payby
5095 # - otaker upgrade? journal and call it good? (double check to make sure
5096 # we're not still setting otaker here)
5098 #only going to get worse with new location stuff...
5100 sub _upgrade_data { #class method
5101 my ($class, %opts) = @_;
5104 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5107 #this seems to be the only expensive one.. why does it take so long?
5108 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5110 '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';
5111 FS::upgrade_journal->set_done('cust_main__signupdate');
5114 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5116 # fix yyyy-m-dd formatted paydates
5117 if ( driver_name =~ /^mysql/i ) {
5119 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5120 } else { # the SQL standard
5122 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5124 FS::upgrade_journal->set_done('cust_main__paydate');
5127 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5129 push @statements, #fix the weird BILL with a cc# in payinfo problem
5131 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5133 FS::upgrade_journal->set_done('cust_main__payinfo');
5138 foreach my $sql ( @statements ) {
5139 my $sth = dbh->prepare($sql) or die dbh->errstr;
5140 $sth->execute or die $sth->errstr;
5141 #warn ( (time - $t). " seconds\n" );
5145 local($ignore_expired_card) = 1;
5146 local($ignore_banned_card) = 1;
5147 local($skip_fuzzyfiles) = 1;
5148 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5150 FS::cust_main::Location->_upgrade_data(%opts);
5152 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5154 foreach my $cust_main ( qsearch({
5155 'table' => 'cust_main',
5157 'extra_sql' => 'WHERE '.
5159 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5160 qw( first last company )
5163 my $error = $cust_main->replace;
5164 die $error if $error;
5167 FS::upgrade_journal->set_done('cust_main__trimspaces');
5171 unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5173 #we don't want to decrypt them, just stuff them as-is into cust_payby
5174 local(@encrypted_fields) = ();
5176 local($FS::cust_payby::ignore_expired_card) = 1;
5177 local($FS::cust_payby::ignore_banned_card) = 1;
5179 my @payfields = qw( payby payinfo paycvv paymask
5180 paydate paystart_month paystart_year payissue
5181 payname paystate paytype payip
5184 my $search = new FS::Cursor {
5185 'table' => 'cust_main',
5186 'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5189 while (my $cust_main = $search->fetch) {
5191 my $cust_payby = new FS::cust_payby {
5192 'custnum' => $cust_main->custnum,
5194 map { $_ => $cust_main->$_(); } @payfields
5197 my $error = $cust_payby->insert;
5198 die $error if $error;
5200 $cust_main->setfield($_, '') foreach @payfields;
5201 $error = $cust_main->replace;
5202 die $error if $error;
5206 FS::upgrade_journal->set_done('cust_main__cust_payby');
5209 $class->_upgrade_otaker(%opts);
5219 The delete method should possibly take an FS::cust_main object reference
5220 instead of a scalar customer number.
5222 Bill and collect options should probably be passed as references instead of a
5225 There should probably be a configuration file with a list of allowed credit
5228 No multiple currency support (probably a larger project than just this module).
5230 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5232 Birthdates rely on negative epoch values.
5234 The payby for card/check batches is broken. With mixed batching, bad
5237 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5241 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5242 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5243 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.