5 use base qw( FS::cust_main::Packages FS::cust_main::Status
6 FS::cust_main::NationalID
7 FS::cust_main::Billing FS::cust_main::Billing_Realtime
8 FS::cust_main::Billing_Discount
9 FS::cust_main::Billing_ThirdParty
10 FS::cust_main::Location
11 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
17 use vars qw( $DEBUG $me $conf
20 $ignore_expired_card $ignore_banned_card $ignore_illegal_zip
25 use Scalar::Util qw( blessed );
26 use Time::Local qw(timelocal);
27 use Storable qw(thaw);
31 use Digest::MD5 qw(md5_base64);
34 use File::Temp; #qw( tempfile );
35 use Business::CreditCard 0.28;
37 use FS::UID qw( getotaker dbh driver_name );
38 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
39 use FS::Misc qw( generate_email send_email generate_ps do_print );
40 use FS::Msgcat qw(gettext);
47 use FS::cust_bill_void;
48 use FS::legacy_cust_bill;
50 use FS::cust_pay_pending;
51 use FS::cust_pay_void;
52 use FS::cust_pay_batch;
55 use FS::part_referral;
56 use FS::cust_main_county;
57 use FS::cust_location;
59 use FS::cust_main_exemption;
60 use FS::cust_tax_adjustment;
61 use FS::cust_tax_location;
63 use FS::cust_main_invoice;
65 use FS::prepay_credit;
71 use FS::payment_gateway;
72 use FS::agent_payment_gateway;
74 use FS::cust_main_note;
75 use FS::cust_attachment;
78 use FS::upgrade_journal;
80 # 1 is mostly method/subroutine entry and options
81 # 2 traces progress of some operations
82 # 3 is even more information including possibly sensitive data
84 $me = '[FS::cust_main]';
87 $ignore_expired_card = 0;
88 $ignore_banned_card = 0;
92 @encrypted_fields = ('payinfo', 'paycvv');
93 sub nohistory_fields { ('payinfo', 'paycvv'); }
95 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
97 #ask FS::UID to run this stuff for us later
98 #$FS::UID::callback{'FS::cust_main'} = sub {
99 install_callback FS::UID sub {
100 $conf = new FS::Conf;
101 #yes, need it for stuff below (prolly should be cached)
106 my ( $hashref, $cache ) = @_;
107 if ( exists $hashref->{'pkgnum'} ) {
108 #@{ $self->{'_pkgnum'} } = ();
109 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
110 $self->{'_pkgnum'} = $subcache;
111 #push @{ $self->{'_pkgnum'} },
112 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
118 FS::cust_main - Object methods for cust_main records
124 $record = new FS::cust_main \%hash;
125 $record = new FS::cust_main { 'column' => 'value' };
127 $error = $record->insert;
129 $error = $new_record->replace($old_record);
131 $error = $record->delete;
133 $error = $record->check;
135 @cust_pkg = $record->all_pkgs;
137 @cust_pkg = $record->ncancelled_pkgs;
139 @cust_pkg = $record->suspended_pkgs;
141 $error = $record->bill;
142 $error = $record->bill %options;
143 $error = $record->bill 'time' => $time;
145 $error = $record->collect;
146 $error = $record->collect %options;
147 $error = $record->collect 'invoice_time' => $time,
152 An FS::cust_main object represents a customer. FS::cust_main inherits from
153 FS::Record. The following fields are currently supported:
159 Primary key (assigned automatically for new customers)
163 Agent (see L<FS::agent>)
167 Advertising source (see L<FS::part_referral>)
179 Cocial security number (optional)
203 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
207 Payment Information (See L<FS::payinfo_Mixin> for data format)
211 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
215 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
219 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
223 Start date month (maestro/solo cards only)
227 Start date year (maestro/solo cards only)
231 Issue number (maestro/solo cards only)
235 Name on card or billing name
239 IP address from which payment information was received
243 Tax exempt, empty or `Y'
247 Order taker (see L<FS::access_user>)
253 =item referral_custnum
255 Referring customer number
259 Enable individual CDR spooling, empty or `Y'
263 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
267 Discourage individual CDR printing, empty or `Y'
271 Allow self-service editing of ticket subjects, empty or 'Y'
273 =item calling_list_exempt
275 Do not call, empty or 'Y'
285 Creates a new customer. To add the customer to the database, see L<"insert">.
287 Note that this stores the hash reference, not a distinct copy of the hash it
288 points to. You can ask the object for a copy with the I<hash> method.
292 sub table { 'cust_main'; }
294 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
296 Adds this customer to the database. If there is an error, returns the error,
297 otherwise returns false.
299 Usually the customer's location will not yet exist in the database, and
300 the C<bill_location> and C<ship_location> pseudo-fields must be set to
301 uninserted L<FS::cust_location> objects. These will be inserted and linked
302 (in both directions) to the new customer record. If they're references
303 to the same object, they will become the same location.
305 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
306 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
307 are inserted atomicly, or the transaction is rolled back. Passing an empty
308 hash reference is equivalent to not supplying this parameter. There should be
309 a better explanation of this, but until then, here's an example:
312 tie %hash, 'Tie::RefHash'; #this part is important
314 $cust_pkg => [ $svc_acct ],
317 $cust_main->insert( \%hash );
319 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
320 be set as the invoicing list (see L<"invoicing_list">). Errors return as
321 expected and rollback the entire transaction; it is not necessary to call
322 check_invoicing_list first. The invoicing_list is set after the records in the
323 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
324 invoicing_list destination to the newly-created svc_acct. Here's an example:
326 $cust_main->insert( {}, [ $email, 'POST' ] );
328 Currently available options are: I<depend_jobnum>, I<noexport>,
329 I<tax_exemption> and I<prospectnum>.
331 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
332 on the supplied jobnum (they will not run until the specific job completes).
333 This can be used to defer provisioning until some action completes (such
334 as running the customer's credit card successfully).
336 The I<noexport> option is deprecated. If I<noexport> is set true, no
337 provisioning jobs (exports) are scheduled. (You can schedule them later with
338 the B<reexport> method.)
340 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
341 of tax names and exemption numbers. FS::cust_main_exemption records will be
342 created and inserted.
344 If I<prospectnum> is set, moves contacts and locations from that prospect.
350 my $cust_pkgs = @_ ? shift : {};
351 my $invoicing_list = @_ ? shift : '';
353 warn "$me insert called with options ".
354 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
357 local $SIG{HUP} = 'IGNORE';
358 local $SIG{INT} = 'IGNORE';
359 local $SIG{QUIT} = 'IGNORE';
360 local $SIG{TERM} = 'IGNORE';
361 local $SIG{TSTP} = 'IGNORE';
362 local $SIG{PIPE} = 'IGNORE';
364 my $oldAutoCommit = $FS::UID::AutoCommit;
365 local $FS::UID::AutoCommit = 0;
368 my $prepay_identifier = '';
369 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
371 if ( $self->payby eq 'PREPAY' ) {
373 $self->payby('BILL');
374 $prepay_identifier = $self->payinfo;
377 warn " looking up prepaid card $prepay_identifier\n"
380 my $error = $self->get_prepay( $prepay_identifier,
381 'amount_ref' => \$amount,
382 'seconds_ref' => \$seconds,
383 'upbytes_ref' => \$upbytes,
384 'downbytes_ref' => \$downbytes,
385 'totalbytes_ref' => \$totalbytes,
388 $dbh->rollback if $oldAutoCommit;
389 #return "error applying prepaid card (transaction rolled back): $error";
393 $payby = 'PREP' if $amount;
395 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|PPAL)$/ ) {
398 $self->payby('BILL');
399 $amount = $self->paid;
404 foreach my $l (qw(bill_location ship_location)) {
406 my $loc = delete $self->hashref->{$l} or return "$l not set";
408 if ( !$loc->locationnum ) {
409 # warn the location that we're going to insert it with no custnum
410 $loc->set(custnum_pending => 1);
411 warn " inserting $l\n"
413 my $error = $loc->insert;
415 $dbh->rollback if $oldAutoCommit;
416 my $label = $l eq 'ship_location' ? 'service' : 'billing';
417 return "$error (in $label location)";
420 } elsif ( $loc->prospectnum ) {
422 $loc->prospectnum('');
423 $loc->set(custnum_pending => 1);
424 my $error = $loc->replace;
426 $dbh->rollback if $oldAutoCommit;
427 my $label = $l eq 'ship_location' ? 'service' : 'billing';
428 return "$error (moving $label location)";
431 } elsif ( ($loc->custnum || 0) > 0 ) {
432 # then it somehow belongs to another customer--shouldn't happen
433 $dbh->rollback if $oldAutoCommit;
434 return "$l belongs to customer ".$loc->custnum;
436 # else it already belongs to this customer
437 # (happens when ship_location is identical to bill_location)
439 $self->set($l.'num', $loc->locationnum);
441 if ( $self->get($l.'num') eq '' ) {
442 $dbh->rollback if $oldAutoCommit;
447 warn " inserting $self\n"
450 $self->signupdate(time) unless $self->signupdate;
452 $self->auto_agent_custid()
453 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
455 my $error = $self->SUPER::insert;
457 $dbh->rollback if $oldAutoCommit;
458 #return "inserting cust_main record (transaction rolled back): $error";
462 # now set cust_location.custnum
463 foreach my $l (qw(bill_location ship_location)) {
464 warn " setting $l.custnum\n"
467 unless ( $loc->custnum ) {
468 $loc->set(custnum => $self->custnum);
469 $error ||= $loc->replace;
473 $dbh->rollback if $oldAutoCommit;
474 return "error setting $l custnum: $error";
478 warn " setting invoicing list\n"
481 if ( $invoicing_list ) {
482 $error = $self->check_invoicing_list( $invoicing_list );
484 $dbh->rollback if $oldAutoCommit;
485 #return "checking invoicing_list (transaction rolled back): $error";
488 $self->invoicing_list( $invoicing_list );
491 warn " setting customer tags\n"
494 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
495 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
496 'custnum' => $self->custnum };
497 my $error = $cust_tag->insert;
499 $dbh->rollback if $oldAutoCommit;
504 my $prospectnum = delete $options{'prospectnum'};
505 if ( $prospectnum ) {
507 warn " moving contacts and locations from prospect $prospectnum\n"
511 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
512 unless ( $prospect_main ) {
513 $dbh->rollback if $oldAutoCommit;
514 return "Unknown prospectnum $prospectnum";
516 $prospect_main->custnum($self->custnum);
517 $prospect_main->disabled('Y');
518 my $error = $prospect_main->replace;
520 $dbh->rollback if $oldAutoCommit;
524 my @contact = $prospect_main->contact;
525 my @cust_location = $prospect_main->cust_location;
526 my @qual = $prospect_main->qual;
528 foreach my $r ( @contact, @cust_location, @qual ) {
530 $r->custnum($self->custnum);
531 my $error = $r->replace;
533 $dbh->rollback if $oldAutoCommit;
540 warn " setting cust_main_exemption\n"
543 my $tax_exemption = delete $options{'tax_exemption'};
544 if ( $tax_exemption ) {
546 $tax_exemption = { map { $_ => '' } @$tax_exemption }
547 if ref($tax_exemption) eq 'ARRAY';
549 foreach my $taxname ( keys %$tax_exemption ) {
550 my $cust_main_exemption = new FS::cust_main_exemption {
551 'custnum' => $self->custnum,
552 'taxname' => $taxname,
553 'exempt_number' => $tax_exemption->{$taxname},
555 my $error = $cust_main_exemption->insert;
557 $dbh->rollback if $oldAutoCommit;
558 return "inserting cust_main_exemption (transaction rolled back): $error";
563 warn " ordering packages\n"
566 $error = $self->order_pkgs( $cust_pkgs,
568 'seconds_ref' => \$seconds,
569 'upbytes_ref' => \$upbytes,
570 'downbytes_ref' => \$downbytes,
571 'totalbytes_ref' => \$totalbytes,
574 $dbh->rollback if $oldAutoCommit;
579 $dbh->rollback if $oldAutoCommit;
580 return "No svc_acct record to apply pre-paid time";
582 if ( $upbytes || $downbytes || $totalbytes ) {
583 $dbh->rollback if $oldAutoCommit;
584 return "No svc_acct record to apply pre-paid data";
588 warn " inserting initial $payby payment of $amount\n"
590 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
592 $dbh->rollback if $oldAutoCommit;
593 return "inserting payment (transaction rolled back): $error";
597 unless ( $import || $skip_fuzzyfiles ) {
598 warn " queueing fuzzyfiles update\n"
600 $error = $self->queue_fuzzyfiles_update;
602 $dbh->rollback if $oldAutoCommit;
603 return "updating fuzzy search cache: $error";
607 # FS::geocode_Mixin::after_insert or something?
608 if ( $conf->config('tax_district_method') and !$import ) {
609 # if anything non-empty, try to look it up
610 my $queue = new FS::queue {
611 'job' => 'FS::geocode_Mixin::process_district_update',
612 'custnum' => $self->custnum,
614 my $error = $queue->insert( ref($self), $self->custnum );
616 $dbh->rollback if $oldAutoCommit;
617 return "queueing tax district update: $error";
622 warn " exporting\n" if $DEBUG > 1;
624 my $export_args = $options{'export_args'} || [];
627 map qsearch( 'part_export', {exportnum=>$_} ),
628 $conf->config('cust_main-exports'); #, $agentnum
630 foreach my $part_export ( @part_export ) {
631 my $error = $part_export->export_insert($self, @$export_args);
633 $dbh->rollback if $oldAutoCommit;
634 return "exporting to ". $part_export->exporttype.
635 " (transaction rolled back): $error";
639 #foreach my $depend_jobnum ( @$depend_jobnums ) {
640 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
642 # foreach my $jobnum ( @jobnums ) {
643 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
644 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
646 # my $error = $queue->depend_insert($depend_jobnum);
648 # $dbh->rollback if $oldAutoCommit;
649 # return "error queuing job dependancy: $error";
656 #if ( exists $options{'jobnums'} ) {
657 # push @{ $options{'jobnums'} }, @jobnums;
660 warn " insert complete; committing transaction\n"
663 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
668 use File::CounterFile;
669 sub auto_agent_custid {
672 my $format = $conf->config('cust_main-auto_agent_custid');
674 if ( $format eq '1YMMXXXXXXXX' ) {
676 my $counter = new File::CounterFile 'cust_main.agent_custid';
679 my $ym = 100000000000 + time2str('%y%m00000000', time);
680 if ( $ym > $counter->value ) {
681 $counter->{'value'} = $agent_custid = $ym;
682 $counter->{'updated'} = 1;
684 $agent_custid = $counter->inc;
690 die "Unknown cust_main-auto_agent_custid format: $format";
693 $self->agent_custid($agent_custid);
697 =item PACKAGE METHODS
699 Documentation on customer package methods has been moved to
700 L<FS::cust_main::Packages>.
702 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
704 Recharges this (existing) customer with the specified prepaid card (see
705 L<FS::prepay_credit>), specified either by I<identifier> or as an
706 FS::prepay_credit object. If there is an error, returns the error, otherwise
709 Optionally, five scalar references can be passed as well. They will have their
710 values filled in with the amount, number of seconds, and number of upload,
711 download, and total bytes applied by this prepaid card.
715 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
716 #the only place that uses these args
717 sub recharge_prepay {
718 my( $self, $prepay_credit, $amountref, $secondsref,
719 $upbytesref, $downbytesref, $totalbytesref ) = @_;
721 local $SIG{HUP} = 'IGNORE';
722 local $SIG{INT} = 'IGNORE';
723 local $SIG{QUIT} = 'IGNORE';
724 local $SIG{TERM} = 'IGNORE';
725 local $SIG{TSTP} = 'IGNORE';
726 local $SIG{PIPE} = 'IGNORE';
728 my $oldAutoCommit = $FS::UID::AutoCommit;
729 local $FS::UID::AutoCommit = 0;
732 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
734 my $error = $self->get_prepay( $prepay_credit,
735 'amount_ref' => \$amount,
736 'seconds_ref' => \$seconds,
737 'upbytes_ref' => \$upbytes,
738 'downbytes_ref' => \$downbytes,
739 'totalbytes_ref' => \$totalbytes,
741 || $self->increment_seconds($seconds)
742 || $self->increment_upbytes($upbytes)
743 || $self->increment_downbytes($downbytes)
744 || $self->increment_totalbytes($totalbytes)
745 || $self->insert_cust_pay_prepay( $amount,
747 ? $prepay_credit->identifier
752 $dbh->rollback if $oldAutoCommit;
756 if ( defined($amountref) ) { $$amountref = $amount; }
757 if ( defined($secondsref) ) { $$secondsref = $seconds; }
758 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
759 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
760 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
762 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
767 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
769 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
770 specified either by I<identifier> or as an FS::prepay_credit object.
772 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
773 incremented by the values of the prepaid card.
775 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
776 check or set this customer's I<agentnum>.
778 If there is an error, returns the error, otherwise returns false.
784 my( $self, $prepay_credit, %opt ) = @_;
786 local $SIG{HUP} = 'IGNORE';
787 local $SIG{INT} = 'IGNORE';
788 local $SIG{QUIT} = 'IGNORE';
789 local $SIG{TERM} = 'IGNORE';
790 local $SIG{TSTP} = 'IGNORE';
791 local $SIG{PIPE} = 'IGNORE';
793 my $oldAutoCommit = $FS::UID::AutoCommit;
794 local $FS::UID::AutoCommit = 0;
797 unless ( ref($prepay_credit) ) {
799 my $identifier = $prepay_credit;
801 $prepay_credit = qsearchs(
803 { 'identifier' => $identifier },
808 unless ( $prepay_credit ) {
809 $dbh->rollback if $oldAutoCommit;
810 return "Invalid prepaid card: ". $identifier;
815 if ( $prepay_credit->agentnum ) {
816 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
817 $dbh->rollback if $oldAutoCommit;
818 return "prepaid card not valid for agent ". $self->agentnum;
820 $self->agentnum($prepay_credit->agentnum);
823 my $error = $prepay_credit->delete;
825 $dbh->rollback if $oldAutoCommit;
826 return "removing prepay_credit (transaction rolled back): $error";
829 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
830 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
832 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
837 =item increment_upbytes SECONDS
839 Updates this customer's single or primary account (see L<FS::svc_acct>) by
840 the specified number of upbytes. If there is an error, returns the error,
841 otherwise returns false.
845 sub increment_upbytes {
846 _increment_column( shift, 'upbytes', @_);
849 =item increment_downbytes SECONDS
851 Updates this customer's single or primary account (see L<FS::svc_acct>) by
852 the specified number of downbytes. If there is an error, returns the error,
853 otherwise returns false.
857 sub increment_downbytes {
858 _increment_column( shift, 'downbytes', @_);
861 =item increment_totalbytes SECONDS
863 Updates this customer's single or primary account (see L<FS::svc_acct>) by
864 the specified number of totalbytes. If there is an error, returns the error,
865 otherwise returns false.
869 sub increment_totalbytes {
870 _increment_column( shift, 'totalbytes', @_);
873 =item increment_seconds SECONDS
875 Updates this customer's single or primary account (see L<FS::svc_acct>) by
876 the specified number of seconds. If there is an error, returns the error,
877 otherwise returns false.
881 sub increment_seconds {
882 _increment_column( shift, 'seconds', @_);
885 =item _increment_column AMOUNT
887 Updates this customer's single or primary account (see L<FS::svc_acct>) by
888 the specified number of seconds or bytes. If there is an error, returns
889 the error, otherwise returns false.
893 sub _increment_column {
894 my( $self, $column, $amount ) = @_;
895 warn "$me increment_column called: $column, $amount\n"
898 return '' unless $amount;
900 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
901 $self->ncancelled_pkgs;
904 return 'No packages with primary or single services found'.
905 ' to apply pre-paid time';
906 } elsif ( scalar(@cust_pkg) > 1 ) {
907 #maybe have a way to specify the package/account?
908 return 'Multiple packages found to apply pre-paid time';
911 my $cust_pkg = $cust_pkg[0];
912 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
916 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
919 return 'No account found to apply pre-paid time';
920 } elsif ( scalar(@cust_svc) > 1 ) {
921 return 'Multiple accounts found to apply pre-paid time';
924 my $svc_acct = $cust_svc[0]->svc_x;
925 warn " found service svcnum ". $svc_acct->pkgnum.
926 ' ('. $svc_acct->email. ")\n"
929 $column = "increment_$column";
930 $svc_acct->$column($amount);
934 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
936 Inserts a prepayment in the specified amount for this customer. An optional
937 second argument can specify the prepayment identifier for tracking purposes.
938 If there is an error, returns the error, otherwise returns false.
942 sub insert_cust_pay_prepay {
943 shift->insert_cust_pay('PREP', @_);
946 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
948 Inserts a cash payment in the specified amount for this customer. An optional
949 second argument can specify the payment identifier for tracking purposes.
950 If there is an error, returns the error, otherwise returns false.
954 sub insert_cust_pay_cash {
955 shift->insert_cust_pay('CASH', @_);
958 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
960 Inserts a Western Union payment in the specified amount for this customer. An
961 optional second argument can specify the prepayment identifier for tracking
962 purposes. If there is an error, returns the error, otherwise returns false.
966 sub insert_cust_pay_west {
967 shift->insert_cust_pay('WEST', @_);
970 sub insert_cust_pay {
971 my( $self, $payby, $amount ) = splice(@_, 0, 3);
972 my $payinfo = scalar(@_) ? shift : '';
974 my $cust_pay = new FS::cust_pay {
975 'custnum' => $self->custnum,
976 'paid' => sprintf('%.2f', $amount),
977 #'_date' => #date the prepaid card was purchased???
979 'payinfo' => $payinfo,
987 This method is deprecated. See the I<depend_jobnum> option to the insert and
988 order_pkgs methods for a better way to defer provisioning.
990 Re-schedules all exports by calling the B<reexport> method of all associated
991 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
992 otherwise returns false.
999 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1000 "use the depend_jobnum option to insert or order_pkgs to delay export";
1002 local $SIG{HUP} = 'IGNORE';
1003 local $SIG{INT} = 'IGNORE';
1004 local $SIG{QUIT} = 'IGNORE';
1005 local $SIG{TERM} = 'IGNORE';
1006 local $SIG{TSTP} = 'IGNORE';
1007 local $SIG{PIPE} = 'IGNORE';
1009 my $oldAutoCommit = $FS::UID::AutoCommit;
1010 local $FS::UID::AutoCommit = 0;
1013 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1014 my $error = $cust_pkg->reexport;
1016 $dbh->rollback if $oldAutoCommit;
1021 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1026 =item delete [ OPTION => VALUE ... ]
1028 This deletes the customer. If there is an error, returns the error, otherwise
1031 This will completely remove all traces of the customer record. This is not
1032 what you want when a customer cancels service; for that, cancel all of the
1033 customer's packages (see L</cancel>).
1035 If the customer has any uncancelled packages, you need to pass a new (valid)
1036 customer number for those packages to be transferred to, as the "new_customer"
1037 option. Cancelled packages will be deleted. Did I mention that this is NOT
1038 what you want when a customer cancels service and that you really should be
1039 looking at L<FS::cust_pkg/cancel>?
1041 You can't delete a customer with invoices (see L<FS::cust_bill>),
1042 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1043 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1044 set the "delete_financials" option to a true value.
1049 my( $self, %opt ) = @_;
1051 local $SIG{HUP} = 'IGNORE';
1052 local $SIG{INT} = 'IGNORE';
1053 local $SIG{QUIT} = 'IGNORE';
1054 local $SIG{TERM} = 'IGNORE';
1055 local $SIG{TSTP} = 'IGNORE';
1056 local $SIG{PIPE} = 'IGNORE';
1058 my $oldAutoCommit = $FS::UID::AutoCommit;
1059 local $FS::UID::AutoCommit = 0;
1062 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1063 $dbh->rollback if $oldAutoCommit;
1064 return "Can't delete a master agent customer";
1067 #use FS::access_user
1068 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1069 $dbh->rollback if $oldAutoCommit;
1070 return "Can't delete a master employee customer";
1073 tie my %financial_tables, 'Tie::IxHash',
1074 'cust_bill' => 'invoices',
1075 'cust_statement' => 'statements',
1076 'cust_credit' => 'credits',
1077 'cust_pay' => 'payments',
1078 'cust_refund' => 'refunds',
1081 foreach my $table ( keys %financial_tables ) {
1083 my @records = $self->$table();
1085 if ( @records && ! $opt{'delete_financials'} ) {
1086 $dbh->rollback if $oldAutoCommit;
1087 return "Can't delete a customer with ". $financial_tables{$table};
1090 foreach my $record ( @records ) {
1091 my $error = $record->delete;
1093 $dbh->rollback if $oldAutoCommit;
1094 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1100 my @cust_pkg = $self->ncancelled_pkgs;
1102 my $new_custnum = $opt{'new_custnum'};
1103 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1104 $dbh->rollback if $oldAutoCommit;
1105 return "Invalid new customer number: $new_custnum";
1107 foreach my $cust_pkg ( @cust_pkg ) {
1108 my %hash = $cust_pkg->hash;
1109 $hash{'custnum'} = $new_custnum;
1110 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1111 my $error = $new_cust_pkg->replace($cust_pkg,
1112 options => { $cust_pkg->options },
1115 $dbh->rollback if $oldAutoCommit;
1120 my @cancelled_cust_pkg = $self->all_pkgs;
1121 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1122 my $error = $cust_pkg->delete;
1124 $dbh->rollback if $oldAutoCommit;
1129 #cust_tax_adjustment in financials?
1130 #cust_pay_pending? ouch
1132 foreach my $table (qw(
1133 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1134 cust_location cust_main_note cust_tax_adjustment
1135 cust_pay_void cust_pay_batch queue cust_tax_exempt
1137 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1138 my $error = $record->delete;
1140 $dbh->rollback if $oldAutoCommit;
1146 my $sth = $dbh->prepare(
1147 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1149 my $errstr = $dbh->errstr;
1150 $dbh->rollback if $oldAutoCommit;
1153 $sth->execute($self->custnum) or do {
1154 my $errstr = $sth->errstr;
1155 $dbh->rollback if $oldAutoCommit;
1161 my $ticket_dbh = '';
1162 if ($conf->config('ticket_system') eq 'RT_Internal') {
1164 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1165 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1166 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1167 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1170 if ( $ticket_dbh ) {
1172 my $ticket_sth = $ticket_dbh->prepare(
1173 'DELETE FROM Links WHERE Target = ?'
1175 my $errstr = $ticket_dbh->errstr;
1176 $dbh->rollback if $oldAutoCommit;
1179 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1181 my $errstr = $ticket_sth->errstr;
1182 $dbh->rollback if $oldAutoCommit;
1186 #check and see if the customer is the only link on the ticket, and
1187 #if so, set the ticket to deleted status in RT?
1188 #maybe someday, for now this will at least fix tickets not displaying
1192 #delete the customer record
1194 my $error = $self->SUPER::delete;
1196 $dbh->rollback if $oldAutoCommit;
1200 # cust_main exports!
1202 #my $export_args = $options{'export_args'} || [];
1205 map qsearch( 'part_export', {exportnum=>$_} ),
1206 $conf->config('cust_main-exports'); #, $agentnum
1208 foreach my $part_export ( @part_export ) {
1209 my $error = $part_export->export_delete( $self ); #, @$export_args);
1211 $dbh->rollback if $oldAutoCommit;
1212 return "exporting to ". $part_export->exporttype.
1213 " (transaction rolled back): $error";
1217 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1222 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1224 This merges this customer into the provided new custnum, and then deletes the
1225 customer. If there is an error, returns the error, otherwise returns false.
1227 The source customer's name, company name, phone numbers, agent,
1228 referring customer, customer class, advertising source, order taker, and
1229 billing information (except balance) are discarded.
1231 All packages are moved to the target customer. Packages with package locations
1232 are preserved. Packages without package locations are moved to a new package
1233 location with the source customer's service/shipping address.
1235 All invoices, statements, payments, credits and refunds are moved to the target
1236 customer. The source customer's balance is added to the target customer.
1238 All notes, attachments, tickets and customer tags are moved to the target
1241 Change history is not currently moved.
1246 my( $self, $new_custnum, %opt ) = @_;
1248 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1250 my $new_cust_main = qsearchs( 'cust_main', { 'custnum' => $new_custnum } )
1251 or return "Invalid new customer number: $new_custnum";
1253 return 'Access denied: "Merge customer across agents" access right required to merge into a customer of a different agent'
1254 if $self->agentnum != $new_cust_main->agentnum
1255 && ! $FS::CurrentUser::CurrentUser->access_right('Merge customer across agents');
1257 local $SIG{HUP} = 'IGNORE';
1258 local $SIG{INT} = 'IGNORE';
1259 local $SIG{QUIT} = 'IGNORE';
1260 local $SIG{TERM} = 'IGNORE';
1261 local $SIG{TSTP} = 'IGNORE';
1262 local $SIG{PIPE} = 'IGNORE';
1264 my $oldAutoCommit = $FS::UID::AutoCommit;
1265 local $FS::UID::AutoCommit = 0;
1268 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1269 $dbh->rollback if $oldAutoCommit;
1270 return "Can't merge a master agent customer";
1273 #use FS::access_user
1274 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1275 $dbh->rollback if $oldAutoCommit;
1276 return "Can't merge a master employee customer";
1279 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1280 'status' => { op=>'!=', value=>'done' },
1284 $dbh->rollback if $oldAutoCommit;
1285 return "Can't merge a customer with pending payments";
1288 tie my %financial_tables, 'Tie::IxHash',
1289 'cust_bill' => 'invoices',
1290 'cust_bill_void' => 'voided invoices',
1291 'cust_statement' => 'statements',
1292 'cust_credit' => 'credits',
1293 'cust_credit_void' => 'voided credits',
1294 'cust_pay' => 'payments',
1295 'cust_pay_void' => 'voided payments',
1296 'cust_refund' => 'refunds',
1299 foreach my $table ( keys %financial_tables ) {
1301 my @records = $self->$table();
1303 foreach my $record ( @records ) {
1304 $record->custnum($new_custnum);
1305 my $error = $record->replace;
1307 $dbh->rollback if $oldAutoCommit;
1308 return "Error merging ". $financial_tables{$table}. ": $error\n";
1314 my $name = $self->ship_name; #?
1316 my $locationnum = '';
1317 foreach my $cust_pkg ( $self->all_pkgs ) {
1318 $cust_pkg->custnum($new_custnum);
1320 unless ( $cust_pkg->locationnum ) {
1321 unless ( $locationnum ) {
1322 my $cust_location = new FS::cust_location {
1323 $self->location_hash,
1324 'custnum' => $new_custnum,
1326 my $error = $cust_location->insert;
1328 $dbh->rollback if $oldAutoCommit;
1331 $locationnum = $cust_location->locationnum;
1333 $cust_pkg->locationnum($locationnum);
1336 my $error = $cust_pkg->replace;
1338 $dbh->rollback if $oldAutoCommit;
1342 # add customer (ship) name to svc_phone.phone_name if blank
1343 my @cust_svc = $cust_pkg->cust_svc;
1344 foreach my $cust_svc (@cust_svc) {
1345 my($label, $value, $svcdb) = $cust_svc->label;
1346 next unless $svcdb eq 'svc_phone';
1347 my $svc_phone = $cust_svc->svc_x;
1348 next if $svc_phone->phone_name;
1349 $svc_phone->phone_name($name);
1350 my $error = $svc_phone->replace;
1352 $dbh->rollback if $oldAutoCommit;
1360 # cust_tax_exempt (texas tax exemptions)
1361 # cust_recon (some sort of not-well understood thing for OnPac)
1363 #these are moved over
1364 foreach my $table (qw(
1365 cust_tag cust_location contact cust_attachment cust_main_note
1366 cust_tax_adjustment cust_pay_batch queue
1368 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1369 $record->custnum($new_custnum);
1370 my $error = $record->replace;
1372 $dbh->rollback if $oldAutoCommit;
1378 #these aren't preserved
1379 foreach my $table (qw(
1380 cust_main_exemption cust_main_invoice
1382 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1383 my $error = $record->delete;
1385 $dbh->rollback if $oldAutoCommit;
1392 my $sth = $dbh->prepare(
1393 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1395 my $errstr = $dbh->errstr;
1396 $dbh->rollback if $oldAutoCommit;
1399 $sth->execute($new_custnum, $self->custnum) or do {
1400 my $errstr = $sth->errstr;
1401 $dbh->rollback if $oldAutoCommit;
1407 my $ticket_dbh = '';
1408 if ($conf->config('ticket_system') eq 'RT_Internal') {
1410 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1411 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1412 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1413 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1416 if ( $ticket_dbh ) {
1418 my $ticket_sth = $ticket_dbh->prepare(
1419 'UPDATE Links SET Target = ? WHERE Target = ?'
1421 my $errstr = $ticket_dbh->errstr;
1422 $dbh->rollback if $oldAutoCommit;
1425 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1426 'freeside://freeside/cust_main/'.$self->custnum)
1428 my $errstr = $ticket_sth->errstr;
1429 $dbh->rollback if $oldAutoCommit;
1435 #delete the customer record
1437 my $error = $self->delete;
1439 $dbh->rollback if $oldAutoCommit;
1443 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1448 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1450 Replaces the OLD_RECORD with this one in the database. If there is an error,
1451 returns the error, otherwise returns false.
1453 To change the customer's address, set the pseudo-fields C<bill_location> and
1454 C<ship_location>. The address will still only change if at least one of the
1455 address fields differs from the existing values.
1457 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1458 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1459 expected and rollback the entire transaction; it is not necessary to call
1460 check_invoicing_list first. Here's an example:
1462 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1464 Currently available options are: I<tax_exemption>.
1466 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1467 of tax names and exemption numbers. FS::cust_main_exemption records will be
1468 deleted and inserted as appropriate.
1475 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1477 : $self->replace_old;
1481 warn "$me replace called\n"
1484 my $curuser = $FS::CurrentUser::CurrentUser;
1485 if ( $self->payby eq 'COMP'
1486 && $self->payby ne $old->payby
1487 && ! $curuser->access_right('Complimentary customer')
1490 return "You are not permitted to create complimentary accounts.";
1493 local($ignore_expired_card) = 1
1494 if $old->payby =~ /^(CARD|DCRD)$/
1495 && $self->payby =~ /^(CARD|DCRD)$/
1496 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1498 local($ignore_banned_card) = 1
1499 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1500 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1501 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1503 return "Invoicing locale is required"
1506 && $conf->exists('cust_main-require_locale');
1508 local $SIG{HUP} = 'IGNORE';
1509 local $SIG{INT} = 'IGNORE';
1510 local $SIG{QUIT} = 'IGNORE';
1511 local $SIG{TERM} = 'IGNORE';
1512 local $SIG{TSTP} = 'IGNORE';
1513 local $SIG{PIPE} = 'IGNORE';
1515 my $oldAutoCommit = $FS::UID::AutoCommit;
1516 local $FS::UID::AutoCommit = 0;
1519 for my $l (qw(bill_location ship_location)) {
1520 my $old_loc = $old->$l;
1521 my $new_loc = $self->$l;
1523 # find the existing location if there is one
1524 $new_loc->set('custnum' => $self->custnum);
1525 my $error = $new_loc->find_or_insert;
1527 $dbh->rollback if $oldAutoCommit;
1530 $self->set($l.'num', $new_loc->locationnum);
1533 # replace the customer record
1534 my $error = $self->SUPER::replace($old);
1537 $dbh->rollback if $oldAutoCommit;
1541 # now move packages to the new service location
1542 $self->set('ship_location', ''); #flush cache
1543 if ( $old->ship_locationnum and # should only be null during upgrade...
1544 $old->ship_locationnum != $self->ship_locationnum ) {
1545 $error = $old->ship_location->move_to($self->ship_location);
1547 $dbh->rollback if $oldAutoCommit;
1551 # don't move packages based on the billing location, but
1552 # disable it if it's no longer in use
1553 if ( $old->bill_locationnum and
1554 $old->bill_locationnum != $self->bill_locationnum ) {
1555 $error = $old->bill_location->disable_if_unused;
1557 $dbh->rollback if $oldAutoCommit;
1562 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1563 my $invoicing_list = shift @param;
1564 $error = $self->check_invoicing_list( $invoicing_list );
1566 $dbh->rollback if $oldAutoCommit;
1569 $self->invoicing_list( $invoicing_list );
1572 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1574 #this could be more efficient than deleting and re-inserting, if it matters
1575 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1576 my $error = $cust_tag->delete;
1578 $dbh->rollback if $oldAutoCommit;
1582 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1583 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1584 'custnum' => $self->custnum };
1585 my $error = $cust_tag->insert;
1587 $dbh->rollback if $oldAutoCommit;
1594 my %options = @param;
1596 my $tax_exemption = delete $options{'tax_exemption'};
1597 if ( $tax_exemption ) {
1599 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1600 if ref($tax_exemption) eq 'ARRAY';
1602 my %cust_main_exemption =
1603 map { $_->taxname => $_ }
1604 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1606 foreach my $taxname ( keys %$tax_exemption ) {
1608 if ( $cust_main_exemption{$taxname} &&
1609 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1612 delete $cust_main_exemption{$taxname};
1616 my $cust_main_exemption = new FS::cust_main_exemption {
1617 'custnum' => $self->custnum,
1618 'taxname' => $taxname,
1619 'exempt_number' => $tax_exemption->{$taxname},
1621 my $error = $cust_main_exemption->insert;
1623 $dbh->rollback if $oldAutoCommit;
1624 return "inserting cust_main_exemption (transaction rolled back): $error";
1628 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1629 my $error = $cust_main_exemption->delete;
1631 $dbh->rollback if $oldAutoCommit;
1632 return "deleting cust_main_exemption (transaction rolled back): $error";
1638 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1639 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1640 && $self->get('payinfo') !~ /^99\d{14}$/
1642 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1647 # card/check/lec info has changed, want to retry realtime_ invoice events
1648 my $error = $self->retry_realtime;
1650 $dbh->rollback if $oldAutoCommit;
1655 unless ( $import || $skip_fuzzyfiles ) {
1656 $error = $self->queue_fuzzyfiles_update;
1658 $dbh->rollback if $oldAutoCommit;
1659 return "updating fuzzy search cache: $error";
1663 # tax district update in cust_location
1665 # cust_main exports!
1667 my $export_args = $options{'export_args'} || [];
1670 map qsearch( 'part_export', {exportnum=>$_} ),
1671 $conf->config('cust_main-exports'); #, $agentnum
1673 foreach my $part_export ( @part_export ) {
1674 my $error = $part_export->export_replace( $self, $old, @$export_args);
1676 $dbh->rollback if $oldAutoCommit;
1677 return "exporting to ". $part_export->exporttype.
1678 " (transaction rolled back): $error";
1682 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1687 =item queue_fuzzyfiles_update
1689 Used by insert & replace to update the fuzzy search cache
1693 use FS::cust_main::Search;
1694 sub queue_fuzzyfiles_update {
1697 local $SIG{HUP} = 'IGNORE';
1698 local $SIG{INT} = 'IGNORE';
1699 local $SIG{QUIT} = 'IGNORE';
1700 local $SIG{TERM} = 'IGNORE';
1701 local $SIG{TSTP} = 'IGNORE';
1702 local $SIG{PIPE} = 'IGNORE';
1704 my $oldAutoCommit = $FS::UID::AutoCommit;
1705 local $FS::UID::AutoCommit = 0;
1708 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1709 my $queue = new FS::queue {
1710 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1712 my @args = "cust_main.$field", $self->get($field);
1713 my $error = $queue->insert( @args );
1715 $dbh->rollback if $oldAutoCommit;
1716 return "queueing job (transaction rolled back): $error";
1720 my @locations = $self->bill_location;
1721 push @locations, $self->ship_location if $self->has_ship_address;
1722 foreach my $location (@locations) {
1723 my $queue = new FS::queue {
1724 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1726 my @args = 'cust_location.address1', $location->address1;
1727 my $error = $queue->insert( @args );
1729 $dbh->rollback if $oldAutoCommit;
1730 return "queueing job (transaction rolled back): $error";
1734 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1741 Checks all fields to make sure this is a valid customer record. If there is
1742 an error, returns the error, otherwise returns false. Called by the insert
1743 and replace methods.
1750 warn "$me check BEFORE: \n". $self->_dump
1754 $self->ut_numbern('custnum')
1755 || $self->ut_number('agentnum')
1756 || $self->ut_textn('agent_custid')
1757 || $self->ut_number('refnum')
1758 || $self->ut_foreign_key('bill_locationnum', 'cust_location','locationnum')
1759 || $self->ut_foreign_key('ship_locationnum', 'cust_location','locationnum')
1760 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1761 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1762 || $self->ut_textn('custbatch')
1763 || $self->ut_name('last')
1764 || $self->ut_name('first')
1765 || $self->ut_snumbern('signupdate')
1766 || $self->ut_snumbern('birthdate')
1767 || $self->ut_namen('spouse_last')
1768 || $self->ut_namen('spouse_first')
1769 || $self->ut_snumbern('spouse_birthdate')
1770 || $self->ut_snumbern('anniversary_date')
1771 || $self->ut_textn('company')
1772 || $self->ut_textn('ship_company')
1773 || $self->ut_anything('comments')
1774 || $self->ut_numbern('referral_custnum')
1775 || $self->ut_textn('stateid')
1776 || $self->ut_textn('stateid_state')
1777 || $self->ut_textn('invoice_terms')
1778 || $self->ut_floatn('cdr_termination_percentage')
1779 || $self->ut_floatn('credit_limit')
1780 || $self->ut_numbern('billday')
1781 || $self->ut_numbern('prorate_day')
1782 || $self->ut_flag('edit_subject')
1783 || $self->ut_flag('calling_list_exempt')
1784 || $self->ut_flag('invoice_noemail')
1785 || $self->ut_flag('message_noemail')
1786 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1789 foreach (qw(company ship_company)) {
1790 my $company = $self->get($_);
1791 $company =~ s/^\s+//;
1792 $company =~ s/\s+$//;
1793 $company =~ s/\s+/ /g;
1794 $self->set($_, $company);
1797 #barf. need message catalogs. i18n. etc.
1798 $error .= "Please select an advertising source."
1799 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1800 return $error if $error;
1802 return "Unknown agent"
1803 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1805 return "Unknown refnum"
1806 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1808 return "Unknown referring custnum: ". $self->referral_custnum
1809 unless ! $self->referral_custnum
1810 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1812 if ( $self->ss eq '' ) {
1817 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1818 or return "Illegal social security number: ". $self->ss;
1819 $self->ss("$1-$2-$3");
1822 # cust_main_county verification now handled by cust_location check
1825 $self->ut_phonen('daytime', $self->country)
1826 || $self->ut_phonen('night', $self->country)
1827 || $self->ut_phonen('fax', $self->country)
1828 || $self->ut_phonen('mobile', $self->country)
1830 return $error if $error;
1832 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1834 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1837 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1839 : FS::Msgcat::_gettext('daytime');
1840 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1842 : FS::Msgcat::_gettext('night');
1844 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1846 : FS::Msgcat::_gettext('mobile');
1848 return "$daytime_label, $night_label or $mobile_label is required"
1852 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1853 # or return "Illegal payby: ". $self->payby;
1855 FS::payby->can_payby($self->table, $self->payby)
1856 or return "Illegal payby: ". $self->payby;
1858 $error = $self->ut_numbern('paystart_month')
1859 || $self->ut_numbern('paystart_year')
1860 || $self->ut_numbern('payissue')
1861 || $self->ut_textn('paytype')
1863 return $error if $error;
1865 if ( $self->payip eq '' ) {
1868 $error = $self->ut_ip('payip');
1869 return $error if $error;
1872 # If it is encrypted and the private key is not availaible then we can't
1873 # check the credit card.
1874 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1876 # Need some kind of global flag to accept invalid cards, for testing
1878 if ( !$import && $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1880 my $payinfo = $self->payinfo;
1881 $payinfo =~ s/\D//g;
1882 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1883 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1885 $self->payinfo($payinfo);
1887 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1889 return gettext('unknown_card_type')
1890 if $self->payinfo !~ /^99\d{14}$/ #token
1891 && cardtype($self->payinfo) eq "Unknown";
1893 unless ( $ignore_banned_card ) {
1894 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1896 if ( $ban->bantype eq 'warn' ) {
1897 #or others depending on value of $ban->reason ?
1898 return '_duplicate_card'.
1899 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1900 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1901 ' (ban# '. $ban->bannum. ')'
1902 unless $self->override_ban_warn;
1904 return 'Banned credit card: banned on '.
1905 time2str('%a %h %o at %r', $ban->_date).
1906 ' by '. $ban->otaker.
1907 ' (ban# '. $ban->bannum. ')';
1912 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1913 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1914 $self->paycvv =~ /^(\d{4})$/
1915 or return "CVV2 (CID) for American Express cards is four digits.";
1918 $self->paycvv =~ /^(\d{3})$/
1919 or return "CVV2 (CVC2/CID) is three digits.";
1926 my $cardtype = cardtype($payinfo);
1927 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1929 return "Start date or issue number is required for $cardtype cards"
1930 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1932 return "Start month must be between 1 and 12"
1933 if $self->paystart_month
1934 and $self->paystart_month < 1 || $self->paystart_month > 12;
1936 return "Start year must be 1990 or later"
1937 if $self->paystart_year
1938 and $self->paystart_year < 1990;
1940 return "Issue number must be beween 1 and 99"
1942 and $self->payissue < 1 || $self->payissue > 99;
1945 $self->paystart_month('');
1946 $self->paystart_year('');
1947 $self->payissue('');
1950 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1952 my $payinfo = $self->payinfo;
1953 $payinfo =~ s/[^\d\@\.]//g;
1954 if ( $conf->config('echeck-country') eq 'CA' ) {
1955 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1956 or return 'invalid echeck account@branch.bank';
1957 $payinfo = "$1\@$2.$3";
1958 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1959 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1960 $payinfo = "$1\@$2";
1962 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1963 $payinfo = "$1\@$2";
1965 $self->payinfo($payinfo);
1968 unless ( $ignore_banned_card ) {
1969 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1971 if ( $ban->bantype eq 'warn' ) {
1972 #or others depending on value of $ban->reason ?
1973 return '_duplicate_ach' unless $self->override_ban_warn;
1975 return 'Banned ACH account: banned on '.
1976 time2str('%a %h %o at %r', $ban->_date).
1977 ' by '. $ban->otaker.
1978 ' (ban# '. $ban->bannum. ')';
1983 } elsif ( $self->payby eq 'LECB' ) {
1985 my $payinfo = $self->payinfo;
1986 $payinfo =~ s/\D//g;
1987 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1989 $self->payinfo($payinfo);
1992 } elsif ( $self->payby eq 'BILL' ) {
1994 $error = $self->ut_textn('payinfo');
1995 return "Illegal P.O. number: ". $self->payinfo if $error;
1998 } elsif ( $self->payby eq 'COMP' ) {
2000 my $curuser = $FS::CurrentUser::CurrentUser;
2001 if ( ! $self->custnum
2002 && ! $curuser->access_right('Complimentary customer')
2005 return "You are not permitted to create complimentary accounts."
2008 $error = $self->ut_textn('payinfo');
2009 return "Illegal comp account issuer: ". $self->payinfo if $error;
2012 } elsif ( $self->payby eq 'PREPAY' ) {
2014 my $payinfo = $self->payinfo;
2015 $payinfo =~ s/\W//g; #anything else would just confuse things
2016 $self->payinfo($payinfo);
2017 $error = $self->ut_alpha('payinfo');
2018 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2019 return "Unknown prepayment identifier"
2020 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2025 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2026 return "Expiration date required"
2027 # shouldn't payinfo_check do this?
2028 unless $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 return "Please select an invoicing locale"
2072 && $conf->exists('cust_main-require_locale');
2074 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2075 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2079 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2081 warn "$me check AFTER: \n". $self->_dump
2084 $self->SUPER::check;
2089 Returns a list of fields which have ship_ duplicates.
2094 qw( last first company
2096 address1 address2 city county state zip country
2098 daytime night fax mobile
2102 =item has_ship_address
2104 Returns true if this customer record has a separate shipping address.
2108 sub has_ship_address {
2110 $self->bill_locationnum != $self->ship_locationnum;
2115 Returns a list of key/value pairs, with the following keys: address1,
2116 adddress2, city, county, state, zip, country, district, and geocode. The
2117 shipping address is used if present.
2123 $self->ship_location->location_hash;
2128 Returns all locations (see L<FS::cust_location>) for this customer.
2134 qsearch('cust_location', { 'custnum' => $self->custnum,
2135 'prospectnum' => '' } );
2140 Returns all contacts (see L<FS::contact>) for this customer.
2144 #already used :/ sub contact {
2147 qsearch('contact', { 'custnum' => $self->custnum } );
2152 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2153 and L<FS::cust_pkg>) for this customer, except those on hold.
2155 Returns a list: an empty list on success or a list of errors.
2161 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2166 Unsuspends all suspended packages in the on-hold state (those without setup
2167 dates) for this customer.
2173 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2178 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2180 Returns a list: an empty list on success or a list of errors.
2186 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2189 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2191 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2192 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2193 of a list of pkgparts; the hashref has the following keys:
2197 =item pkgparts - listref of pkgparts
2199 =item (other options are passed to the suspend method)
2204 Returns a list: an empty list on success or a list of errors.
2208 sub suspend_if_pkgpart {
2210 my (@pkgparts, %opt);
2211 if (ref($_[0]) eq 'HASH'){
2212 @pkgparts = @{$_[0]{pkgparts}};
2217 grep { $_->suspend(%opt) }
2218 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2219 $self->unsuspended_pkgs;
2222 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2224 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2225 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2226 instead of a list of pkgparts; the hashref has the following keys:
2230 =item pkgparts - listref of pkgparts
2232 =item (other options are passed to the suspend method)
2236 Returns a list: an empty list on success or a list of errors.
2240 sub suspend_unless_pkgpart {
2242 my (@pkgparts, %opt);
2243 if (ref($_[0]) eq 'HASH'){
2244 @pkgparts = @{$_[0]{pkgparts}};
2249 grep { $_->suspend(%opt) }
2250 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2251 $self->unsuspended_pkgs;
2254 =item cancel [ OPTION => VALUE ... ]
2256 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2258 Available options are:
2262 =item quiet - can be set true to supress email cancellation notices.
2264 =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.
2266 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2268 =item nobill - can be set true to skip billing if it might otherwise be done.
2272 Always returns a list: an empty list on success or a list of errors.
2276 # nb that dates are not specified as valid options to this method
2279 my( $self, %opt ) = @_;
2281 warn "$me cancel called on customer ". $self->custnum. " with options ".
2282 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2285 return ( 'access denied' )
2286 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2288 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2290 #should try decryption (we might have the private key)
2291 # and if not maybe queue a job for the server that does?
2292 return ( "Can't (yet) ban encrypted credit cards" )
2293 if $self->is_encrypted($self->payinfo);
2295 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2296 my $error = $ban->insert;
2297 return ( $error ) if $error;
2301 my @pkgs = $self->ncancelled_pkgs;
2303 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2305 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2306 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2310 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2311 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2314 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2317 sub _banned_pay_hashref {
2328 'payby' => $payby2ban{$self->payby},
2329 'payinfo' => $self->payinfo,
2330 #don't ever *search* on reason! #'reason' =>
2334 sub _new_banned_pay_hashref {
2336 my $hr = $self->_banned_pay_hashref;
2337 $hr->{payinfo} = md5_base64($hr->{payinfo});
2343 Returns all notes (see L<FS::cust_main_note>) for this customer.
2348 my($self,$orderby_classnum) = (shift,shift);
2349 my $orderby = "_DATE DESC";
2350 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2351 qsearch( 'cust_main_note',
2352 { 'custnum' => $self->custnum },
2354 "ORDER BY $orderby",
2360 Returns the agent (see L<FS::agent>) for this customer.
2366 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2371 Returns the agent name (see L<FS::agent>) for this customer.
2377 $self->agent->agent;
2382 Returns any tags associated with this customer, as FS::cust_tag objects,
2383 or an empty list if there are no tags.
2389 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2394 Returns any tags associated with this customer, as FS::part_tag objects,
2395 or an empty list if there are no tags.
2401 map $_->part_tag, $self->cust_tag;
2407 Returns the customer class, as an FS::cust_class object, or the empty string
2408 if there is no customer class.
2414 if ( $self->classnum ) {
2415 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2423 Returns the customer category name, or the empty string if there is no customer
2430 my $cust_class = $self->cust_class;
2432 ? $cust_class->categoryname
2438 Returns the customer class name, or the empty string if there is no customer
2445 my $cust_class = $self->cust_class;
2447 ? $cust_class->classname
2451 =item BILLING METHODS
2453 Documentation on billing methods has been moved to
2454 L<FS::cust_main::Billing>.
2456 =item REALTIME BILLING METHODS
2458 Documentation on realtime billing methods has been moved to
2459 L<FS::cust_main::Billing_Realtime>.
2463 Removes the I<paycvv> field from the database directly.
2465 If there is an error, returns the error, otherwise returns false.
2471 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2472 or return dbh->errstr;
2473 $sth->execute($self->custnum)
2474 or return $sth->errstr;
2479 =item batch_card OPTION => VALUE...
2481 Adds a payment for this invoice to the pending credit card batch (see
2482 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2483 runs the payment using a realtime gateway.
2485 Options may include:
2487 B<amount>: the amount to be paid; defaults to the customer's balance minus
2488 any payments in transit.
2490 B<payby>: the payment method; defaults to cust_main.payby
2492 B<realtime>: runs this as a realtime payment instead of adding it to a
2495 B<invnum>: sets cust_pay_batch.invnum.
2497 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2498 the billing address for the payment; defaults to the customer's billing
2501 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2502 date, and name; defaults to those fields in cust_main.
2507 my ($self, %options) = @_;
2510 if (exists($options{amount})) {
2511 $amount = $options{amount};
2513 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2515 return '' unless $amount > 0;
2517 my $invnum = delete $options{invnum};
2518 my $payby = $options{payby} || $self->payby; #still dubious
2520 if ($options{'realtime'}) {
2521 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2527 my $oldAutoCommit = $FS::UID::AutoCommit;
2528 local $FS::UID::AutoCommit = 0;
2531 #this needs to handle mysql as well as Pg, like svc_acct.pm
2532 #(make it into a common function if folks need to do batching with mysql)
2533 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2534 or return "Cannot lock pay_batch: " . $dbh->errstr;
2538 'payby' => FS::payby->payby2payment($payby),
2540 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2542 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2544 unless ( $pay_batch ) {
2545 $pay_batch = new FS::pay_batch \%pay_batch;
2546 my $error = $pay_batch->insert;
2548 $dbh->rollback if $oldAutoCommit;
2549 die "error creating new batch: $error\n";
2553 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2554 'batchnum' => $pay_batch->batchnum,
2555 'custnum' => $self->custnum,
2558 foreach (qw( address1 address2 city state zip country latitude longitude
2559 payby payinfo paydate payname ))
2561 $options{$_} = '' unless exists($options{$_});
2564 my $loc = $self->bill_location;
2566 my $cust_pay_batch = new FS::cust_pay_batch ( {
2567 'batchnum' => $pay_batch->batchnum,
2568 'invnum' => $invnum || 0, # is there a better value?
2569 # this field should be
2571 # cust_bill_pay_batch now
2572 'custnum' => $self->custnum,
2573 'last' => $self->getfield('last'),
2574 'first' => $self->getfield('first'),
2575 'address1' => $options{address1} || $loc->address1,
2576 'address2' => $options{address2} || $loc->address2,
2577 'city' => $options{city} || $loc->city,
2578 'state' => $options{state} || $loc->state,
2579 'zip' => $options{zip} || $loc->zip,
2580 'country' => $options{country} || $loc->country,
2581 'payby' => $options{payby} || $self->payby,
2582 'payinfo' => $options{payinfo} || $self->payinfo,
2583 'exp' => $options{paydate} || $self->paydate,
2584 'payname' => $options{payname} || $self->payname,
2585 'amount' => $amount, # consolidating
2588 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2589 if $old_cust_pay_batch;
2592 if ($old_cust_pay_batch) {
2593 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2595 $error = $cust_pay_batch->insert;
2599 $dbh->rollback if $oldAutoCommit;
2603 my $unapplied = $self->total_unapplied_credits
2604 + $self->total_unapplied_payments
2605 + $self->in_transit_payments;
2606 foreach my $cust_bill ($self->open_cust_bill) {
2607 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2608 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2609 'invnum' => $cust_bill->invnum,
2610 'paybatchnum' => $cust_pay_batch->paybatchnum,
2611 'amount' => $cust_bill->owed,
2614 if ($unapplied >= $cust_bill_pay_batch->amount){
2615 $unapplied -= $cust_bill_pay_batch->amount;
2618 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2619 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2621 $error = $cust_bill_pay_batch->insert;
2623 $dbh->rollback if $oldAutoCommit;
2628 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2634 Returns the total owed for this customer on all invoices
2635 (see L<FS::cust_bill/owed>).
2641 $self->total_owed_date(2145859200); #12/31/2037
2644 =item total_owed_date TIME
2646 Returns the total owed for this customer on all invoices with date earlier than
2647 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2648 see L<Time::Local> and L<Date::Parse> for conversion functions.
2652 sub total_owed_date {
2656 my $custnum = $self->custnum;
2658 my $owed_sql = FS::cust_bill->owed_sql;
2661 SELECT SUM($owed_sql) FROM cust_bill
2662 WHERE custnum = $custnum
2666 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2670 =item total_owed_pkgnum PKGNUM
2672 Returns the total owed on all invoices for this customer's specific package
2673 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2677 sub total_owed_pkgnum {
2678 my( $self, $pkgnum ) = @_;
2679 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2682 =item total_owed_date_pkgnum TIME PKGNUM
2684 Returns the total owed for this customer's specific package when using
2685 experimental package balances on all invoices with date earlier than
2686 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2687 see L<Time::Local> and L<Date::Parse> for conversion functions.
2691 sub total_owed_date_pkgnum {
2692 my( $self, $time, $pkgnum ) = @_;
2695 foreach my $cust_bill (
2696 grep { $_->_date <= $time }
2697 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2699 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2701 sprintf( "%.2f", $total_bill );
2707 Returns the total amount of all payments.
2714 $total += $_->paid foreach $self->cust_pay;
2715 sprintf( "%.2f", $total );
2718 =item total_unapplied_credits
2720 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2721 customer. See L<FS::cust_credit/credited>.
2723 =item total_credited
2725 Old name for total_unapplied_credits. Don't use.
2729 sub total_credited {
2730 #carp "total_credited deprecated, use total_unapplied_credits";
2731 shift->total_unapplied_credits(@_);
2734 sub total_unapplied_credits {
2737 my $custnum = $self->custnum;
2739 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2742 SELECT SUM($unapplied_sql) FROM cust_credit
2743 WHERE custnum = $custnum
2746 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2750 =item total_unapplied_credits_pkgnum PKGNUM
2752 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2753 customer. See L<FS::cust_credit/credited>.
2757 sub total_unapplied_credits_pkgnum {
2758 my( $self, $pkgnum ) = @_;
2759 my $total_credit = 0;
2760 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2761 sprintf( "%.2f", $total_credit );
2765 =item total_unapplied_payments
2767 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2768 See L<FS::cust_pay/unapplied>.
2772 sub total_unapplied_payments {
2775 my $custnum = $self->custnum;
2777 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2780 SELECT SUM($unapplied_sql) FROM cust_pay
2781 WHERE custnum = $custnum
2784 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2788 =item total_unapplied_payments_pkgnum PKGNUM
2790 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2791 specific package when using experimental package balances. See
2792 L<FS::cust_pay/unapplied>.
2796 sub total_unapplied_payments_pkgnum {
2797 my( $self, $pkgnum ) = @_;
2798 my $total_unapplied = 0;
2799 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2800 sprintf( "%.2f", $total_unapplied );
2804 =item total_unapplied_refunds
2806 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2807 customer. See L<FS::cust_refund/unapplied>.
2811 sub total_unapplied_refunds {
2813 my $custnum = $self->custnum;
2815 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2818 SELECT SUM($unapplied_sql) FROM cust_refund
2819 WHERE custnum = $custnum
2822 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2828 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2829 total_unapplied_credits minus total_unapplied_payments).
2835 $self->balance_date_range;
2838 =item balance_date TIME
2840 Returns the balance for this customer, only considering invoices with date
2841 earlier than TIME (total_owed_date minus total_credited minus
2842 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2843 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2850 $self->balance_date_range(shift);
2853 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2855 Returns the balance for this customer, optionally considering invoices with
2856 date earlier than START_TIME, and not later than END_TIME
2857 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2859 Times are specified as SQL fragments or numeric
2860 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2861 L<Date::Parse> for conversion functions. The empty string can be passed
2862 to disable that time constraint completely.
2864 Accepts the same options as L<balance_date_sql>:
2868 =item unapplied_date
2870 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)
2874 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2875 time will be ignored. Note that START_TIME and END_TIME only limit the date
2876 range for invoices and I<unapplied> payments, credits, and refunds.
2882 sub balance_date_range {
2884 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2885 ') FROM cust_main WHERE custnum='. $self->custnum;
2886 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2889 =item balance_pkgnum PKGNUM
2891 Returns the balance for this customer's specific package when using
2892 experimental package balances (total_owed plus total_unrefunded, minus
2893 total_unapplied_credits minus total_unapplied_payments)
2897 sub balance_pkgnum {
2898 my( $self, $pkgnum ) = @_;
2901 $self->total_owed_pkgnum($pkgnum)
2902 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2903 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2904 - $self->total_unapplied_credits_pkgnum($pkgnum)
2905 - $self->total_unapplied_payments_pkgnum($pkgnum)
2909 =item in_transit_payments
2911 Returns the total of requests for payments for this customer pending in
2912 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2916 sub in_transit_payments {
2918 my $in_transit_payments = 0;
2919 foreach my $pay_batch ( qsearch('pay_batch', {
2922 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2923 'batchnum' => $pay_batch->batchnum,
2924 'custnum' => $self->custnum,
2926 $in_transit_payments += $cust_pay_batch->amount;
2929 sprintf( "%.2f", $in_transit_payments );
2934 Returns a hash of useful information for making a payment.
2944 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2945 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2946 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2950 For credit card transactions:
2962 For electronic check transactions:
2977 $return{balance} = $self->balance;
2979 $return{payname} = $self->payname
2980 || ( $self->first. ' '. $self->get('last') );
2982 $return{$_} = $self->bill_location->$_
2983 for qw(address1 address2 city state zip);
2985 $return{payby} = $self->payby;
2986 $return{stateid_state} = $self->stateid_state;
2988 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2989 $return{card_type} = cardtype($self->payinfo);
2990 $return{payinfo} = $self->paymask;
2992 @return{'month', 'year'} = $self->paydate_monthyear;
2996 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2997 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2998 $return{payinfo1} = $payinfo1;
2999 $return{payinfo2} = $payinfo2;
3000 $return{paytype} = $self->paytype;
3001 $return{paystate} = $self->paystate;
3005 #doubleclick protection
3007 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3013 =item paydate_monthyear
3015 Returns a two-element list consisting of the month and year of this customer's
3016 paydate (credit card expiration date for CARD customers)
3020 sub paydate_monthyear {
3022 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3024 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3033 Returns the exact time in seconds corresponding to the payment method
3034 expiration date. For CARD/DCRD customers this is the end of the month;
3035 for others (COMP is the only other payby that uses paydate) it's the start.
3036 Returns 0 if the paydate is empty or set to the far future.
3042 my ($month, $year) = $self->paydate_monthyear;
3043 return 0 if !$year or $year >= 2037;
3044 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3046 if ( $month == 13 ) {
3050 return timelocal(0,0,0,1,$month-1,$year) - 1;
3053 return timelocal(0,0,0,1,$month-1,$year);
3057 =item paydate_epoch_sql
3059 Class method. Returns an SQL expression to obtain the payment expiration date
3060 as a number of seconds.
3064 # Special expiration date behavior for non-CARD/DCRD customers has been
3065 # carefully preserved. Do we really use that?
3066 sub paydate_epoch_sql {
3068 my $table = shift || 'cust_main';
3069 my ($case1, $case2);
3070 if ( driver_name eq 'Pg' ) {
3071 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3072 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3074 elsif ( lc(driver_name) eq 'mysql' ) {
3075 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3076 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3079 return "CASE WHEN $table.payby IN('CARD','DCRD')
3085 =item tax_exemption TAXNAME
3090 my( $self, $taxname ) = @_;
3092 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3093 'taxname' => $taxname,
3098 =item cust_main_exemption
3102 sub cust_main_exemption {
3104 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3107 =item invoicing_list [ ARRAYREF ]
3109 If an arguement is given, sets these email addresses as invoice recipients
3110 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3111 (except as warnings), so use check_invoicing_list first.
3113 Returns a list of email addresses (with svcnum entries expanded).
3115 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3116 check it without disturbing anything by passing nothing.
3118 This interface may change in the future.
3122 sub invoicing_list {
3123 my( $self, $arrayref ) = @_;
3126 my @cust_main_invoice;
3127 if ( $self->custnum ) {
3128 @cust_main_invoice =
3129 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3131 @cust_main_invoice = ();
3133 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3134 #warn $cust_main_invoice->destnum;
3135 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3136 #warn $cust_main_invoice->destnum;
3137 my $error = $cust_main_invoice->delete;
3138 warn $error if $error;
3141 if ( $self->custnum ) {
3142 @cust_main_invoice =
3143 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3145 @cust_main_invoice = ();
3147 my %seen = map { $_->address => 1 } @cust_main_invoice;
3148 foreach my $address ( @{$arrayref} ) {
3149 next if exists $seen{$address} && $seen{$address};
3150 $seen{$address} = 1;
3151 my $cust_main_invoice = new FS::cust_main_invoice ( {
3152 'custnum' => $self->custnum,
3155 my $error = $cust_main_invoice->insert;
3156 warn $error if $error;
3160 if ( $self->custnum ) {
3162 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3169 =item check_invoicing_list ARRAYREF
3171 Checks these arguements as valid input for the invoicing_list method. If there
3172 is an error, returns the error, otherwise returns false.
3176 sub check_invoicing_list {
3177 my( $self, $arrayref ) = @_;
3179 foreach my $address ( @$arrayref ) {
3181 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3182 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3185 my $cust_main_invoice = new FS::cust_main_invoice ( {
3186 'custnum' => $self->custnum,
3189 my $error = $self->custnum
3190 ? $cust_main_invoice->check
3191 : $cust_main_invoice->checkdest
3193 return $error if $error;
3197 return "Email address required"
3198 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3199 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3204 =item set_default_invoicing_list
3206 Sets the invoicing list to all accounts associated with this customer,
3207 overwriting any previous invoicing list.
3211 sub set_default_invoicing_list {
3213 $self->invoicing_list($self->all_emails);
3218 Returns the email addresses of all accounts provisioned for this customer.
3225 foreach my $cust_pkg ( $self->all_pkgs ) {
3226 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3228 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3229 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3231 $list{$_}=1 foreach map { $_->email } @svc_acct;
3236 =item invoicing_list_addpost
3238 Adds postal invoicing to this customer. If this customer is already configured
3239 to receive postal invoices, does nothing.
3243 sub invoicing_list_addpost {
3245 return if grep { $_ eq 'POST' } $self->invoicing_list;
3246 my @invoicing_list = $self->invoicing_list;
3247 push @invoicing_list, 'POST';
3248 $self->invoicing_list(\@invoicing_list);
3251 =item invoicing_list_emailonly
3253 Returns the list of email invoice recipients (invoicing_list without non-email
3254 destinations such as POST and FAX).
3258 sub invoicing_list_emailonly {
3260 warn "$me invoicing_list_emailonly called"
3262 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3265 =item invoicing_list_emailonly_scalar
3267 Returns the list of email invoice recipients (invoicing_list without non-email
3268 destinations such as POST and FAX) as a comma-separated scalar.
3272 sub invoicing_list_emailonly_scalar {
3274 warn "$me invoicing_list_emailonly_scalar called"
3276 join(', ', $self->invoicing_list_emailonly);
3279 =item referral_custnum_cust_main
3281 Returns the customer who referred this customer (or the empty string, if
3282 this customer was not referred).
3284 Note the difference with referral_cust_main method: This method,
3285 referral_custnum_cust_main returns the single customer (if any) who referred
3286 this customer, while referral_cust_main returns an array of customers referred
3291 sub referral_custnum_cust_main {
3293 return '' unless $self->referral_custnum;
3294 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3297 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3299 Returns an array of customers referred by this customer (referral_custnum set
3300 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3301 customers referred by customers referred by this customer and so on, inclusive.
3302 The default behavior is DEPTH 1 (no recursion).
3304 Note the difference with referral_custnum_cust_main method: This method,
3305 referral_cust_main, returns an array of customers referred BY this customer,
3306 while referral_custnum_cust_main returns the single customer (if any) who
3307 referred this customer.
3311 sub referral_cust_main {
3313 my $depth = @_ ? shift : 1;
3314 my $exclude = @_ ? shift : {};
3317 map { $exclude->{$_->custnum}++; $_; }
3318 grep { ! $exclude->{ $_->custnum } }
3319 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3323 map { $_->referral_cust_main($depth-1, $exclude) }
3330 =item referral_cust_main_ncancelled
3332 Same as referral_cust_main, except only returns customers with uncancelled
3337 sub referral_cust_main_ncancelled {
3339 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3342 =item referral_cust_pkg [ DEPTH ]
3344 Like referral_cust_main, except returns a flat list of all unsuspended (and
3345 uncancelled) packages for each customer. The number of items in this list may
3346 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3350 sub referral_cust_pkg {
3352 my $depth = @_ ? shift : 1;
3354 map { $_->unsuspended_pkgs }
3355 grep { $_->unsuspended_pkgs }
3356 $self->referral_cust_main($depth);
3359 =item referring_cust_main
3361 Returns the single cust_main record for the customer who referred this customer
3362 (referral_custnum), or false.
3366 sub referring_cust_main {
3368 return '' unless $self->referral_custnum;
3369 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3372 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3374 Applies a credit to this customer. If there is an error, returns the error,
3375 otherwise returns false.
3377 REASON can be a text string, an FS::reason object, or a scalar reference to
3378 a reasonnum. If a text string, it will be automatically inserted as a new
3379 reason, and a 'reason_type' option must be passed to indicate the
3380 FS::reason_type for the new reason.
3382 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3383 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3384 I<commission_pkgnum>.
3386 Any other options are passed to FS::cust_credit::insert.
3391 my( $self, $amount, $reason, %options ) = @_;
3393 my $cust_credit = new FS::cust_credit {
3394 'custnum' => $self->custnum,
3395 'amount' => $amount,
3398 if ( ref($reason) ) {
3400 if ( ref($reason) eq 'SCALAR' ) {
3401 $cust_credit->reasonnum( $$reason );
3403 $cust_credit->reasonnum( $reason->reasonnum );
3407 $cust_credit->set('reason', $reason)
3410 $cust_credit->$_( delete $options{$_} )
3411 foreach grep exists($options{$_}),
3412 qw( addlinfo eventnum ),
3413 map "commission_$_", qw( agentnum salesnum pkgnum );
3415 $cust_credit->insert(%options);
3419 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3421 Creates a one-time charge for this customer. If there is an error, returns
3422 the error, otherwise returns false.
3424 New-style, with a hashref of options:
3426 my $error = $cust_main->charge(
3430 'start_date' => str2time('7/4/2009'),
3431 'pkg' => 'Description',
3432 'comment' => 'Comment',
3433 'additional' => [], #extra invoice detail
3434 'classnum' => 1, #pkg_class
3436 'setuptax' => '', # or 'Y' for tax exempt
3438 'locationnum'=> 1234, # optional
3441 'taxclass' => 'Tax class',
3444 'taxproduct' => 2, #part_pkg_taxproduct
3445 'override' => {}, #XXX describe
3447 #will be filled in with the new object
3448 'cust_pkg_ref' => \$cust_pkg,
3450 #generate an invoice immediately
3452 'invoice_terms' => '', #with these terms
3458 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3464 my ( $amount, $quantity, $start_date, $classnum );
3465 my ( $pkg, $comment, $additional );
3466 my ( $setuptax, $taxclass ); #internal taxes
3467 my ( $taxproduct, $override ); #vendor (CCH) taxes
3469 my $cust_pkg_ref = '';
3470 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3472 if ( ref( $_[0] ) ) {
3473 $amount = $_[0]->{amount};
3474 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3475 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3476 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3477 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3478 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3479 : '$'. sprintf("%.2f",$amount);
3480 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3481 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3482 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3483 $additional = $_[0]->{additional} || [];
3484 $taxproduct = $_[0]->{taxproductnum};
3485 $override = { '' => $_[0]->{tax_override} };
3486 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3487 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3488 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3489 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3494 $pkg = @_ ? shift : 'One-time charge';
3495 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3497 $taxclass = @_ ? shift : '';
3501 local $SIG{HUP} = 'IGNORE';
3502 local $SIG{INT} = 'IGNORE';
3503 local $SIG{QUIT} = 'IGNORE';
3504 local $SIG{TERM} = 'IGNORE';
3505 local $SIG{TSTP} = 'IGNORE';
3506 local $SIG{PIPE} = 'IGNORE';
3508 my $oldAutoCommit = $FS::UID::AutoCommit;
3509 local $FS::UID::AutoCommit = 0;
3512 my $part_pkg = new FS::part_pkg ( {
3514 'comment' => $comment,
3518 'classnum' => ( $classnum ? $classnum : '' ),
3519 'setuptax' => $setuptax,
3520 'taxclass' => $taxclass,
3521 'taxproductnum' => $taxproduct,
3524 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3525 ( 0 .. @$additional - 1 )
3527 'additional_count' => scalar(@$additional),
3528 'setup_fee' => $amount,
3531 my $error = $part_pkg->insert( options => \%options,
3532 tax_overrides => $override,
3535 $dbh->rollback if $oldAutoCommit;
3539 my $pkgpart = $part_pkg->pkgpart;
3540 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3541 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3542 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3543 $error = $type_pkgs->insert;
3545 $dbh->rollback if $oldAutoCommit;
3550 my $cust_pkg = new FS::cust_pkg ( {
3551 'custnum' => $self->custnum,
3552 'pkgpart' => $pkgpart,
3553 'quantity' => $quantity,
3554 'start_date' => $start_date,
3555 'no_auto' => $no_auto,
3556 'locationnum'=> $locationnum,
3559 $error = $cust_pkg->insert;
3561 $dbh->rollback if $oldAutoCommit;
3563 } elsif ( $cust_pkg_ref ) {
3564 ${$cust_pkg_ref} = $cust_pkg;
3568 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3569 'pkg_list' => [ $cust_pkg ],
3572 $dbh->rollback if $oldAutoCommit;
3577 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3582 #=item charge_postal_fee
3584 #Applies a one time charge this customer. If there is an error,
3585 #returns the error, returns the cust_pkg charge object or false
3586 #if there was no charge.
3590 # This should be a customer event. For that to work requires that bill
3591 # also be a customer event.
3593 sub charge_postal_fee {
3596 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3597 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3599 my $cust_pkg = new FS::cust_pkg ( {
3600 'custnum' => $self->custnum,
3601 'pkgpart' => $pkgpart,
3605 my $error = $cust_pkg->insert;
3606 $error ? $error : $cust_pkg;
3609 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3611 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3613 Optionally, a list or hashref of additional arguments to the qsearch call can
3620 my $opt = ref($_[0]) ? shift : { @_ };
3622 #return $self->num_cust_bill unless wantarray || keys %$opt;
3624 $opt->{'table'} = 'cust_bill';
3625 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3626 $opt->{'hashref'}{'custnum'} = $self->custnum;
3627 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3629 map { $_ } #behavior of sort undefined in scalar context
3630 sort { $a->_date <=> $b->_date }
3634 =item open_cust_bill
3636 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3641 sub open_cust_bill {
3645 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3651 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3653 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3657 sub legacy_cust_bill {
3660 #return $self->num_legacy_cust_bill unless wantarray;
3662 map { $_ } #behavior of sort undefined in scalar context
3663 sort { $a->_date <=> $b->_date }
3664 qsearch({ 'table' => 'legacy_cust_bill',
3665 'hashref' => { 'custnum' => $self->custnum, },
3666 'order_by' => 'ORDER BY _date ASC',
3670 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3672 Returns all the statements (see L<FS::cust_statement>) for this customer.
3674 Optionally, a list or hashref of additional arguments to the qsearch call can
3679 =item cust_bill_void
3681 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3685 sub cust_bill_void {
3688 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3689 sort { $a->_date <=> $b->_date }
3690 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3693 sub cust_statement {
3695 my $opt = ref($_[0]) ? shift : { @_ };
3697 #return $self->num_cust_statement unless wantarray || keys %$opt;
3699 $opt->{'table'} = 'cust_statement';
3700 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3701 $opt->{'hashref'}{'custnum'} = $self->custnum;
3702 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3704 map { $_ } #behavior of sort undefined in scalar context
3705 sort { $a->_date <=> $b->_date }
3709 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3711 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3713 Optionally, a list or hashref of additional arguments to the qsearch call can
3714 be passed following the SVCDB.
3721 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3722 warn "$me svc_x requires a svcdb";
3725 my $opt = ref($_[0]) ? shift : { @_ };
3727 $opt->{'table'} = $svcdb;
3728 $opt->{'addl_from'} =
3729 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3730 ($opt->{'addl_from'} || '');
3732 my $custnum = $self->custnum;
3733 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3734 my $where = "cust_pkg.custnum = $custnum";
3736 my $extra_sql = $opt->{'extra_sql'} || '';
3737 if ( keys %{ $opt->{'hashref'} } ) {
3738 $extra_sql = " AND $where $extra_sql";
3741 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3742 $extra_sql = "WHERE $where AND $1";
3745 $extra_sql = "WHERE $where $extra_sql";
3748 $opt->{'extra_sql'} = $extra_sql;
3753 # required for use as an eventtable;
3756 $self->svc_x('svc_acct', @_);
3761 Returns all the credits (see L<FS::cust_credit>) for this customer.
3767 map { $_ } #return $self->num_cust_credit unless wantarray;
3768 sort { $a->_date <=> $b->_date }
3769 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3772 =item cust_credit_pkgnum
3774 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3775 package when using experimental package balances.
3779 sub cust_credit_pkgnum {
3780 my( $self, $pkgnum ) = @_;
3781 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3782 sort { $a->_date <=> $b->_date }
3783 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3784 'pkgnum' => $pkgnum,
3789 =item cust_credit_void
3791 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3795 sub cust_credit_void {
3798 sort { $a->_date <=> $b->_date }
3799 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3804 Returns all the payments (see L<FS::cust_pay>) for this customer.
3810 my $opt = ref($_[0]) ? shift : { @_ };
3812 return $self->num_cust_pay unless wantarray || keys %$opt;
3814 $opt->{'table'} = 'cust_pay';
3815 $opt->{'hashref'}{'custnum'} = $self->custnum;
3817 map { $_ } #behavior of sort undefined in scalar context
3818 sort { $a->_date <=> $b->_date }
3825 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3826 called automatically when the cust_pay method is used in a scalar context.
3832 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3833 my $sth = dbh->prepare($sql) or die dbh->errstr;
3834 $sth->execute($self->custnum) or die $sth->errstr;
3835 $sth->fetchrow_arrayref->[0];
3838 =item unapplied_cust_pay
3840 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3844 sub unapplied_cust_pay {
3848 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3854 =item cust_pay_pkgnum
3856 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3857 package when using experimental package balances.
3861 sub cust_pay_pkgnum {
3862 my( $self, $pkgnum ) = @_;
3863 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3864 sort { $a->_date <=> $b->_date }
3865 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3866 'pkgnum' => $pkgnum,
3873 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3879 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3880 sort { $a->_date <=> $b->_date }
3881 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3884 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3886 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3888 Optionally, a list or hashref of additional arguments to the qsearch call can
3893 sub cust_pay_batch {
3895 my $opt = ref($_[0]) ? shift : { @_ };
3897 #return $self->num_cust_statement unless wantarray || keys %$opt;
3899 $opt->{'table'} = 'cust_pay_batch';
3900 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3901 $opt->{'hashref'}{'custnum'} = $self->custnum;
3902 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3904 map { $_ } #behavior of sort undefined in scalar context
3905 sort { $a->paybatchnum <=> $b->paybatchnum }
3909 =item cust_pay_pending
3911 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3912 (without status "done").
3916 sub cust_pay_pending {
3918 return $self->num_cust_pay_pending unless wantarray;
3919 sort { $a->_date <=> $b->_date }
3920 qsearch( 'cust_pay_pending', {
3921 'custnum' => $self->custnum,
3922 'status' => { op=>'!=', value=>'done' },
3927 =item cust_pay_pending_attempt
3929 Returns all payment attempts / declined payments for this customer, as pending
3930 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3931 a corresponding payment (see L<FS::cust_pay>).
3935 sub cust_pay_pending_attempt {
3937 return $self->num_cust_pay_pending_attempt unless wantarray;
3938 sort { $a->_date <=> $b->_date }
3939 qsearch( 'cust_pay_pending', {
3940 'custnum' => $self->custnum,
3947 =item num_cust_pay_pending
3949 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3950 customer (without status "done"). Also called automatically when the
3951 cust_pay_pending method is used in a scalar context.
3955 sub num_cust_pay_pending {
3958 " SELECT COUNT(*) FROM cust_pay_pending ".
3959 " WHERE custnum = ? AND status != 'done' ",
3964 =item num_cust_pay_pending_attempt
3966 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3967 customer, with status "done" but without a corresp. Also called automatically when the
3968 cust_pay_pending method is used in a scalar context.
3972 sub num_cust_pay_pending_attempt {
3975 " SELECT COUNT(*) FROM cust_pay_pending ".
3976 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3983 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3989 map { $_ } #return $self->num_cust_refund unless wantarray;
3990 sort { $a->_date <=> $b->_date }
3991 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3994 =item display_custnum
3996 Returns the displayed customer number for this customer: agent_custid if
3997 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
4001 sub display_custnum {
4004 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
4005 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
4006 if ( $special eq 'CoStAg' ) {
4007 $prefix = uc( join('',
4009 ($self->state =~ /^(..)/),
4010 $prefix || ($self->agent->agent =~ /^(..)/)
4013 elsif ( $special eq 'CoStCl' ) {
4014 $prefix = uc( join('',
4016 ($self->state =~ /^(..)/),
4017 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
4020 # add any others here if needed
4023 my $length = $conf->config('cust_main-custnum-display_length');
4024 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
4025 return $self->agent_custid;
4026 } elsif ( $prefix ) {
4027 $length = 8 if !defined($length);
4029 sprintf('%0'.$length.'d', $self->custnum)
4030 } elsif ( $length ) {
4031 return sprintf('%0'.$length.'d', $self->custnum);
4033 return $self->custnum;
4039 Returns a name string for this customer, either "Company (Last, First)" or
4046 my $name = $self->contact;
4047 $name = $self->company. " ($name)" if $self->company;
4051 =item service_contact
4053 Returns the L<FS::contact> object for this customer that has the 'Service'
4054 contact class, or undef if there is no such contact. Deprecated; don't use
4059 sub service_contact {
4061 if ( !exists($self->{service_contact}) ) {
4062 my $classnum = $self->scalar_sql(
4063 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4064 ) || 0; #if it's zero, qsearchs will return nothing
4065 $self->{service_contact} = qsearchs('contact', {
4066 'classnum' => $classnum, 'custnum' => $self->custnum
4069 $self->{service_contact};
4074 Returns a name string for this (service/shipping) contact, either
4075 "Company (Last, First)" or "Last, First".
4082 my $name = $self->ship_contact;
4083 $name = $self->company. " ($name)" if $self->company;
4089 Returns a name string for this customer, either "Company" or "First Last".
4095 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4098 =item ship_name_short
4100 Returns a name string for this (service/shipping) contact, either "Company"
4105 sub ship_name_short {
4107 $self->service_contact
4108 ? $self->ship_contact_firstlast
4114 Returns this customer's full (billing) contact name only, "Last, First"
4120 $self->get('last'). ', '. $self->first;
4125 Returns this customer's full (shipping) contact name only, "Last, First"
4131 my $contact = $self->service_contact || $self;
4132 $contact->get('last') . ', ' . $contact->get('first');
4135 =item contact_firstlast
4137 Returns this customers full (billing) contact name only, "First Last".
4141 sub contact_firstlast {
4143 $self->first. ' '. $self->get('last');
4146 =item ship_contact_firstlast
4148 Returns this customer's full (shipping) contact name only, "First Last".
4152 sub ship_contact_firstlast {
4154 my $contact = $self->service_contact || $self;
4155 $contact->get('first') . ' '. $contact->get('last');
4158 #XXX this doesn't work in 3.x+
4161 #Returns this customer's full country name
4167 # code2country($self->country);
4170 sub bill_country_full {
4172 code2country($self->bill_location->country);
4175 sub ship_country_full {
4177 code2country($self->ship_location->country);
4180 =item county_state_county [ PREFIX ]
4182 Returns a string consisting of just the county, state and country.
4186 sub county_state_country {
4189 if ( @_ && $_[0] && $self->has_ship_address ) {
4190 $locationnum = $self->ship_locationnum;
4192 $locationnum = $self->bill_locationnum;
4194 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4195 $cust_location->county_state_country;
4198 =item geocode DATA_VENDOR
4200 Returns a value for the customer location as encoded by DATA_VENDOR.
4201 Currently this only makes sense for "CCH" as DATA_VENDOR.
4209 Returns a status string for this customer, currently:
4213 =item prospect - No packages have ever been ordered
4215 =item ordered - Recurring packages all are new (not yet billed).
4217 =item active - One or more recurring packages is active
4219 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4221 =item suspended - All non-cancelled recurring packages are suspended
4223 =item cancelled - All recurring packages are cancelled
4227 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4228 cust_main-status_module configuration option.
4232 sub status { shift->cust_status(@_); }
4236 for my $status ( FS::cust_main->statuses() ) {
4237 my $method = $status.'_sql';
4238 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4239 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4240 $sth->execute( ($self->custnum) x $numnum )
4241 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4242 return $status if $sth->fetchrow_arrayref->[0];
4246 =item ucfirst_cust_status
4248 =item ucfirst_status
4250 Returns the status with the first character capitalized.
4254 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4256 sub ucfirst_cust_status {
4258 ucfirst($self->cust_status);
4263 Returns a hex triplet color string for this customer's status.
4267 sub statuscolor { shift->cust_statuscolor(@_); }
4269 sub cust_statuscolor {
4271 __PACKAGE__->statuscolors->{$self->cust_status};
4274 =item tickets [ STATUS ]
4276 Returns an array of hashes representing the customer's RT tickets.
4278 An optional status (or arrayref or hashref of statuses) may be specified.
4284 my $status = ( @_ && $_[0] ) ? shift : '';
4286 my $num = $conf->config('cust_main-max_tickets') || 10;
4289 if ( $conf->config('ticket_system') ) {
4290 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4292 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4301 foreach my $priority (
4302 $conf->config('ticket_system-custom_priority_field-values'), ''
4304 last if scalar(@tickets) >= $num;
4306 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4307 $num - scalar(@tickets),
4318 # Return services representing svc_accts in customer support packages
4319 sub support_services {
4321 my %packages = map { $_ => 1 } $conf->config('support_packages');
4323 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4324 grep { $_->part_svc->svcdb eq 'svc_acct' }
4325 map { $_->cust_svc }
4326 grep { exists $packages{ $_->pkgpart } }
4327 $self->ncancelled_pkgs;
4331 # Return a list of latitude/longitude for one of the services (if any)
4332 sub service_coordinates {
4336 grep { $_->latitude && $_->longitude }
4338 map { $_->cust_svc }
4339 $self->ncancelled_pkgs;
4341 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4346 Returns a masked version of the named field
4351 my ($self,$field) = @_;
4355 'x'x(length($self->getfield($field))-4).
4356 substr($self->getfield($field), (length($self->getfield($field))-4));
4362 =head1 CLASS METHODS
4368 Class method that returns the list of possible status strings for customers
4369 (see L<the status method|/status>). For example:
4371 @statuses = FS::cust_main->statuses();
4377 keys %{ $self->statuscolors };
4380 =item cust_status_sql
4382 Returns an SQL fragment to determine the status of a cust_main record, as a
4387 sub cust_status_sql {
4389 for my $status ( FS::cust_main->statuses() ) {
4390 my $method = $status.'_sql';
4391 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4400 Returns an SQL expression identifying prospective cust_main records (customers
4401 with no packages ever ordered)
4405 use vars qw($select_count_pkgs);
4406 $select_count_pkgs =
4407 "SELECT COUNT(*) FROM cust_pkg
4408 WHERE cust_pkg.custnum = cust_main.custnum";
4410 sub select_count_pkgs_sql {
4415 " 0 = ( $select_count_pkgs ) ";
4420 Returns an SQL expression identifying ordered cust_main records (customers with
4421 no active packages, but recurring packages not yet setup or one time charges
4427 FS::cust_main->none_active_sql.
4428 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4433 Returns an SQL expression identifying active cust_main records (customers with
4434 active recurring packages).
4439 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4442 =item none_active_sql
4444 Returns an SQL expression identifying cust_main records with no active
4445 recurring packages. This includes customers of status prospect, ordered,
4446 inactive, and suspended.
4450 sub none_active_sql {
4451 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4456 Returns an SQL expression identifying inactive cust_main records (customers with
4457 no active recurring packages, but otherwise unsuspended/uncancelled).
4462 FS::cust_main->none_active_sql.
4463 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4469 Returns an SQL expression identifying suspended cust_main records.
4474 sub suspended_sql { susp_sql(@_); }
4476 FS::cust_main->none_active_sql.
4477 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4483 Returns an SQL expression identifying cancelled cust_main records.
4487 sub cancel_sql { shift->cancelled_sql(@_); }
4490 =item uncancelled_sql
4492 Returns an SQL expression identifying un-cancelled cust_main records.
4496 sub uncancelled_sql { uncancel_sql(@_); }
4497 sub uncancel_sql { "
4498 ( 0 < ( $select_count_pkgs
4499 AND ( cust_pkg.cancel IS NULL
4500 OR cust_pkg.cancel = 0
4503 OR 0 = ( $select_count_pkgs )
4509 Returns an SQL fragment to retreive the balance.
4514 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4515 WHERE cust_bill.custnum = cust_main.custnum )
4516 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4517 WHERE cust_pay.custnum = cust_main.custnum )
4518 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4519 WHERE cust_credit.custnum = cust_main.custnum )
4520 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4521 WHERE cust_refund.custnum = cust_main.custnum )
4524 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4526 Returns an SQL fragment to retreive the balance for this customer, optionally
4527 considering invoices with date earlier than START_TIME, and not
4528 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4529 total_unapplied_payments).
4531 Times are specified as SQL fragments or numeric
4532 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4533 L<Date::Parse> for conversion functions. The empty string can be passed
4534 to disable that time constraint completely.
4536 Available options are:
4540 =item unapplied_date
4542 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)
4547 set to true to remove all customer comparison clauses, for totals
4552 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4557 JOIN clause (typically used with the total option)
4561 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4562 time will be ignored. Note that START_TIME and END_TIME only limit the date
4563 range for invoices and I<unapplied> payments, credits, and refunds.
4569 sub balance_date_sql {
4570 my( $class, $start, $end, %opt ) = @_;
4572 my $cutoff = $opt{'cutoff'};
4574 my $owed = FS::cust_bill->owed_sql($cutoff);
4575 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4576 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4577 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4579 my $j = $opt{'join'} || '';
4581 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4582 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4583 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4584 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4586 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4587 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4588 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4589 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4594 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4596 Returns an SQL fragment to retreive the total unapplied payments for this
4597 customer, only considering payments with date earlier than START_TIME, and
4598 optionally not later than END_TIME.
4600 Times are specified as SQL fragments or numeric
4601 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4602 L<Date::Parse> for conversion functions. The empty string can be passed
4603 to disable that time constraint completely.
4605 Available options are:
4609 sub unapplied_payments_date_sql {
4610 my( $class, $start, $end, %opt ) = @_;
4612 my $cutoff = $opt{'cutoff'};
4614 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4616 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4617 'unapplied_date'=>1 );
4619 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4622 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4624 Helper method for balance_date_sql; name (and usage) subject to change
4625 (suggestions welcome).
4627 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4628 cust_refund, cust_credit or cust_pay).
4630 If TABLE is "cust_bill" or the unapplied_date option is true, only
4631 considers records with date earlier than START_TIME, and optionally not
4632 later than END_TIME .
4636 sub _money_table_where {
4637 my( $class, $table, $start, $end, %opt ) = @_;
4640 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4641 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4642 push @where, "$table._date <= $start" if defined($start) && length($start);
4643 push @where, "$table._date > $end" if defined($end) && length($end);
4645 push @where, @{$opt{'where'}} if $opt{'where'};
4646 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4652 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4653 use FS::cust_main::Search;
4656 FS::cust_main::Search->search(@_);
4671 #warn join('-',keys %$param);
4672 my $fh = $param->{filehandle};
4673 my $agentnum = $param->{agentnum};
4674 my $format = $param->{format};
4676 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4679 if ( $format eq 'simple' ) {
4680 @fields = qw( custnum agent_custid amount pkg );
4682 die "unknown format $format";
4685 eval "use Text::CSV_XS;";
4688 my $csv = new Text::CSV_XS;
4695 local $SIG{HUP} = 'IGNORE';
4696 local $SIG{INT} = 'IGNORE';
4697 local $SIG{QUIT} = 'IGNORE';
4698 local $SIG{TERM} = 'IGNORE';
4699 local $SIG{TSTP} = 'IGNORE';
4700 local $SIG{PIPE} = 'IGNORE';
4702 my $oldAutoCommit = $FS::UID::AutoCommit;
4703 local $FS::UID::AutoCommit = 0;
4706 #while ( $columns = $csv->getline($fh) ) {
4708 while ( defined($line=<$fh>) ) {
4710 $csv->parse($line) or do {
4711 $dbh->rollback if $oldAutoCommit;
4712 return "can't parse: ". $csv->error_input();
4715 my @columns = $csv->fields();
4716 #warn join('-',@columns);
4719 foreach my $field ( @fields ) {
4720 $row{$field} = shift @columns;
4723 if ( $row{custnum} && $row{agent_custid} ) {
4724 dbh->rollback if $oldAutoCommit;
4725 return "can't specify custnum with agent_custid $row{agent_custid}";
4729 if ( $row{agent_custid} && $agentnum ) {
4730 %hash = ( 'agent_custid' => $row{agent_custid},
4731 'agentnum' => $agentnum,
4735 if ( $row{custnum} ) {
4736 %hash = ( 'custnum' => $row{custnum} );
4739 unless ( scalar(keys %hash) ) {
4740 $dbh->rollback if $oldAutoCommit;
4741 return "can't find customer without custnum or agent_custid and agentnum";
4744 my $cust_main = qsearchs('cust_main', { %hash } );
4745 unless ( $cust_main ) {
4746 $dbh->rollback if $oldAutoCommit;
4747 my $custnum = $row{custnum} || $row{agent_custid};
4748 return "unknown custnum $custnum";
4751 if ( $row{'amount'} > 0 ) {
4752 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4754 $dbh->rollback if $oldAutoCommit;
4758 } elsif ( $row{'amount'} < 0 ) {
4759 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4762 $dbh->rollback if $oldAutoCommit;
4772 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4774 return "Empty file!" unless $imported;
4780 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4782 Deprecated. Use event notification and message templates
4783 (L<FS::msg_template>) instead.
4785 Sends a templated email notification to the customer (see L<Text::Template>).
4787 OPTIONS is a hash and may include
4789 I<from> - the email sender (default is invoice_from)
4791 I<to> - comma-separated scalar or arrayref of recipients
4792 (default is invoicing_list)
4794 I<subject> - The subject line of the sent email notification
4795 (default is "Notice from company_name")
4797 I<extra_fields> - a hashref of name/value pairs which will be substituted
4800 The following variables are vavailable in the template.
4802 I<$first> - the customer first name
4803 I<$last> - the customer last name
4804 I<$company> - the customer company
4805 I<$payby> - a description of the method of payment for the customer
4806 # would be nice to use FS::payby::shortname
4807 I<$payinfo> - the account information used to collect for this customer
4808 I<$expdate> - the expiration of the customer payment in seconds from epoch
4813 my ($self, $template, %options) = @_;
4815 return unless $conf->exists($template);
4817 my $from = $conf->config('invoice_from', $self->agentnum)
4818 if $conf->exists('invoice_from', $self->agentnum);
4819 $from = $options{from} if exists($options{from});
4821 my $to = join(',', $self->invoicing_list_emailonly);
4822 $to = $options{to} if exists($options{to});
4824 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4825 if $conf->exists('company_name', $self->agentnum);
4826 $subject = $options{subject} if exists($options{subject});
4828 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4829 SOURCE => [ map "$_\n",
4830 $conf->config($template)]
4832 or die "can't create new Text::Template object: Text::Template::ERROR";
4833 $notify_template->compile()
4834 or die "can't compile template: Text::Template::ERROR";
4836 $FS::notify_template::_template::company_name =
4837 $conf->config('company_name', $self->agentnum);
4838 $FS::notify_template::_template::company_address =
4839 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4841 my $paydate = $self->paydate || '2037-12-31';
4842 $FS::notify_template::_template::first = $self->first;
4843 $FS::notify_template::_template::last = $self->last;
4844 $FS::notify_template::_template::company = $self->company;
4845 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4846 my $payby = $self->payby;
4847 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4848 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4850 #credit cards expire at the end of the month/year of their exp date
4851 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4852 $FS::notify_template::_template::payby = 'credit card';
4853 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4854 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4856 }elsif ($payby eq 'COMP') {
4857 $FS::notify_template::_template::payby = 'complimentary account';
4859 $FS::notify_template::_template::payby = 'current method';
4861 $FS::notify_template::_template::expdate = $expire_time;
4863 for (keys %{$options{extra_fields}}){
4865 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4868 send_email(from => $from,
4870 subject => $subject,
4871 body => $notify_template->fill_in( PACKAGE =>
4872 'FS::notify_template::_template' ),
4877 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4879 Generates a templated notification to the customer (see L<Text::Template>).
4881 OPTIONS is a hash and may include
4883 I<extra_fields> - a hashref of name/value pairs which will be substituted
4884 into the template. These values may override values mentioned below
4885 and those from the customer record.
4887 The following variables are available in the template instead of or in addition
4888 to the fields of the customer record.
4890 I<$payby> - a description of the method of payment for the customer
4891 # would be nice to use FS::payby::shortname
4892 I<$payinfo> - the masked account information used to collect for this customer
4893 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4894 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4898 # a lot like cust_bill::print_latex
4899 sub generate_letter {
4900 my ($self, $template, %options) = @_;
4902 return unless $conf->exists($template);
4904 my $letter_template = new Text::Template
4906 SOURCE => [ map "$_\n", $conf->config($template)],
4907 DELIMITERS => [ '[@--', '--@]' ],
4909 or die "can't create new Text::Template object: Text::Template::ERROR";
4911 $letter_template->compile()
4912 or die "can't compile template: Text::Template::ERROR";
4914 my %letter_data = map { $_ => $self->$_ } $self->fields;
4915 $letter_data{payinfo} = $self->mask_payinfo;
4917 #my $paydate = $self->paydate || '2037-12-31';
4918 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4920 my $payby = $self->payby;
4921 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4922 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4924 #credit cards expire at the end of the month/year of their exp date
4925 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4926 $letter_data{payby} = 'credit card';
4927 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4928 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4930 }elsif ($payby eq 'COMP') {
4931 $letter_data{payby} = 'complimentary account';
4933 $letter_data{payby} = 'current method';
4935 $letter_data{expdate} = $expire_time;
4937 for (keys %{$options{extra_fields}}){
4938 $letter_data{$_} = $options{extra_fields}->{$_};
4941 unless(exists($letter_data{returnaddress})){
4942 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4943 $self->agent_template)
4945 if ( length($retadd) ) {
4946 $letter_data{returnaddress} = $retadd;
4947 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4948 $letter_data{returnaddress} =
4949 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4953 ( $conf->config('company_name', $self->agentnum),
4954 $conf->config('company_address', $self->agentnum),
4958 $letter_data{returnaddress} = '~';
4962 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4964 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4966 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4968 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4972 ) or die "can't open temp file: $!\n";
4973 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4974 or die "can't write temp file: $!\n";
4976 $letter_data{'logo_file'} = $lh->filename;
4978 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4982 ) or die "can't open temp file: $!\n";
4984 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4986 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4987 return ($1, $letter_data{'logo_file'});
4991 =item print_ps TEMPLATE
4993 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4999 my($file, $lfile) = $self->generate_letter(@_);
5000 my $ps = FS::Misc::generate_ps($file);
5001 unlink($file.'.tex');
5007 =item print TEMPLATE
5009 Prints the filled in template.
5011 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5015 sub queueable_print {
5018 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5019 or die "invalid customer number: " . $opt{custnum};
5021 my $error = $self->print( { 'template' => $opt{template} } );
5022 die $error if $error;
5026 my ($self, $template) = (shift, shift);
5028 [ $self->print_ps($template) ],
5029 'agentnum' => $self->agentnum,
5033 #these three subs should just go away once agent stuff is all config overrides
5035 sub agent_template {
5037 $self->_agent_plandata('agent_templatename');
5040 sub agent_invoice_from {
5042 $self->_agent_plandata('agent_invoice_from');
5045 sub _agent_plandata {
5046 my( $self, $option ) = @_;
5048 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5049 #agent-specific Conf
5051 use FS::part_event::Condition;
5053 my $agentnum = $self->agentnum;
5055 my $regexp = regexp_sql();
5057 my $part_event_option =
5059 'select' => 'part_event_option.*',
5060 'table' => 'part_event_option',
5062 LEFT JOIN part_event USING ( eventpart )
5063 LEFT JOIN part_event_option AS peo_agentnum
5064 ON ( part_event.eventpart = peo_agentnum.eventpart
5065 AND peo_agentnum.optionname = 'agentnum'
5066 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5068 LEFT JOIN part_event_condition
5069 ON ( part_event.eventpart = part_event_condition.eventpart
5070 AND part_event_condition.conditionname = 'cust_bill_age'
5072 LEFT JOIN part_event_condition_option
5073 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5074 AND part_event_condition_option.optionname = 'age'
5077 #'hashref' => { 'optionname' => $option },
5078 #'hashref' => { 'part_event_option.optionname' => $option },
5080 " WHERE part_event_option.optionname = ". dbh->quote($option).
5081 " AND action = 'cust_bill_send_agent' ".
5082 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5083 " AND peo_agentnum.optionname = 'agentnum' ".
5084 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5086 CASE WHEN part_event_condition_option.optionname IS NULL
5088 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5090 , part_event.weight".
5094 unless ( $part_event_option ) {
5095 return $self->agent->invoice_template || ''
5096 if $option eq 'agent_templatename';
5100 $part_event_option->optionvalue;
5104 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5106 Subroutine (not a method), designed to be called from the queue.
5108 Takes a list of options and values.
5110 Pulls up the customer record via the custnum option and calls bill_and_collect.
5115 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5117 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5118 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5120 #without this errors don't get rolled back
5121 $args{'fatal'} = 1; # runs from job queue, will be caught
5123 $cust_main->bill_and_collect( %args );
5126 sub process_bill_and_collect {
5128 my $param = thaw(decode_base64(shift));
5129 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5130 or die "custnum '$param->{custnum}' not found!\n";
5131 $param->{'job'} = $job;
5132 $param->{'fatal'} = 1; # runs from job queue, will be caught
5133 $param->{'retry'} = 1;
5135 $cust_main->bill_and_collect( %$param );
5138 #starting to take quite a while for big dbs
5139 # (JRNL: journaled so it only happens once per database)
5140 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5141 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5142 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5143 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5144 # JRNL leading/trailing spaces in first, last, company
5145 # - otaker upgrade? journal and call it good? (double check to make sure
5146 # we're not still setting otaker here)
5148 #only going to get worse with new location stuff...
5150 sub _upgrade_data { #class method
5151 my ($class, %opts) = @_;
5154 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5157 #this seems to be the only expensive one.. why does it take so long?
5158 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5160 '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';
5161 FS::upgrade_journal->set_done('cust_main__signupdate');
5164 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5166 # fix yyyy-m-dd formatted paydates
5167 if ( driver_name =~ /^mysql/i ) {
5169 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5170 } else { # the SQL standard
5172 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5174 FS::upgrade_journal->set_done('cust_main__paydate');
5177 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5179 push @statements, #fix the weird BILL with a cc# in payinfo problem
5181 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5183 FS::upgrade_journal->set_done('cust_main__payinfo');
5188 foreach my $sql ( @statements ) {
5189 my $sth = dbh->prepare($sql) or die dbh->errstr;
5190 $sth->execute or die $sth->errstr;
5191 #warn ( (time - $t). " seconds\n" );
5195 local($ignore_expired_card) = 1;
5196 local($ignore_banned_card) = 1;
5197 local($skip_fuzzyfiles) = 1;
5198 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5200 FS::cust_main::Location->_upgrade_data(%opts);
5202 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5204 foreach my $cust_main ( qsearch({
5205 'table' => 'cust_main',
5207 'extra_sql' => 'WHERE '.
5209 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5210 qw( first last company )
5213 my $error = $cust_main->replace;
5214 die $error if $error;
5217 FS::upgrade_journal->set_done('cust_main__trimspaces');
5221 $class->_upgrade_otaker(%opts);
5231 The delete method should possibly take an FS::cust_main object reference
5232 instead of a scalar customer number.
5234 Bill and collect options should probably be passed as references instead of a
5237 There should probably be a configuration file with a list of allowed credit
5240 No multiple currency support (probably a larger project than just this module).
5242 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5244 Birthdates rely on negative epoch values.
5246 The payby for card/check batches is broken. With mixed batching, bad
5249 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5253 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5254 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5255 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.