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::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
12 FS::geocode_Mixin FS::Quotable_Mixin
16 use vars qw( $DEBUG $me $conf
19 $ignore_expired_card $ignore_banned_card $ignore_illegal_zip
24 use Scalar::Util qw( blessed );
25 use Time::Local qw(timelocal);
26 use Storable qw(thaw);
30 use Digest::MD5 qw(md5_base64);
33 use File::Temp; #qw( tempfile );
34 use Business::CreditCard 0.28;
36 use FS::UID qw( dbh driver_name );
37 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
38 use FS::Misc qw( generate_email send_email generate_ps do_print );
39 use FS::Msgcat qw(gettext);
46 use FS::cust_bill_void;
47 use FS::legacy_cust_bill;
49 use FS::cust_pay_pending;
50 use FS::cust_pay_void;
51 use FS::cust_pay_batch;
54 use FS::part_referral;
55 use FS::cust_main_county;
56 use FS::cust_location;
58 use FS::cust_main_exemption;
59 use FS::cust_tax_adjustment;
60 use FS::cust_tax_location;
62 use FS::agent_currency;
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)) {
405 my $loc = delete $self->hashref->{$l};
406 # XXX if we're moving a prospect's locations, do that here
411 if ( !$loc->locationnum ) {
412 # warn the location that we're going to insert it with no custnum
413 $loc->set(custnum_pending => 1);
414 warn " inserting $l\n"
416 my $error = $loc->insert;
418 $dbh->rollback if $oldAutoCommit;
419 my $label = $l eq 'ship_location' ? 'service' : 'billing';
420 return "$error (in $label location)";
423 elsif ( ($loc->custnum || 0) > 0 or $loc->prospectnum ) {
424 # then it somehow belongs to another customer--shouldn't happen
425 $dbh->rollback if $oldAutoCommit;
426 return "$l belongs to customer ".$loc->custnum;
428 # else it already belongs to this customer
429 # (happens when ship_location is identical to bill_location)
431 $self->set($l.'num', $loc->locationnum);
433 if ( $self->get($l.'num') eq '' ) {
434 $dbh->rollback if $oldAutoCommit;
439 warn " inserting $self\n"
442 $self->signupdate(time) unless $self->signupdate;
444 $self->auto_agent_custid()
445 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
447 my $error = $self->SUPER::insert;
449 $dbh->rollback if $oldAutoCommit;
450 #return "inserting cust_main record (transaction rolled back): $error";
454 # now set cust_location.custnum
455 foreach my $l (qw(bill_location ship_location)) {
456 warn " setting $l.custnum\n"
459 unless ( $loc->custnum ) {
460 $loc->set(custnum => $self->custnum);
461 $error ||= $loc->replace;
465 $dbh->rollback if $oldAutoCommit;
466 return "error setting $l custnum: $error";
470 warn " setting invoicing list\n"
473 if ( $invoicing_list ) {
474 $error = $self->check_invoicing_list( $invoicing_list );
476 $dbh->rollback if $oldAutoCommit;
477 #return "checking invoicing_list (transaction rolled back): $error";
480 $self->invoicing_list( $invoicing_list );
483 warn " setting customer tags\n"
486 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
487 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
488 'custnum' => $self->custnum };
489 my $error = $cust_tag->insert;
491 $dbh->rollback if $oldAutoCommit;
496 my $prospectnum = delete $options{'prospectnum'};
497 if ( $prospectnum ) {
499 warn " moving contacts and locations from prospect $prospectnum\n"
503 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
504 unless ( $prospect_main ) {
505 $dbh->rollback if $oldAutoCommit;
506 return "Unknown prospectnum $prospectnum";
508 $prospect_main->custnum($self->custnum);
509 $prospect_main->disabled('Y');
510 my $error = $prospect_main->replace;
512 $dbh->rollback if $oldAutoCommit;
516 my @contact = $prospect_main->contact;
517 my @cust_location = $prospect_main->cust_location;
518 my @qual = $prospect_main->qual;
520 foreach my $r ( @contact, @cust_location, @qual ) {
522 $r->custnum($self->custnum);
523 my $error = $r->replace;
525 $dbh->rollback if $oldAutoCommit;
532 warn " setting cust_main_exemption\n"
535 my $tax_exemption = delete $options{'tax_exemption'};
536 if ( $tax_exemption ) {
538 $tax_exemption = { map { $_ => '' } @$tax_exemption }
539 if ref($tax_exemption) eq 'ARRAY';
541 foreach my $taxname ( keys %$tax_exemption ) {
542 my $cust_main_exemption = new FS::cust_main_exemption {
543 'custnum' => $self->custnum,
544 'taxname' => $taxname,
545 'exempt_number' => $tax_exemption->{$taxname},
547 my $error = $cust_main_exemption->insert;
549 $dbh->rollback if $oldAutoCommit;
550 return "inserting cust_main_exemption (transaction rolled back): $error";
555 warn " ordering packages\n"
558 $error = $self->order_pkgs( $cust_pkgs,
560 'seconds_ref' => \$seconds,
561 'upbytes_ref' => \$upbytes,
562 'downbytes_ref' => \$downbytes,
563 'totalbytes_ref' => \$totalbytes,
566 $dbh->rollback if $oldAutoCommit;
571 $dbh->rollback if $oldAutoCommit;
572 return "No svc_acct record to apply pre-paid time";
574 if ( $upbytes || $downbytes || $totalbytes ) {
575 $dbh->rollback if $oldAutoCommit;
576 return "No svc_acct record to apply pre-paid data";
580 warn " inserting initial $payby payment of $amount\n"
582 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
584 $dbh->rollback if $oldAutoCommit;
585 return "inserting payment (transaction rolled back): $error";
589 unless ( $import || $skip_fuzzyfiles ) {
590 warn " queueing fuzzyfiles update\n"
592 $error = $self->queue_fuzzyfiles_update;
594 $dbh->rollback if $oldAutoCommit;
595 return "updating fuzzy search cache: $error";
599 # FS::geocode_Mixin::after_insert or something?
600 if ( $conf->config('tax_district_method') and !$import ) {
601 # if anything non-empty, try to look it up
602 my $queue = new FS::queue {
603 'job' => 'FS::geocode_Mixin::process_district_update',
604 'custnum' => $self->custnum,
606 my $error = $queue->insert( ref($self), $self->custnum );
608 $dbh->rollback if $oldAutoCommit;
609 return "queueing tax district update: $error";
614 warn " exporting\n" if $DEBUG > 1;
616 my $export_args = $options{'export_args'} || [];
619 map qsearch( 'part_export', {exportnum=>$_} ),
620 $conf->config('cust_main-exports'); #, $agentnum
622 foreach my $part_export ( @part_export ) {
623 my $error = $part_export->export_insert($self, @$export_args);
625 $dbh->rollback if $oldAutoCommit;
626 return "exporting to ". $part_export->exporttype.
627 " (transaction rolled back): $error";
631 #foreach my $depend_jobnum ( @$depend_jobnums ) {
632 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
634 # foreach my $jobnum ( @jobnums ) {
635 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
636 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
638 # my $error = $queue->depend_insert($depend_jobnum);
640 # $dbh->rollback if $oldAutoCommit;
641 # return "error queuing job dependancy: $error";
648 #if ( exists $options{'jobnums'} ) {
649 # push @{ $options{'jobnums'} }, @jobnums;
652 warn " insert complete; committing transaction\n"
655 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
660 use File::CounterFile;
661 sub auto_agent_custid {
664 my $format = $conf->config('cust_main-auto_agent_custid');
666 if ( $format eq '1YMMXXXXXXXX' ) {
668 my $counter = new File::CounterFile 'cust_main.agent_custid';
671 my $ym = 100000000000 + time2str('%y%m00000000', time);
672 if ( $ym > $counter->value ) {
673 $counter->{'value'} = $agent_custid = $ym;
674 $counter->{'updated'} = 1;
676 $agent_custid = $counter->inc;
682 die "Unknown cust_main-auto_agent_custid format: $format";
685 $self->agent_custid($agent_custid);
689 =item PACKAGE METHODS
691 Documentation on customer package methods has been moved to
692 L<FS::cust_main::Packages>.
694 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
696 Recharges this (existing) customer with the specified prepaid card (see
697 L<FS::prepay_credit>), specified either by I<identifier> or as an
698 FS::prepay_credit object. If there is an error, returns the error, otherwise
701 Optionally, five scalar references can be passed as well. They will have their
702 values filled in with the amount, number of seconds, and number of upload,
703 download, and total bytes applied by this prepaid card.
707 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
708 #the only place that uses these args
709 sub recharge_prepay {
710 my( $self, $prepay_credit, $amountref, $secondsref,
711 $upbytesref, $downbytesref, $totalbytesref ) = @_;
713 local $SIG{HUP} = 'IGNORE';
714 local $SIG{INT} = 'IGNORE';
715 local $SIG{QUIT} = 'IGNORE';
716 local $SIG{TERM} = 'IGNORE';
717 local $SIG{TSTP} = 'IGNORE';
718 local $SIG{PIPE} = 'IGNORE';
720 my $oldAutoCommit = $FS::UID::AutoCommit;
721 local $FS::UID::AutoCommit = 0;
724 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
726 my $error = $self->get_prepay( $prepay_credit,
727 'amount_ref' => \$amount,
728 'seconds_ref' => \$seconds,
729 'upbytes_ref' => \$upbytes,
730 'downbytes_ref' => \$downbytes,
731 'totalbytes_ref' => \$totalbytes,
733 || $self->increment_seconds($seconds)
734 || $self->increment_upbytes($upbytes)
735 || $self->increment_downbytes($downbytes)
736 || $self->increment_totalbytes($totalbytes)
737 || $self->insert_cust_pay_prepay( $amount,
739 ? $prepay_credit->identifier
744 $dbh->rollback if $oldAutoCommit;
748 if ( defined($amountref) ) { $$amountref = $amount; }
749 if ( defined($secondsref) ) { $$secondsref = $seconds; }
750 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
751 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
752 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
754 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
759 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
761 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
762 specified either by I<identifier> or as an FS::prepay_credit object.
764 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
765 incremented by the values of the prepaid card.
767 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
768 check or set this customer's I<agentnum>.
770 If there is an error, returns the error, otherwise returns false.
776 my( $self, $prepay_credit, %opt ) = @_;
778 local $SIG{HUP} = 'IGNORE';
779 local $SIG{INT} = 'IGNORE';
780 local $SIG{QUIT} = 'IGNORE';
781 local $SIG{TERM} = 'IGNORE';
782 local $SIG{TSTP} = 'IGNORE';
783 local $SIG{PIPE} = 'IGNORE';
785 my $oldAutoCommit = $FS::UID::AutoCommit;
786 local $FS::UID::AutoCommit = 0;
789 unless ( ref($prepay_credit) ) {
791 my $identifier = $prepay_credit;
793 $prepay_credit = qsearchs(
795 { 'identifier' => $identifier },
800 unless ( $prepay_credit ) {
801 $dbh->rollback if $oldAutoCommit;
802 return "Invalid prepaid card: ". $identifier;
807 if ( $prepay_credit->agentnum ) {
808 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
809 $dbh->rollback if $oldAutoCommit;
810 return "prepaid card not valid for agent ". $self->agentnum;
812 $self->agentnum($prepay_credit->agentnum);
815 my $error = $prepay_credit->delete;
817 $dbh->rollback if $oldAutoCommit;
818 return "removing prepay_credit (transaction rolled back): $error";
821 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
822 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
824 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
829 =item increment_upbytes SECONDS
831 Updates this customer's single or primary account (see L<FS::svc_acct>) by
832 the specified number of upbytes. If there is an error, returns the error,
833 otherwise returns false.
837 sub increment_upbytes {
838 _increment_column( shift, 'upbytes', @_);
841 =item increment_downbytes SECONDS
843 Updates this customer's single or primary account (see L<FS::svc_acct>) by
844 the specified number of downbytes. If there is an error, returns the error,
845 otherwise returns false.
849 sub increment_downbytes {
850 _increment_column( shift, 'downbytes', @_);
853 =item increment_totalbytes SECONDS
855 Updates this customer's single or primary account (see L<FS::svc_acct>) by
856 the specified number of totalbytes. If there is an error, returns the error,
857 otherwise returns false.
861 sub increment_totalbytes {
862 _increment_column( shift, 'totalbytes', @_);
865 =item increment_seconds SECONDS
867 Updates this customer's single or primary account (see L<FS::svc_acct>) by
868 the specified number of seconds. If there is an error, returns the error,
869 otherwise returns false.
873 sub increment_seconds {
874 _increment_column( shift, 'seconds', @_);
877 =item _increment_column AMOUNT
879 Updates this customer's single or primary account (see L<FS::svc_acct>) by
880 the specified number of seconds or bytes. If there is an error, returns
881 the error, otherwise returns false.
885 sub _increment_column {
886 my( $self, $column, $amount ) = @_;
887 warn "$me increment_column called: $column, $amount\n"
890 return '' unless $amount;
892 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
893 $self->ncancelled_pkgs;
896 return 'No packages with primary or single services found'.
897 ' to apply pre-paid time';
898 } elsif ( scalar(@cust_pkg) > 1 ) {
899 #maybe have a way to specify the package/account?
900 return 'Multiple packages found to apply pre-paid time';
903 my $cust_pkg = $cust_pkg[0];
904 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
908 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
911 return 'No account found to apply pre-paid time';
912 } elsif ( scalar(@cust_svc) > 1 ) {
913 return 'Multiple accounts found to apply pre-paid time';
916 my $svc_acct = $cust_svc[0]->svc_x;
917 warn " found service svcnum ". $svc_acct->pkgnum.
918 ' ('. $svc_acct->email. ")\n"
921 $column = "increment_$column";
922 $svc_acct->$column($amount);
926 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
928 Inserts a prepayment in the specified amount for this customer. An optional
929 second argument can specify the prepayment identifier for tracking purposes.
930 If there is an error, returns the error, otherwise returns false.
934 sub insert_cust_pay_prepay {
935 shift->insert_cust_pay('PREP', @_);
938 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
940 Inserts a cash payment in the specified amount for this customer. An optional
941 second argument can specify the payment identifier for tracking purposes.
942 If there is an error, returns the error, otherwise returns false.
946 sub insert_cust_pay_cash {
947 shift->insert_cust_pay('CASH', @_);
950 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
952 Inserts a Western Union payment in the specified amount for this customer. An
953 optional second argument can specify the prepayment identifier for tracking
954 purposes. If there is an error, returns the error, otherwise returns false.
958 sub insert_cust_pay_west {
959 shift->insert_cust_pay('WEST', @_);
962 sub insert_cust_pay {
963 my( $self, $payby, $amount ) = splice(@_, 0, 3);
964 my $payinfo = scalar(@_) ? shift : '';
966 my $cust_pay = new FS::cust_pay {
967 'custnum' => $self->custnum,
968 'paid' => sprintf('%.2f', $amount),
969 #'_date' => #date the prepaid card was purchased???
971 'payinfo' => $payinfo,
977 =item delete [ OPTION => VALUE ... ]
979 This deletes the customer. If there is an error, returns the error, otherwise
982 This will completely remove all traces of the customer record. This is not
983 what you want when a customer cancels service; for that, cancel all of the
984 customer's packages (see L</cancel>).
986 If the customer has any uncancelled packages, you need to pass a new (valid)
987 customer number for those packages to be transferred to, as the "new_customer"
988 option. Cancelled packages will be deleted. Did I mention that this is NOT
989 what you want when a customer cancels service and that you really should be
990 looking at L<FS::cust_pkg/cancel>?
992 You can't delete a customer with invoices (see L<FS::cust_bill>),
993 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
994 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
995 set the "delete_financials" option to a true value.
1000 my( $self, %opt ) = @_;
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 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1014 $dbh->rollback if $oldAutoCommit;
1015 return "Can't delete a master agent customer";
1018 #use FS::access_user
1019 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1020 $dbh->rollback if $oldAutoCommit;
1021 return "Can't delete a master employee customer";
1024 tie my %financial_tables, 'Tie::IxHash',
1025 'cust_bill' => 'invoices',
1026 'cust_statement' => 'statements',
1027 'cust_credit' => 'credits',
1028 'cust_pay' => 'payments',
1029 'cust_refund' => 'refunds',
1032 foreach my $table ( keys %financial_tables ) {
1034 my @records = $self->$table();
1036 if ( @records && ! $opt{'delete_financials'} ) {
1037 $dbh->rollback if $oldAutoCommit;
1038 return "Can't delete a customer with ". $financial_tables{$table};
1041 foreach my $record ( @records ) {
1042 my $error = $record->delete;
1044 $dbh->rollback if $oldAutoCommit;
1045 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1051 my @cust_pkg = $self->ncancelled_pkgs;
1053 my $new_custnum = $opt{'new_custnum'};
1054 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1055 $dbh->rollback if $oldAutoCommit;
1056 return "Invalid new customer number: $new_custnum";
1058 foreach my $cust_pkg ( @cust_pkg ) {
1059 my %hash = $cust_pkg->hash;
1060 $hash{'custnum'} = $new_custnum;
1061 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1062 my $error = $new_cust_pkg->replace($cust_pkg,
1063 options => { $cust_pkg->options },
1066 $dbh->rollback if $oldAutoCommit;
1071 my @cancelled_cust_pkg = $self->all_pkgs;
1072 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1073 my $error = $cust_pkg->delete;
1075 $dbh->rollback if $oldAutoCommit;
1080 #cust_tax_adjustment in financials?
1081 #cust_pay_pending? ouch
1083 foreach my $table (qw(
1084 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1085 cust_location cust_main_note cust_tax_adjustment
1086 cust_pay_void cust_pay_batch queue cust_tax_exempt
1088 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1089 my $error = $record->delete;
1091 $dbh->rollback if $oldAutoCommit;
1097 my $sth = $dbh->prepare(
1098 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1100 my $errstr = $dbh->errstr;
1101 $dbh->rollback if $oldAutoCommit;
1104 $sth->execute($self->custnum) or do {
1105 my $errstr = $sth->errstr;
1106 $dbh->rollback if $oldAutoCommit;
1112 my $ticket_dbh = '';
1113 if ($conf->config('ticket_system') eq 'RT_Internal') {
1115 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1116 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1117 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1118 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1121 if ( $ticket_dbh ) {
1123 my $ticket_sth = $ticket_dbh->prepare(
1124 'DELETE FROM Links WHERE Target = ?'
1126 my $errstr = $ticket_dbh->errstr;
1127 $dbh->rollback if $oldAutoCommit;
1130 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1132 my $errstr = $ticket_sth->errstr;
1133 $dbh->rollback if $oldAutoCommit;
1137 #check and see if the customer is the only link on the ticket, and
1138 #if so, set the ticket to deleted status in RT?
1139 #maybe someday, for now this will at least fix tickets not displaying
1143 #delete the customer record
1145 my $error = $self->SUPER::delete;
1147 $dbh->rollback if $oldAutoCommit;
1151 # cust_main exports!
1153 #my $export_args = $options{'export_args'} || [];
1156 map qsearch( 'part_export', {exportnum=>$_} ),
1157 $conf->config('cust_main-exports'); #, $agentnum
1159 foreach my $part_export ( @part_export ) {
1160 my $error = $part_export->export_delete( $self ); #, @$export_args);
1162 $dbh->rollback if $oldAutoCommit;
1163 return "exporting to ". $part_export->exporttype.
1164 " (transaction rolled back): $error";
1168 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1173 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1175 This merges this customer into the provided new custnum, and then deletes the
1176 customer. If there is an error, returns the error, otherwise returns false.
1178 The source customer's name, company name, phone numbers, agent,
1179 referring customer, customer class, advertising source, order taker, and
1180 billing information (except balance) are discarded.
1182 All packages are moved to the target customer. Packages with package locations
1183 are preserved. Packages without package locations are moved to a new package
1184 location with the source customer's service/shipping address.
1186 All invoices, statements, payments, credits and refunds are moved to the target
1187 customer. The source customer's balance is added to the target customer.
1189 All notes, attachments, tickets and customer tags are moved to the target
1192 Change history is not currently moved.
1197 my( $self, $new_custnum, %opt ) = @_;
1199 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1201 my $new_cust_main = qsearchs( 'cust_main', { 'custnum' => $new_custnum } )
1202 or return "Invalid new customer number: $new_custnum";
1204 return 'Access denied: "Merge customer across agents" access right required to merge into a customer of a different agent'
1205 if $self->agentnum != $new_cust_main->agentnum
1206 && ! $FS::CurrentUser::CurrentUser->access_right('Merge customer across agents');
1208 local $SIG{HUP} = 'IGNORE';
1209 local $SIG{INT} = 'IGNORE';
1210 local $SIG{QUIT} = 'IGNORE';
1211 local $SIG{TERM} = 'IGNORE';
1212 local $SIG{TSTP} = 'IGNORE';
1213 local $SIG{PIPE} = 'IGNORE';
1215 my $oldAutoCommit = $FS::UID::AutoCommit;
1216 local $FS::UID::AutoCommit = 0;
1219 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1220 $dbh->rollback if $oldAutoCommit;
1221 return "Can't merge a master agent customer";
1224 #use FS::access_user
1225 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1226 $dbh->rollback if $oldAutoCommit;
1227 return "Can't merge a master employee customer";
1230 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1231 'status' => { op=>'!=', value=>'done' },
1235 $dbh->rollback if $oldAutoCommit;
1236 return "Can't merge a customer with pending payments";
1239 tie my %financial_tables, 'Tie::IxHash',
1240 'cust_bill' => 'invoices',
1241 'cust_bill_void' => 'voided invoices',
1242 'cust_statement' => 'statements',
1243 'cust_credit' => 'credits',
1244 'cust_pay' => 'payments',
1245 'cust_pay_void' => 'voided payments',
1246 'cust_refund' => 'refunds',
1249 foreach my $table ( keys %financial_tables ) {
1251 my @records = $self->$table();
1253 foreach my $record ( @records ) {
1254 $record->custnum($new_custnum);
1255 my $error = $record->replace;
1257 $dbh->rollback if $oldAutoCommit;
1258 return "Error merging ". $financial_tables{$table}. ": $error\n";
1264 my $name = $self->ship_name; #?
1266 my $locationnum = '';
1267 foreach my $cust_pkg ( $self->all_pkgs ) {
1268 $cust_pkg->custnum($new_custnum);
1270 unless ( $cust_pkg->locationnum ) {
1271 unless ( $locationnum ) {
1272 my $cust_location = new FS::cust_location {
1273 $self->location_hash,
1274 'custnum' => $new_custnum,
1276 my $error = $cust_location->insert;
1278 $dbh->rollback if $oldAutoCommit;
1281 $locationnum = $cust_location->locationnum;
1283 $cust_pkg->locationnum($locationnum);
1286 my $error = $cust_pkg->replace;
1288 $dbh->rollback if $oldAutoCommit;
1292 # add customer (ship) name to svc_phone.phone_name if blank
1293 my @cust_svc = $cust_pkg->cust_svc;
1294 foreach my $cust_svc (@cust_svc) {
1295 my($label, $value, $svcdb) = $cust_svc->label;
1296 next unless $svcdb eq 'svc_phone';
1297 my $svc_phone = $cust_svc->svc_x;
1298 next if $svc_phone->phone_name;
1299 $svc_phone->phone_name($name);
1300 my $error = $svc_phone->replace;
1302 $dbh->rollback if $oldAutoCommit;
1310 # cust_tax_exempt (texas tax exemptions)
1311 # cust_recon (some sort of not-well understood thing for OnPac)
1313 #these are moved over
1314 foreach my $table (qw(
1315 cust_tag cust_location contact cust_attachment cust_main_note
1316 cust_tax_adjustment cust_pay_batch queue
1318 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1319 $record->custnum($new_custnum);
1320 my $error = $record->replace;
1322 $dbh->rollback if $oldAutoCommit;
1328 #these aren't preserved
1329 foreach my $table (qw(
1330 cust_main_exemption cust_main_invoice
1332 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1333 my $error = $record->delete;
1335 $dbh->rollback if $oldAutoCommit;
1342 my $sth = $dbh->prepare(
1343 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1345 my $errstr = $dbh->errstr;
1346 $dbh->rollback if $oldAutoCommit;
1349 $sth->execute($new_custnum, $self->custnum) or do {
1350 my $errstr = $sth->errstr;
1351 $dbh->rollback if $oldAutoCommit;
1357 my $ticket_dbh = '';
1358 if ($conf->config('ticket_system') eq 'RT_Internal') {
1360 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1361 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1362 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1363 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1366 if ( $ticket_dbh ) {
1368 my $ticket_sth = $ticket_dbh->prepare(
1369 'UPDATE Links SET Target = ? WHERE Target = ?'
1371 my $errstr = $ticket_dbh->errstr;
1372 $dbh->rollback if $oldAutoCommit;
1375 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1376 'freeside://freeside/cust_main/'.$self->custnum)
1378 my $errstr = $ticket_sth->errstr;
1379 $dbh->rollback if $oldAutoCommit;
1385 #delete the customer record
1387 my $error = $self->delete;
1389 $dbh->rollback if $oldAutoCommit;
1393 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1398 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1400 Replaces the OLD_RECORD with this one in the database. If there is an error,
1401 returns the error, otherwise returns false.
1403 To change the customer's address, set the pseudo-fields C<bill_location> and
1404 C<ship_location>. The address will still only change if at least one of the
1405 address fields differs from the existing values.
1407 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1408 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1409 expected and rollback the entire transaction; it is not necessary to call
1410 check_invoicing_list first. Here's an example:
1412 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1414 Currently available options are: I<tax_exemption>.
1416 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1417 of tax names and exemption numbers. FS::cust_main_exemption records will be
1418 deleted and inserted as appropriate.
1425 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1427 : $self->replace_old;
1431 warn "$me replace called\n"
1434 my $curuser = $FS::CurrentUser::CurrentUser;
1435 if ( $self->payby eq 'COMP'
1436 && $self->payby ne $old->payby
1437 && ! $curuser->access_right('Complimentary customer')
1440 return "You are not permitted to create complimentary accounts.";
1443 local($ignore_expired_card) = 1
1444 if $old->payby =~ /^(CARD|DCRD)$/
1445 && $self->payby =~ /^(CARD|DCRD)$/
1446 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1448 local($ignore_banned_card) = 1
1449 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1450 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1451 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1453 return "Invoicing locale is required"
1456 && $conf->exists('cust_main-require_locale');
1458 local $SIG{HUP} = 'IGNORE';
1459 local $SIG{INT} = 'IGNORE';
1460 local $SIG{QUIT} = 'IGNORE';
1461 local $SIG{TERM} = 'IGNORE';
1462 local $SIG{TSTP} = 'IGNORE';
1463 local $SIG{PIPE} = 'IGNORE';
1465 my $oldAutoCommit = $FS::UID::AutoCommit;
1466 local $FS::UID::AutoCommit = 0;
1469 for my $l (qw(bill_location ship_location)) {
1470 my $old_loc = $old->$l;
1471 my $new_loc = $self->$l;
1473 # find the existing location if there is one
1474 $new_loc->set('custnum' => $self->custnum);
1475 my $error = $new_loc->find_or_insert;
1477 $dbh->rollback if $oldAutoCommit;
1480 $self->set($l.'num', $new_loc->locationnum);
1483 # replace the customer record
1484 my $error = $self->SUPER::replace($old);
1487 $dbh->rollback if $oldAutoCommit;
1491 # now move packages to the new service location
1492 $self->set('ship_location', ''); #flush cache
1493 if ( $old->ship_locationnum and # should only be null during upgrade...
1494 $old->ship_locationnum != $self->ship_locationnum ) {
1495 $error = $old->ship_location->move_to($self->ship_location);
1497 $dbh->rollback if $oldAutoCommit;
1501 # don't move packages based on the billing location, but
1502 # disable it if it's no longer in use
1503 if ( $old->bill_locationnum and
1504 $old->bill_locationnum != $self->bill_locationnum ) {
1505 $error = $old->bill_location->disable_if_unused;
1507 $dbh->rollback if $oldAutoCommit;
1512 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1513 my $invoicing_list = shift @param;
1514 $error = $self->check_invoicing_list( $invoicing_list );
1516 $dbh->rollback if $oldAutoCommit;
1519 $self->invoicing_list( $invoicing_list );
1522 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1524 #this could be more efficient than deleting and re-inserting, if it matters
1525 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1526 my $error = $cust_tag->delete;
1528 $dbh->rollback if $oldAutoCommit;
1532 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1533 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1534 'custnum' => $self->custnum };
1535 my $error = $cust_tag->insert;
1537 $dbh->rollback if $oldAutoCommit;
1544 my %options = @param;
1546 my $tax_exemption = delete $options{'tax_exemption'};
1547 if ( $tax_exemption ) {
1549 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1550 if ref($tax_exemption) eq 'ARRAY';
1552 my %cust_main_exemption =
1553 map { $_->taxname => $_ }
1554 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1556 foreach my $taxname ( keys %$tax_exemption ) {
1558 if ( $cust_main_exemption{$taxname} &&
1559 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1562 delete $cust_main_exemption{$taxname};
1566 my $cust_main_exemption = new FS::cust_main_exemption {
1567 'custnum' => $self->custnum,
1568 'taxname' => $taxname,
1569 'exempt_number' => $tax_exemption->{$taxname},
1571 my $error = $cust_main_exemption->insert;
1573 $dbh->rollback if $oldAutoCommit;
1574 return "inserting cust_main_exemption (transaction rolled back): $error";
1578 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1579 my $error = $cust_main_exemption->delete;
1581 $dbh->rollback if $oldAutoCommit;
1582 return "deleting cust_main_exemption (transaction rolled back): $error";
1588 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1589 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1590 && $self->get('payinfo') !~ /^99\d{14}$/
1592 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1597 # card/check/lec info has changed, want to retry realtime_ invoice events
1598 my $error = $self->retry_realtime;
1600 $dbh->rollback if $oldAutoCommit;
1605 unless ( $import || $skip_fuzzyfiles ) {
1606 $error = $self->queue_fuzzyfiles_update;
1608 $dbh->rollback if $oldAutoCommit;
1609 return "updating fuzzy search cache: $error";
1613 # tax district update in cust_location
1615 # cust_main exports!
1617 my $export_args = $options{'export_args'} || [];
1620 map qsearch( 'part_export', {exportnum=>$_} ),
1621 $conf->config('cust_main-exports'); #, $agentnum
1623 foreach my $part_export ( @part_export ) {
1624 my $error = $part_export->export_replace( $self, $old, @$export_args);
1626 $dbh->rollback if $oldAutoCommit;
1627 return "exporting to ". $part_export->exporttype.
1628 " (transaction rolled back): $error";
1632 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1637 =item queue_fuzzyfiles_update
1639 Used by insert & replace to update the fuzzy search cache
1643 use FS::cust_main::Search;
1644 sub queue_fuzzyfiles_update {
1647 local $SIG{HUP} = 'IGNORE';
1648 local $SIG{INT} = 'IGNORE';
1649 local $SIG{QUIT} = 'IGNORE';
1650 local $SIG{TERM} = 'IGNORE';
1651 local $SIG{TSTP} = 'IGNORE';
1652 local $SIG{PIPE} = 'IGNORE';
1654 my $oldAutoCommit = $FS::UID::AutoCommit;
1655 local $FS::UID::AutoCommit = 0;
1658 my @locations = $self->bill_location;
1659 push @locations, $self->ship_location if $self->has_ship_address;
1660 foreach my $location (@locations) {
1661 my $queue = new FS::queue {
1662 'job' => 'FS::cust_main::Search::append_fuzzyfiles'
1664 my @args = map $location->get($_), @FS::cust_main::Search::fuzzyfields;
1665 my $error = $queue->insert( @args );
1667 $dbh->rollback if $oldAutoCommit;
1668 return "queueing job (transaction rolled back): $error";
1672 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1679 Checks all fields to make sure this is a valid customer record. If there is
1680 an error, returns the error, otherwise returns false. Called by the insert
1681 and replace methods.
1688 warn "$me check BEFORE: \n". $self->_dump
1692 $self->ut_numbern('custnum')
1693 || $self->ut_number('agentnum')
1694 || $self->ut_textn('agent_custid')
1695 || $self->ut_number('refnum')
1696 || $self->ut_foreign_key('bill_locationnum', 'cust_location','locationnum')
1697 || $self->ut_foreign_key('ship_locationnum', 'cust_location','locationnum')
1698 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1699 || $self->ut_textn('custbatch')
1700 || $self->ut_name('last')
1701 || $self->ut_name('first')
1702 || $self->ut_snumbern('signupdate')
1703 || $self->ut_snumbern('birthdate')
1704 || $self->ut_snumbern('spouse_birthdate')
1705 || $self->ut_snumbern('anniversary_date')
1706 || $self->ut_textn('company')
1707 || $self->ut_anything('comments')
1708 || $self->ut_numbern('referral_custnum')
1709 || $self->ut_textn('stateid')
1710 || $self->ut_textn('stateid_state')
1711 || $self->ut_textn('invoice_terms')
1712 || $self->ut_floatn('cdr_termination_percentage')
1713 || $self->ut_floatn('credit_limit')
1714 || $self->ut_numbern('billday')
1715 || $self->ut_numbern('prorate_day')
1716 || $self->ut_flag('edit_subject')
1717 || $self->ut_flag('calling_list_exempt')
1718 || $self->ut_flag('invoice_noemail')
1719 || $self->ut_flag('message_noemail')
1720 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1721 || $self->ut_currencyn('currency')
1724 my $company = $self->company;
1725 $company =~ s/^\s+//;
1726 $company =~ s/\s+$//;
1727 $company =~ s/\s+/ /g;
1728 $self->company($company);
1730 #barf. need message catalogs. i18n. etc.
1731 $error .= "Please select an advertising source."
1732 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1733 return $error if $error;
1735 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1736 or return "Unknown agent";
1738 if ( $self->currency ) {
1739 my $agent_currency = qsearchs( 'agent_currency', {
1740 'agentnum' => $agent->agentnum,
1741 'currency' => $self->currency,
1743 or return "Agent ". $agent->agent.
1744 " not permitted to offer ". $self->currency. " invoicing";
1747 return "Unknown refnum"
1748 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1750 return "Unknown referring custnum: ". $self->referral_custnum
1751 unless ! $self->referral_custnum
1752 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1754 if ( $self->ss eq '' ) {
1759 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1760 or return "Illegal social security number: ". $self->ss;
1761 $self->ss("$1-$2-$3");
1764 # cust_main_county verification now handled by cust_location check
1767 $self->ut_phonen('daytime', $self->country)
1768 || $self->ut_phonen('night', $self->country)
1769 || $self->ut_phonen('fax', $self->country)
1770 || $self->ut_phonen('mobile', $self->country)
1772 return $error if $error;
1774 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1776 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1779 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1781 : FS::Msgcat::_gettext('daytime');
1782 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1784 : FS::Msgcat::_gettext('night');
1786 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1788 : FS::Msgcat::_gettext('mobile');
1790 return "$daytime_label, $night_label or $mobile_label is required"
1794 ### start of stuff moved to cust_payby
1796 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1797 # or return "Illegal payby: ". $self->payby;
1799 FS::payby->can_payby($self->table, $self->payby)
1800 or return "Illegal payby: ". $self->payby;
1802 $error = $self->ut_numbern('paystart_month')
1803 || $self->ut_numbern('paystart_year')
1804 || $self->ut_numbern('payissue')
1805 || $self->ut_textn('paytype')
1807 return $error if $error;
1809 if ( $self->payip eq '' ) {
1812 $error = $self->ut_ip('payip');
1813 return $error if $error;
1816 # If it is encrypted and the private key is not availaible then we can't
1817 # check the credit card.
1818 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1820 # Need some kind of global flag to accept invalid cards, for testing
1822 if ( !$import && $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1824 my $payinfo = $self->payinfo;
1825 $payinfo =~ s/\D//g;
1826 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1827 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1829 $self->payinfo($payinfo);
1831 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1833 return gettext('unknown_card_type')
1834 if $self->payinfo !~ /^99\d{14}$/ #token
1835 && cardtype($self->payinfo) eq "Unknown";
1837 unless ( $ignore_banned_card ) {
1838 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1840 if ( $ban->bantype eq 'warn' ) {
1841 #or others depending on value of $ban->reason ?
1842 return '_duplicate_card'.
1843 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1844 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1845 ' (ban# '. $ban->bannum. ')'
1846 unless $self->override_ban_warn;
1848 return 'Banned credit card: banned on '.
1849 time2str('%a %h %o at %r', $ban->_date).
1850 ' by '. $ban->otaker.
1851 ' (ban# '. $ban->bannum. ')';
1856 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1857 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1858 $self->paycvv =~ /^(\d{4})$/
1859 or return "CVV2 (CID) for American Express cards is four digits.";
1862 $self->paycvv =~ /^(\d{3})$/
1863 or return "CVV2 (CVC2/CID) is three digits.";
1870 my $cardtype = cardtype($payinfo);
1871 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1873 return "Start date or issue number is required for $cardtype cards"
1874 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1876 return "Start month must be between 1 and 12"
1877 if $self->paystart_month
1878 and $self->paystart_month < 1 || $self->paystart_month > 12;
1880 return "Start year must be 1990 or later"
1881 if $self->paystart_year
1882 and $self->paystart_year < 1990;
1884 return "Issue number must be beween 1 and 99"
1886 and $self->payissue < 1 || $self->payissue > 99;
1889 $self->paystart_month('');
1890 $self->paystart_year('');
1891 $self->payissue('');
1894 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1896 my $payinfo = $self->payinfo;
1897 $payinfo =~ s/[^\d\@\.]//g;
1898 if ( $conf->config('echeck-country') eq 'CA' ) {
1899 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1900 or return 'invalid echeck account@branch.bank';
1901 $payinfo = "$1\@$2.$3";
1902 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1903 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1904 $payinfo = "$1\@$2";
1906 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1907 $payinfo = "$1\@$2";
1909 $self->payinfo($payinfo);
1912 unless ( $ignore_banned_card ) {
1913 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1915 if ( $ban->bantype eq 'warn' ) {
1916 #or others depending on value of $ban->reason ?
1917 return '_duplicate_ach' unless $self->override_ban_warn;
1919 return 'Banned ACH account: banned on '.
1920 time2str('%a %h %o at %r', $ban->_date).
1921 ' by '. $ban->otaker.
1922 ' (ban# '. $ban->bannum. ')';
1927 } elsif ( $self->payby eq 'LECB' ) {
1929 my $payinfo = $self->payinfo;
1930 $payinfo =~ s/\D//g;
1931 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1933 $self->payinfo($payinfo);
1936 } elsif ( $self->payby eq 'BILL' ) {
1938 $error = $self->ut_textn('payinfo');
1939 return "Illegal P.O. number: ". $self->payinfo if $error;
1942 } elsif ( $self->payby eq 'COMP' ) {
1944 my $curuser = $FS::CurrentUser::CurrentUser;
1945 if ( ! $self->custnum
1946 && ! $curuser->access_right('Complimentary customer')
1949 return "You are not permitted to create complimentary accounts."
1952 $error = $self->ut_textn('payinfo');
1953 return "Illegal comp account issuer: ". $self->payinfo if $error;
1956 } elsif ( $self->payby eq 'PREPAY' ) {
1958 my $payinfo = $self->payinfo;
1959 $payinfo =~ s/\W//g; #anything else would just confuse things
1960 $self->payinfo($payinfo);
1961 $error = $self->ut_alpha('payinfo');
1962 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1963 return "Unknown prepayment identifier"
1964 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1969 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1970 return "Expiration date required"
1971 # shouldn't payinfo_check do this?
1972 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
1976 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1977 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1978 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1979 ( $m, $y ) = ( $2, "19$1" );
1980 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1981 ( $m, $y ) = ( $3, "20$2" );
1983 return "Illegal expiration date: ". $self->paydate;
1985 $m = sprintf('%02d',$m);
1986 $self->paydate("$y-$m-01");
1987 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1988 return gettext('expired_card')
1990 && !$ignore_expired_card
1991 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1994 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1995 ( ! $conf->exists('require_cardname')
1996 || $self->payby !~ /^(CARD|DCRD)$/ )
1998 $self->payname( $self->first. " ". $self->getfield('last') );
2000 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2001 or return gettext('illegal_name'). " payname: ". $self->payname;
2005 ### end of stuff moved to cust_payby
2007 return "Please select an invoicing locale"
2010 && $conf->exists('cust_main-require_locale');
2012 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2013 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2017 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2019 warn "$me check AFTER: \n". $self->_dump
2022 $self->SUPER::check;
2027 Returns a list of fields which have ship_ duplicates.
2032 qw( last first company
2033 address1 address2 city county state zip country
2035 daytime night fax mobile
2039 =item has_ship_address
2041 Returns true if this customer record has a separate shipping address.
2045 sub has_ship_address {
2047 $self->bill_locationnum != $self->ship_locationnum;
2052 Returns a list of key/value pairs, with the following keys: address1,
2053 adddress2, city, county, state, zip, country, district, and geocode. The
2054 shipping address is used if present.
2060 $self->ship_location->location_hash;
2065 Returns all locations (see L<FS::cust_location>) for this customer.
2071 qsearch('cust_location', { 'custnum' => $self->custnum,
2072 'prospectnum' => '' } );
2077 Returns all contacts (see L<FS::contact>) for this customer.
2081 #already used :/ sub contact {
2084 qsearch('contact', { 'custnum' => $self->custnum } );
2089 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2090 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2091 on success or a list of errors.
2097 grep { $_->unsuspend } $self->suspended_pkgs;
2102 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2104 Returns a list: an empty list on success or a list of errors.
2110 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2113 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2115 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2116 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2117 of a list of pkgparts; the hashref has the following keys:
2121 =item pkgparts - listref of pkgparts
2123 =item (other options are passed to the suspend method)
2128 Returns a list: an empty list on success or a list of errors.
2132 sub suspend_if_pkgpart {
2134 my (@pkgparts, %opt);
2135 if (ref($_[0]) eq 'HASH'){
2136 @pkgparts = @{$_[0]{pkgparts}};
2141 grep { $_->suspend(%opt) }
2142 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2143 $self->unsuspended_pkgs;
2146 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2148 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2149 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2150 instead of a list of pkgparts; the hashref has the following keys:
2154 =item pkgparts - listref of pkgparts
2156 =item (other options are passed to the suspend method)
2160 Returns a list: an empty list on success or a list of errors.
2164 sub suspend_unless_pkgpart {
2166 my (@pkgparts, %opt);
2167 if (ref($_[0]) eq 'HASH'){
2168 @pkgparts = @{$_[0]{pkgparts}};
2173 grep { $_->suspend(%opt) }
2174 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2175 $self->unsuspended_pkgs;
2178 =item cancel [ OPTION => VALUE ... ]
2180 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2182 Available options are:
2186 =item quiet - can be set true to supress email cancellation notices.
2188 =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.
2190 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2192 =item nobill - can be set true to skip billing if it might otherwise be done.
2196 Always returns a list: an empty list on success or a list of errors.
2200 # nb that dates are not specified as valid options to this method
2203 my( $self, %opt ) = @_;
2205 warn "$me cancel called on customer ". $self->custnum. " with options ".
2206 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2209 return ( 'access denied' )
2210 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2212 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2214 #should try decryption (we might have the private key)
2215 # and if not maybe queue a job for the server that does?
2216 return ( "Can't (yet) ban encrypted credit cards" )
2217 if $self->is_encrypted($self->payinfo);
2219 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2220 my $error = $ban->insert;
2221 return ( $error ) if $error;
2225 my @pkgs = $self->ncancelled_pkgs;
2227 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2229 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2230 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2234 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2235 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2238 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2241 sub _banned_pay_hashref {
2252 'payby' => $payby2ban{$self->payby},
2253 'payinfo' => $self->payinfo,
2254 #don't ever *search* on reason! #'reason' =>
2258 sub _new_banned_pay_hashref {
2260 my $hr = $self->_banned_pay_hashref;
2261 $hr->{payinfo} = md5_base64($hr->{payinfo});
2267 Returns all notes (see L<FS::cust_main_note>) for this customer.
2272 my($self,$orderby_classnum) = (shift,shift);
2273 my $orderby = "_DATE DESC";
2274 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2275 qsearch( 'cust_main_note',
2276 { 'custnum' => $self->custnum },
2278 "ORDER BY $orderby",
2284 Returns the agent (see L<FS::agent>) for this customer.
2290 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2295 Returns the agent name (see L<FS::agent>) for this customer.
2301 $self->agent->agent;
2306 Returns any tags associated with this customer, as FS::cust_tag objects,
2307 or an empty list if there are no tags.
2313 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2318 Returns any tags associated with this customer, as FS::part_tag objects,
2319 or an empty list if there are no tags.
2325 map $_->part_tag, $self->cust_tag;
2331 Returns the customer class, as an FS::cust_class object, or the empty string
2332 if there is no customer class.
2338 if ( $self->classnum ) {
2339 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2347 Returns the customer category name, or the empty string if there is no customer
2354 my $cust_class = $self->cust_class;
2356 ? $cust_class->categoryname
2362 Returns the customer class name, or the empty string if there is no customer
2369 my $cust_class = $self->cust_class;
2371 ? $cust_class->classname
2375 =item BILLING METHODS
2377 Documentation on billing methods has been moved to
2378 L<FS::cust_main::Billing>.
2380 =item REALTIME BILLING METHODS
2382 Documentation on realtime billing methods has been moved to
2383 L<FS::cust_main::Billing_Realtime>.
2387 Removes the I<paycvv> field from the database directly.
2389 If there is an error, returns the error, otherwise returns false.
2395 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2396 or return dbh->errstr;
2397 $sth->execute($self->custnum)
2398 or return $sth->errstr;
2403 =item batch_card OPTION => VALUE...
2405 Adds a payment for this invoice to the pending credit card batch (see
2406 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2407 runs the payment using a realtime gateway.
2409 Options may include:
2411 B<amount>: the amount to be paid; defaults to the customer's balance minus
2412 any payments in transit.
2414 B<payby>: the payment method; defaults to cust_main.payby
2416 B<realtime>: runs this as a realtime payment instead of adding it to a
2419 B<invnum>: sets cust_pay_batch.invnum.
2421 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2422 the billing address for the payment; defaults to the customer's billing
2425 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2426 date, and name; defaults to those fields in cust_main.
2431 my ($self, %options) = @_;
2434 if (exists($options{amount})) {
2435 $amount = $options{amount};
2437 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2439 return '' unless $amount > 0;
2441 my $invnum = delete $options{invnum};
2442 my $payby = $options{payby} || $self->payby; #still dubious
2444 if ($options{'realtime'}) {
2445 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2451 my $oldAutoCommit = $FS::UID::AutoCommit;
2452 local $FS::UID::AutoCommit = 0;
2455 #this needs to handle mysql as well as Pg, like svc_acct.pm
2456 #(make it into a common function if folks need to do batching with mysql)
2457 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2458 or return "Cannot lock pay_batch: " . $dbh->errstr;
2462 'payby' => FS::payby->payby2payment($payby),
2464 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2466 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2468 unless ( $pay_batch ) {
2469 $pay_batch = new FS::pay_batch \%pay_batch;
2470 my $error = $pay_batch->insert;
2472 $dbh->rollback if $oldAutoCommit;
2473 die "error creating new batch: $error\n";
2477 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2478 'batchnum' => $pay_batch->batchnum,
2479 'custnum' => $self->custnum,
2482 foreach (qw( address1 address2 city state zip country latitude longitude
2483 payby payinfo paydate payname ))
2485 $options{$_} = '' unless exists($options{$_});
2488 my $loc = $self->bill_location;
2490 my $cust_pay_batch = new FS::cust_pay_batch ( {
2491 'batchnum' => $pay_batch->batchnum,
2492 'invnum' => $invnum || 0, # is there a better value?
2493 # this field should be
2495 # cust_bill_pay_batch now
2496 'custnum' => $self->custnum,
2497 'last' => $self->getfield('last'),
2498 'first' => $self->getfield('first'),
2499 'address1' => $options{address1} || $loc->address1,
2500 'address2' => $options{address2} || $loc->address2,
2501 'city' => $options{city} || $loc->city,
2502 'state' => $options{state} || $loc->state,
2503 'zip' => $options{zip} || $loc->zip,
2504 'country' => $options{country} || $loc->country,
2505 'payby' => $options{payby} || $self->payby,
2506 'payinfo' => $options{payinfo} || $self->payinfo,
2507 'exp' => $options{paydate} || $self->paydate,
2508 'payname' => $options{payname} || $self->payname,
2509 'amount' => $amount, # consolidating
2512 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2513 if $old_cust_pay_batch;
2516 if ($old_cust_pay_batch) {
2517 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2519 $error = $cust_pay_batch->insert;
2523 $dbh->rollback if $oldAutoCommit;
2527 my $unapplied = $self->total_unapplied_credits
2528 + $self->total_unapplied_payments
2529 + $self->in_transit_payments;
2530 foreach my $cust_bill ($self->open_cust_bill) {
2531 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2532 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2533 'invnum' => $cust_bill->invnum,
2534 'paybatchnum' => $cust_pay_batch->paybatchnum,
2535 'amount' => $cust_bill->owed,
2538 if ($unapplied >= $cust_bill_pay_batch->amount){
2539 $unapplied -= $cust_bill_pay_batch->amount;
2542 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2543 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2545 $error = $cust_bill_pay_batch->insert;
2547 $dbh->rollback if $oldAutoCommit;
2552 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2558 Returns the total owed for this customer on all invoices
2559 (see L<FS::cust_bill/owed>).
2565 $self->total_owed_date(2145859200); #12/31/2037
2568 =item total_owed_date TIME
2570 Returns the total owed for this customer on all invoices with date earlier than
2571 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2572 see L<Time::Local> and L<Date::Parse> for conversion functions.
2576 sub total_owed_date {
2580 my $custnum = $self->custnum;
2582 my $owed_sql = FS::cust_bill->owed_sql;
2585 SELECT SUM($owed_sql) FROM cust_bill
2586 WHERE custnum = $custnum
2590 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2594 =item total_owed_pkgnum PKGNUM
2596 Returns the total owed on all invoices for this customer's specific package
2597 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2601 sub total_owed_pkgnum {
2602 my( $self, $pkgnum ) = @_;
2603 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2606 =item total_owed_date_pkgnum TIME PKGNUM
2608 Returns the total owed for this customer's specific package when using
2609 experimental package balances on all invoices with date earlier than
2610 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2611 see L<Time::Local> and L<Date::Parse> for conversion functions.
2615 sub total_owed_date_pkgnum {
2616 my( $self, $time, $pkgnum ) = @_;
2619 foreach my $cust_bill (
2620 grep { $_->_date <= $time }
2621 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2623 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2625 sprintf( "%.2f", $total_bill );
2631 Returns the total amount of all payments.
2638 $total += $_->paid foreach $self->cust_pay;
2639 sprintf( "%.2f", $total );
2642 =item total_unapplied_credits
2644 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2645 customer. See L<FS::cust_credit/credited>.
2647 =item total_credited
2649 Old name for total_unapplied_credits. Don't use.
2653 sub total_credited {
2654 #carp "total_credited deprecated, use total_unapplied_credits";
2655 shift->total_unapplied_credits(@_);
2658 sub total_unapplied_credits {
2661 my $custnum = $self->custnum;
2663 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2666 SELECT SUM($unapplied_sql) FROM cust_credit
2667 WHERE custnum = $custnum
2670 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2674 =item total_unapplied_credits_pkgnum PKGNUM
2676 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2677 customer. See L<FS::cust_credit/credited>.
2681 sub total_unapplied_credits_pkgnum {
2682 my( $self, $pkgnum ) = @_;
2683 my $total_credit = 0;
2684 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2685 sprintf( "%.2f", $total_credit );
2689 =item total_unapplied_payments
2691 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2692 See L<FS::cust_pay/unapplied>.
2696 sub total_unapplied_payments {
2699 my $custnum = $self->custnum;
2701 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2704 SELECT SUM($unapplied_sql) FROM cust_pay
2705 WHERE custnum = $custnum
2708 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2712 =item total_unapplied_payments_pkgnum PKGNUM
2714 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2715 specific package when using experimental package balances. See
2716 L<FS::cust_pay/unapplied>.
2720 sub total_unapplied_payments_pkgnum {
2721 my( $self, $pkgnum ) = @_;
2722 my $total_unapplied = 0;
2723 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2724 sprintf( "%.2f", $total_unapplied );
2728 =item total_unapplied_refunds
2730 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2731 customer. See L<FS::cust_refund/unapplied>.
2735 sub total_unapplied_refunds {
2737 my $custnum = $self->custnum;
2739 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2742 SELECT SUM($unapplied_sql) FROM cust_refund
2743 WHERE custnum = $custnum
2746 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2752 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2753 total_unapplied_credits minus total_unapplied_payments).
2759 $self->balance_date_range;
2762 =item balance_date TIME
2764 Returns the balance for this customer, only considering invoices with date
2765 earlier than TIME (total_owed_date minus total_credited minus
2766 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2767 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2774 $self->balance_date_range(shift);
2777 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2779 Returns the balance for this customer, optionally considering invoices with
2780 date earlier than START_TIME, and not later than END_TIME
2781 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2783 Times are specified as SQL fragments or numeric
2784 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2785 L<Date::Parse> for conversion functions. The empty string can be passed
2786 to disable that time constraint completely.
2788 Available options are:
2792 =item unapplied_date
2794 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)
2800 sub balance_date_range {
2802 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2803 ') FROM cust_main WHERE custnum='. $self->custnum;
2804 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2807 =item balance_pkgnum PKGNUM
2809 Returns the balance for this customer's specific package when using
2810 experimental package balances (total_owed plus total_unrefunded, minus
2811 total_unapplied_credits minus total_unapplied_payments)
2815 sub balance_pkgnum {
2816 my( $self, $pkgnum ) = @_;
2819 $self->total_owed_pkgnum($pkgnum)
2820 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2821 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2822 - $self->total_unapplied_credits_pkgnum($pkgnum)
2823 - $self->total_unapplied_payments_pkgnum($pkgnum)
2827 =item in_transit_payments
2829 Returns the total of requests for payments for this customer pending in
2830 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2834 sub in_transit_payments {
2836 my $in_transit_payments = 0;
2837 foreach my $pay_batch ( qsearch('pay_batch', {
2840 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2841 'batchnum' => $pay_batch->batchnum,
2842 'custnum' => $self->custnum,
2844 $in_transit_payments += $cust_pay_batch->amount;
2847 sprintf( "%.2f", $in_transit_payments );
2852 Returns a hash of useful information for making a payment.
2862 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2863 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2864 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2868 For credit card transactions:
2880 For electronic check transactions:
2895 $return{balance} = $self->balance;
2897 $return{payname} = $self->payname
2898 || ( $self->first. ' '. $self->get('last') );
2900 $return{$_} = $self->bill_location->$_
2901 for qw(address1 address2 city state zip);
2903 $return{payby} = $self->payby;
2904 $return{stateid_state} = $self->stateid_state;
2906 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2907 $return{card_type} = cardtype($self->payinfo);
2908 $return{payinfo} = $self->paymask;
2910 @return{'month', 'year'} = $self->paydate_monthyear;
2914 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2915 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2916 $return{payinfo1} = $payinfo1;
2917 $return{payinfo2} = $payinfo2;
2918 $return{paytype} = $self->paytype;
2919 $return{paystate} = $self->paystate;
2923 #doubleclick protection
2925 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2931 =item paydate_monthyear
2933 Returns a two-element list consisting of the month and year of this customer's
2934 paydate (credit card expiration date for CARD customers)
2938 sub paydate_monthyear {
2940 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2942 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2951 Returns the exact time in seconds corresponding to the payment method
2952 expiration date. For CARD/DCRD customers this is the end of the month;
2953 for others (COMP is the only other payby that uses paydate) it's the start.
2954 Returns 0 if the paydate is empty or set to the far future.
2960 my ($month, $year) = $self->paydate_monthyear;
2961 return 0 if !$year or $year >= 2037;
2962 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
2964 if ( $month == 13 ) {
2968 return timelocal(0,0,0,1,$month-1,$year) - 1;
2971 return timelocal(0,0,0,1,$month-1,$year);
2975 =item paydate_epoch_sql
2977 Class method. Returns an SQL expression to obtain the payment expiration date
2978 as a number of seconds.
2982 # Special expiration date behavior for non-CARD/DCRD customers has been
2983 # carefully preserved. Do we really use that?
2984 sub paydate_epoch_sql {
2986 my $table = shift || 'cust_main';
2987 my ($case1, $case2);
2988 if ( driver_name eq 'Pg' ) {
2989 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
2990 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
2992 elsif ( lc(driver_name) eq 'mysql' ) {
2993 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
2994 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
2997 return "CASE WHEN $table.payby IN('CARD','DCRD')
3003 =item tax_exemption TAXNAME
3008 my( $self, $taxname ) = @_;
3010 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3011 'taxname' => $taxname,
3016 =item cust_main_exemption
3020 sub cust_main_exemption {
3022 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3025 =item invoicing_list [ ARRAYREF ]
3027 If an arguement is given, sets these email addresses as invoice recipients
3028 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3029 (except as warnings), so use check_invoicing_list first.
3031 Returns a list of email addresses (with svcnum entries expanded).
3033 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3034 check it without disturbing anything by passing nothing.
3036 This interface may change in the future.
3040 sub invoicing_list {
3041 my( $self, $arrayref ) = @_;
3044 my @cust_main_invoice;
3045 if ( $self->custnum ) {
3046 @cust_main_invoice =
3047 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3049 @cust_main_invoice = ();
3051 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3052 #warn $cust_main_invoice->destnum;
3053 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3054 #warn $cust_main_invoice->destnum;
3055 my $error = $cust_main_invoice->delete;
3056 warn $error if $error;
3059 if ( $self->custnum ) {
3060 @cust_main_invoice =
3061 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3063 @cust_main_invoice = ();
3065 my %seen = map { $_->address => 1 } @cust_main_invoice;
3066 foreach my $address ( @{$arrayref} ) {
3067 next if exists $seen{$address} && $seen{$address};
3068 $seen{$address} = 1;
3069 my $cust_main_invoice = new FS::cust_main_invoice ( {
3070 'custnum' => $self->custnum,
3073 my $error = $cust_main_invoice->insert;
3074 warn $error if $error;
3078 if ( $self->custnum ) {
3080 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3087 =item check_invoicing_list ARRAYREF
3089 Checks these arguements as valid input for the invoicing_list method. If there
3090 is an error, returns the error, otherwise returns false.
3094 sub check_invoicing_list {
3095 my( $self, $arrayref ) = @_;
3097 foreach my $address ( @$arrayref ) {
3099 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3100 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3103 my $cust_main_invoice = new FS::cust_main_invoice ( {
3104 'custnum' => $self->custnum,
3107 my $error = $self->custnum
3108 ? $cust_main_invoice->check
3109 : $cust_main_invoice->checkdest
3111 return $error if $error;
3115 return "Email address required"
3116 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3117 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3122 =item set_default_invoicing_list
3124 Sets the invoicing list to all accounts associated with this customer,
3125 overwriting any previous invoicing list.
3129 sub set_default_invoicing_list {
3131 $self->invoicing_list($self->all_emails);
3136 Returns the email addresses of all accounts provisioned for this customer.
3143 foreach my $cust_pkg ( $self->all_pkgs ) {
3144 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3146 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3147 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3149 $list{$_}=1 foreach map { $_->email } @svc_acct;
3154 =item invoicing_list_addpost
3156 Adds postal invoicing to this customer. If this customer is already configured
3157 to receive postal invoices, does nothing.
3161 sub invoicing_list_addpost {
3163 return if grep { $_ eq 'POST' } $self->invoicing_list;
3164 my @invoicing_list = $self->invoicing_list;
3165 push @invoicing_list, 'POST';
3166 $self->invoicing_list(\@invoicing_list);
3169 =item invoicing_list_emailonly
3171 Returns the list of email invoice recipients (invoicing_list without non-email
3172 destinations such as POST and FAX).
3176 sub invoicing_list_emailonly {
3178 warn "$me invoicing_list_emailonly called"
3180 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3183 =item invoicing_list_emailonly_scalar
3185 Returns the list of email invoice recipients (invoicing_list without non-email
3186 destinations such as POST and FAX) as a comma-separated scalar.
3190 sub invoicing_list_emailonly_scalar {
3192 warn "$me invoicing_list_emailonly_scalar called"
3194 join(', ', $self->invoicing_list_emailonly);
3197 =item referral_custnum_cust_main
3199 Returns the customer who referred this customer (or the empty string, if
3200 this customer was not referred).
3202 Note the difference with referral_cust_main method: This method,
3203 referral_custnum_cust_main returns the single customer (if any) who referred
3204 this customer, while referral_cust_main returns an array of customers referred
3209 sub referral_custnum_cust_main {
3211 return '' unless $self->referral_custnum;
3212 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3215 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3217 Returns an array of customers referred by this customer (referral_custnum set
3218 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3219 customers referred by customers referred by this customer and so on, inclusive.
3220 The default behavior is DEPTH 1 (no recursion).
3222 Note the difference with referral_custnum_cust_main method: This method,
3223 referral_cust_main, returns an array of customers referred BY this customer,
3224 while referral_custnum_cust_main returns the single customer (if any) who
3225 referred this customer.
3229 sub referral_cust_main {
3231 my $depth = @_ ? shift : 1;
3232 my $exclude = @_ ? shift : {};
3235 map { $exclude->{$_->custnum}++; $_; }
3236 grep { ! $exclude->{ $_->custnum } }
3237 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3241 map { $_->referral_cust_main($depth-1, $exclude) }
3248 =item referral_cust_main_ncancelled
3250 Same as referral_cust_main, except only returns customers with uncancelled
3255 sub referral_cust_main_ncancelled {
3257 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3260 =item referral_cust_pkg [ DEPTH ]
3262 Like referral_cust_main, except returns a flat list of all unsuspended (and
3263 uncancelled) packages for each customer. The number of items in this list may
3264 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3268 sub referral_cust_pkg {
3270 my $depth = @_ ? shift : 1;
3272 map { $_->unsuspended_pkgs }
3273 grep { $_->unsuspended_pkgs }
3274 $self->referral_cust_main($depth);
3277 =item referring_cust_main
3279 Returns the single cust_main record for the customer who referred this customer
3280 (referral_custnum), or false.
3284 sub referring_cust_main {
3286 return '' unless $self->referral_custnum;
3287 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3290 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3292 Applies a credit to this customer. If there is an error, returns the error,
3293 otherwise returns false.
3295 REASON can be a text string, an FS::reason object, or a scalar reference to
3296 a reasonnum. If a text string, it will be automatically inserted as a new
3297 reason, and a 'reason_type' option must be passed to indicate the
3298 FS::reason_type for the new reason.
3300 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3302 Any other options are passed to FS::cust_credit::insert.
3307 my( $self, $amount, $reason, %options ) = @_;
3309 my $cust_credit = new FS::cust_credit {
3310 'custnum' => $self->custnum,
3311 'amount' => $amount,
3314 if ( ref($reason) ) {
3316 if ( ref($reason) eq 'SCALAR' ) {
3317 $cust_credit->reasonnum( $$reason );
3319 $cust_credit->reasonnum( $reason->reasonnum );
3323 $cust_credit->set('reason', $reason)
3326 for (qw( addlinfo eventnum )) {
3327 $cust_credit->$_( delete $options{$_} )
3328 if exists($options{$_});
3331 $cust_credit->insert(%options);
3335 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3337 Creates a one-time charge for this customer. If there is an error, returns
3338 the error, otherwise returns false.
3340 New-style, with a hashref of options:
3342 my $error = $cust_main->charge(
3346 'start_date' => str2time('7/4/2009'),
3347 'pkg' => 'Description',
3348 'comment' => 'Comment',
3349 'additional' => [], #extra invoice detail
3350 'classnum' => 1, #pkg_class
3352 'setuptax' => '', # or 'Y' for tax exempt
3354 'locationnum'=> 1234, # optional
3357 'taxclass' => 'Tax class',
3360 'taxproduct' => 2, #part_pkg_taxproduct
3361 'override' => {}, #XXX describe
3363 #will be filled in with the new object
3364 'cust_pkg_ref' => \$cust_pkg,
3366 #generate an invoice immediately
3368 'invoice_terms' => '', #with these terms
3374 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3380 my ( $amount, $quantity, $start_date, $classnum );
3381 my ( $pkg, $comment, $additional );
3382 my ( $setuptax, $taxclass ); #internal taxes
3383 my ( $taxproduct, $override ); #vendor (CCH) taxes
3385 my $cust_pkg_ref = '';
3386 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3388 if ( ref( $_[0] ) ) {
3389 $amount = $_[0]->{amount};
3390 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3391 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3392 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3393 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3394 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3395 : '$'. sprintf("%.2f",$amount);
3396 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3397 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3398 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3399 $additional = $_[0]->{additional} || [];
3400 $taxproduct = $_[0]->{taxproductnum};
3401 $override = { '' => $_[0]->{tax_override} };
3402 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3403 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3404 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3405 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3410 $pkg = @_ ? shift : 'One-time charge';
3411 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3413 $taxclass = @_ ? shift : '';
3417 local $SIG{HUP} = 'IGNORE';
3418 local $SIG{INT} = 'IGNORE';
3419 local $SIG{QUIT} = 'IGNORE';
3420 local $SIG{TERM} = 'IGNORE';
3421 local $SIG{TSTP} = 'IGNORE';
3422 local $SIG{PIPE} = 'IGNORE';
3424 my $oldAutoCommit = $FS::UID::AutoCommit;
3425 local $FS::UID::AutoCommit = 0;
3428 my $part_pkg = new FS::part_pkg ( {
3430 'comment' => $comment,
3434 'classnum' => ( $classnum ? $classnum : '' ),
3435 'setuptax' => $setuptax,
3436 'taxclass' => $taxclass,
3437 'taxproductnum' => $taxproduct,
3440 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3441 ( 0 .. @$additional - 1 )
3443 'additional_count' => scalar(@$additional),
3444 'setup_fee' => $amount,
3447 my $error = $part_pkg->insert( options => \%options,
3448 tax_overrides => $override,
3451 $dbh->rollback if $oldAutoCommit;
3455 my $pkgpart = $part_pkg->pkgpart;
3456 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3457 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3458 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3459 $error = $type_pkgs->insert;
3461 $dbh->rollback if $oldAutoCommit;
3466 my $cust_pkg = new FS::cust_pkg ( {
3467 'custnum' => $self->custnum,
3468 'pkgpart' => $pkgpart,
3469 'quantity' => $quantity,
3470 'start_date' => $start_date,
3471 'no_auto' => $no_auto,
3472 'locationnum'=> $locationnum,
3475 $error = $cust_pkg->insert;
3477 $dbh->rollback if $oldAutoCommit;
3479 } elsif ( $cust_pkg_ref ) {
3480 ${$cust_pkg_ref} = $cust_pkg;
3484 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3485 'pkg_list' => [ $cust_pkg ],
3488 $dbh->rollback if $oldAutoCommit;
3493 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3498 #=item charge_postal_fee
3500 #Applies a one time charge this customer. If there is an error,
3501 #returns the error, returns the cust_pkg charge object or false
3502 #if there was no charge.
3506 # This should be a customer event. For that to work requires that bill
3507 # also be a customer event.
3509 sub charge_postal_fee {
3512 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3513 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3515 my $cust_pkg = new FS::cust_pkg ( {
3516 'custnum' => $self->custnum,
3517 'pkgpart' => $pkgpart,
3521 my $error = $cust_pkg->insert;
3522 $error ? $error : $cust_pkg;
3525 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3527 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3529 Optionally, a list or hashref of additional arguments to the qsearch call can
3536 my $opt = ref($_[0]) ? shift : { @_ };
3538 #return $self->num_cust_bill unless wantarray || keys %$opt;
3540 $opt->{'table'} = 'cust_bill';
3541 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3542 $opt->{'hashref'}{'custnum'} = $self->custnum;
3543 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3545 map { $_ } #behavior of sort undefined in scalar context
3546 sort { $a->_date <=> $b->_date }
3550 =item open_cust_bill
3552 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3557 sub open_cust_bill {
3561 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3567 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3569 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3573 sub legacy_cust_bill {
3576 #return $self->num_legacy_cust_bill unless wantarray;
3578 map { $_ } #behavior of sort undefined in scalar context
3579 sort { $a->_date <=> $b->_date }
3580 qsearch({ 'table' => 'legacy_cust_bill',
3581 'hashref' => { 'custnum' => $self->custnum, },
3582 'order_by' => 'ORDER BY _date ASC',
3586 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3588 Returns all the statements (see L<FS::cust_statement>) for this customer.
3590 Optionally, a list or hashref of additional arguments to the qsearch call can
3595 =item cust_bill_void
3597 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3601 sub cust_bill_void {
3604 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3605 sort { $a->_date <=> $b->_date }
3606 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3609 sub cust_statement {
3611 my $opt = ref($_[0]) ? shift : { @_ };
3613 #return $self->num_cust_statement unless wantarray || keys %$opt;
3615 $opt->{'table'} = 'cust_statement';
3616 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3617 $opt->{'hashref'}{'custnum'} = $self->custnum;
3618 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3620 map { $_ } #behavior of sort undefined in scalar context
3621 sort { $a->_date <=> $b->_date }
3625 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3627 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3629 Optionally, a list or hashref of additional arguments to the qsearch call can
3630 be passed following the SVCDB.
3637 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3638 warn "$me svc_x requires a svcdb";
3641 my $opt = ref($_[0]) ? shift : { @_ };
3643 $opt->{'table'} = $svcdb;
3644 $opt->{'addl_from'} =
3645 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3646 ($opt->{'addl_from'} || '');
3648 my $custnum = $self->custnum;
3649 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3650 my $where = "cust_pkg.custnum = $custnum";
3652 my $extra_sql = $opt->{'extra_sql'} || '';
3653 if ( keys %{ $opt->{'hashref'} } ) {
3654 $extra_sql = " AND $where $extra_sql";
3657 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3658 $extra_sql = "WHERE $where AND $1";
3661 $extra_sql = "WHERE $where $extra_sql";
3664 $opt->{'extra_sql'} = $extra_sql;
3669 # required for use as an eventtable;
3672 $self->svc_x('svc_acct', @_);
3677 Returns all the credits (see L<FS::cust_credit>) for this customer.
3683 map { $_ } #return $self->num_cust_credit unless wantarray;
3684 sort { $a->_date <=> $b->_date }
3685 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3688 =item cust_credit_pkgnum
3690 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3691 package when using experimental package balances.
3695 sub cust_credit_pkgnum {
3696 my( $self, $pkgnum ) = @_;
3697 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3698 sort { $a->_date <=> $b->_date }
3699 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3700 'pkgnum' => $pkgnum,
3707 Returns all the payments (see L<FS::cust_pay>) for this customer.
3713 return $self->num_cust_pay unless wantarray;
3714 sort { $a->_date <=> $b->_date }
3715 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3720 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3721 called automatically when the cust_pay method is used in a scalar context.
3727 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3728 my $sth = dbh->prepare($sql) or die dbh->errstr;
3729 $sth->execute($self->custnum) or die $sth->errstr;
3730 $sth->fetchrow_arrayref->[0];
3733 =item cust_pay_pkgnum
3735 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3736 package when using experimental package balances.
3740 sub cust_pay_pkgnum {
3741 my( $self, $pkgnum ) = @_;
3742 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3743 sort { $a->_date <=> $b->_date }
3744 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3745 'pkgnum' => $pkgnum,
3752 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3758 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3759 sort { $a->_date <=> $b->_date }
3760 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3763 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3765 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3767 Optionally, a list or hashref of additional arguments to the qsearch call can
3772 sub cust_pay_batch {
3774 my $opt = ref($_[0]) ? shift : { @_ };
3776 #return $self->num_cust_statement unless wantarray || keys %$opt;
3778 $opt->{'table'} = 'cust_pay_batch';
3779 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3780 $opt->{'hashref'}{'custnum'} = $self->custnum;
3781 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3783 map { $_ } #behavior of sort undefined in scalar context
3784 sort { $a->paybatchnum <=> $b->paybatchnum }
3788 =item cust_pay_pending
3790 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3791 (without status "done").
3795 sub cust_pay_pending {
3797 return $self->num_cust_pay_pending unless wantarray;
3798 sort { $a->_date <=> $b->_date }
3799 qsearch( 'cust_pay_pending', {
3800 'custnum' => $self->custnum,
3801 'status' => { op=>'!=', value=>'done' },
3806 =item cust_pay_pending_attempt
3808 Returns all payment attempts / declined payments for this customer, as pending
3809 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3810 a corresponding payment (see L<FS::cust_pay>).
3814 sub cust_pay_pending_attempt {
3816 return $self->num_cust_pay_pending_attempt unless wantarray;
3817 sort { $a->_date <=> $b->_date }
3818 qsearch( 'cust_pay_pending', {
3819 'custnum' => $self->custnum,
3826 =item num_cust_pay_pending
3828 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3829 customer (without status "done"). Also called automatically when the
3830 cust_pay_pending method is used in a scalar context.
3834 sub num_cust_pay_pending {
3837 " SELECT COUNT(*) FROM cust_pay_pending ".
3838 " WHERE custnum = ? AND status != 'done' ",
3843 =item num_cust_pay_pending_attempt
3845 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3846 customer, with status "done" but without a corresp. Also called automatically when the
3847 cust_pay_pending method is used in a scalar context.
3851 sub num_cust_pay_pending_attempt {
3854 " SELECT COUNT(*) FROM cust_pay_pending ".
3855 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3862 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3868 map { $_ } #return $self->num_cust_refund unless wantarray;
3869 sort { $a->_date <=> $b->_date }
3870 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3873 =item display_custnum
3875 Returns the displayed customer number for this customer: agent_custid if
3876 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3880 sub display_custnum {
3883 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3884 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3885 if ( $special eq 'CoStAg' ) {
3886 $prefix = uc( join('',
3888 ($self->state =~ /^(..)/),
3889 $prefix || ($self->agent->agent =~ /^(..)/)
3892 elsif ( $special eq 'CoStCl' ) {
3893 $prefix = uc( join('',
3895 ($self->state =~ /^(..)/),
3896 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3899 # add any others here if needed
3902 my $length = $conf->config('cust_main-custnum-display_length');
3903 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3904 return $self->agent_custid;
3905 } elsif ( $prefix ) {
3906 $length = 8 if !defined($length);
3908 sprintf('%0'.$length.'d', $self->custnum)
3909 } elsif ( $length ) {
3910 return sprintf('%0'.$length.'d', $self->custnum);
3912 return $self->custnum;
3918 Returns a name string for this customer, either "Company (Last, First)" or
3925 my $name = $self->contact;
3926 $name = $self->company. " ($name)" if $self->company;
3930 =item service_contact
3932 Returns the L<FS::contact> object for this customer that has the 'Service'
3933 contact class, or undef if there is no such contact. Deprecated; don't use
3938 sub service_contact {
3940 if ( !exists($self->{service_contact}) ) {
3941 my $classnum = $self->scalar_sql(
3942 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3943 ) || 0; #if it's zero, qsearchs will return nothing
3944 $self->{service_contact} = qsearchs('contact', {
3945 'classnum' => $classnum, 'custnum' => $self->custnum
3948 $self->{service_contact};
3953 Returns a name string for this (service/shipping) contact, either
3954 "Company (Last, First)" or "Last, First".
3961 my $name = $self->ship_contact;
3962 $name = $self->company. " ($name)" if $self->company;
3968 Returns a name string for this customer, either "Company" or "First Last".
3974 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3977 =item ship_name_short
3979 Returns a name string for this (service/shipping) contact, either "Company"
3984 sub ship_name_short {
3986 $self->service_contact
3987 ? $self->ship_contact_firstlast
3993 Returns this customer's full (billing) contact name only, "Last, First"
3999 $self->get('last'). ', '. $self->first;
4004 Returns this customer's full (shipping) contact name only, "Last, First"
4010 my $contact = $self->service_contact || $self;
4011 $contact->get('last') . ', ' . $contact->get('first');
4014 =item contact_firstlast
4016 Returns this customers full (billing) contact name only, "First Last".
4020 sub contact_firstlast {
4022 $self->first. ' '. $self->get('last');
4025 =item ship_contact_firstlast
4027 Returns this customer's full (shipping) contact name only, "First Last".
4031 sub ship_contact_firstlast {
4033 my $contact = $self->service_contact || $self;
4034 $contact->get('first') . ' '. $contact->get('last');
4037 #XXX this doesn't work in 3.x+
4040 #Returns this customer's full country name
4046 # code2country($self->country);
4049 =item county_state_county [ PREFIX ]
4051 Returns a string consisting of just the county, state and country.
4055 sub county_state_country {
4058 if ( @_ && $_[0] && $self->has_ship_address ) {
4059 $locationnum = $self->ship_locationnum;
4061 $locationnum = $self->bill_locationnum;
4063 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4064 $cust_location->county_state_country;
4067 =item geocode DATA_VENDOR
4069 Returns a value for the customer location as encoded by DATA_VENDOR.
4070 Currently this only makes sense for "CCH" as DATA_VENDOR.
4078 Returns a status string for this customer, currently:
4082 =item prospect - No packages have ever been ordered
4084 =item ordered - Recurring packages all are new (not yet billed).
4086 =item active - One or more recurring packages is active
4088 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4090 =item suspended - All non-cancelled recurring packages are suspended
4092 =item cancelled - All recurring packages are cancelled
4096 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4097 cust_main-status_module configuration option.
4101 sub status { shift->cust_status(@_); }
4105 for my $status ( FS::cust_main->statuses() ) {
4106 my $method = $status.'_sql';
4107 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4108 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4109 $sth->execute( ($self->custnum) x $numnum )
4110 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4111 return $status if $sth->fetchrow_arrayref->[0];
4115 =item ucfirst_cust_status
4117 =item ucfirst_status
4119 Returns the status with the first character capitalized.
4123 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4125 sub ucfirst_cust_status {
4127 ucfirst($self->cust_status);
4132 Returns a hex triplet color string for this customer's status.
4136 sub statuscolor { shift->cust_statuscolor(@_); }
4138 sub cust_statuscolor {
4140 __PACKAGE__->statuscolors->{$self->cust_status};
4143 =item tickets [ STATUS ]
4145 Returns an array of hashes representing the customer's RT tickets.
4147 An optional status (or arrayref or hashref of statuses) may be specified.
4153 my $status = ( @_ && $_[0] ) ? shift : '';
4155 my $num = $conf->config('cust_main-max_tickets') || 10;
4158 if ( $conf->config('ticket_system') ) {
4159 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4161 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4170 foreach my $priority (
4171 $conf->config('ticket_system-custom_priority_field-values'), ''
4173 last if scalar(@tickets) >= $num;
4175 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4176 $num - scalar(@tickets),
4187 # Return services representing svc_accts in customer support packages
4188 sub support_services {
4190 my %packages = map { $_ => 1 } $conf->config('support_packages');
4192 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4193 grep { $_->part_svc->svcdb eq 'svc_acct' }
4194 map { $_->cust_svc }
4195 grep { exists $packages{ $_->pkgpart } }
4196 $self->ncancelled_pkgs;
4200 # Return a list of latitude/longitude for one of the services (if any)
4201 sub service_coordinates {
4205 grep { $_->latitude && $_->longitude }
4207 map { $_->cust_svc }
4208 $self->ncancelled_pkgs;
4210 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4215 Returns a masked version of the named field
4220 my ($self,$field) = @_;
4224 'x'x(length($self->getfield($field))-4).
4225 substr($self->getfield($field), (length($self->getfield($field))-4));
4231 =head1 CLASS METHODS
4237 Class method that returns the list of possible status strings for customers
4238 (see L<the status method|/status>). For example:
4240 @statuses = FS::cust_main->statuses();
4246 keys %{ $self->statuscolors };
4249 =item cust_status_sql
4251 Returns an SQL fragment to determine the status of a cust_main record, as a
4256 sub cust_status_sql {
4258 for my $status ( FS::cust_main->statuses() ) {
4259 my $method = $status.'_sql';
4260 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4269 Returns an SQL expression identifying prospective cust_main records (customers
4270 with no packages ever ordered)
4274 use vars qw($select_count_pkgs);
4275 $select_count_pkgs =
4276 "SELECT COUNT(*) FROM cust_pkg
4277 WHERE cust_pkg.custnum = cust_main.custnum";
4279 sub select_count_pkgs_sql {
4284 " 0 = ( $select_count_pkgs ) ";
4289 Returns an SQL expression identifying ordered cust_main records (customers with
4290 no active packages, but recurring packages not yet setup or one time charges
4296 FS::cust_main->none_active_sql.
4297 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4302 Returns an SQL expression identifying active cust_main records (customers with
4303 active recurring packages).
4308 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4311 =item none_active_sql
4313 Returns an SQL expression identifying cust_main records with no active
4314 recurring packages. This includes customers of status prospect, ordered,
4315 inactive, and suspended.
4319 sub none_active_sql {
4320 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4325 Returns an SQL expression identifying inactive cust_main records (customers with
4326 no active recurring packages, but otherwise unsuspended/uncancelled).
4331 FS::cust_main->none_active_sql.
4332 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4338 Returns an SQL expression identifying suspended cust_main records.
4343 sub suspended_sql { susp_sql(@_); }
4345 FS::cust_main->none_active_sql.
4346 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4352 Returns an SQL expression identifying cancelled cust_main records.
4356 sub cancel_sql { shift->cancelled_sql(@_); }
4359 =item uncancelled_sql
4361 Returns an SQL expression identifying un-cancelled cust_main records.
4365 sub uncancelled_sql { uncancel_sql(@_); }
4366 sub uncancel_sql { "
4367 ( 0 < ( $select_count_pkgs
4368 AND ( cust_pkg.cancel IS NULL
4369 OR cust_pkg.cancel = 0
4372 OR 0 = ( $select_count_pkgs )
4378 Returns an SQL fragment to retreive the balance.
4383 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4384 WHERE cust_bill.custnum = cust_main.custnum )
4385 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4386 WHERE cust_pay.custnum = cust_main.custnum )
4387 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4388 WHERE cust_credit.custnum = cust_main.custnum )
4389 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4390 WHERE cust_refund.custnum = cust_main.custnum )
4393 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4395 Returns an SQL fragment to retreive the balance for this customer, optionally
4396 considering invoices with date earlier than START_TIME, and not
4397 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4398 total_unapplied_payments).
4400 Times are specified as SQL fragments or numeric
4401 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4402 L<Date::Parse> for conversion functions. The empty string can be passed
4403 to disable that time constraint completely.
4405 Available options are:
4409 =item unapplied_date
4411 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)
4416 set to true to remove all customer comparison clauses, for totals
4421 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4426 JOIN clause (typically used with the total option)
4430 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4431 time will be ignored. Note that START_TIME and END_TIME only limit the date
4432 range for invoices and I<unapplied> payments, credits, and refunds.
4438 sub balance_date_sql {
4439 my( $class, $start, $end, %opt ) = @_;
4441 my $cutoff = $opt{'cutoff'};
4443 my $owed = FS::cust_bill->owed_sql($cutoff);
4444 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4445 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4446 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4448 my $j = $opt{'join'} || '';
4450 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4451 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4452 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4453 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4455 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4456 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4457 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4458 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4463 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4465 Returns an SQL fragment to retreive the total unapplied payments for this
4466 customer, only considering payments with date earlier than START_TIME, and
4467 optionally not later than END_TIME.
4469 Times are specified as SQL fragments or numeric
4470 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4471 L<Date::Parse> for conversion functions. The empty string can be passed
4472 to disable that time constraint completely.
4474 Available options are:
4478 sub unapplied_payments_date_sql {
4479 my( $class, $start, $end, %opt ) = @_;
4481 my $cutoff = $opt{'cutoff'};
4483 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4485 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4486 'unapplied_date'=>1 );
4488 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4491 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4493 Helper method for balance_date_sql; name (and usage) subject to change
4494 (suggestions welcome).
4496 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4497 cust_refund, cust_credit or cust_pay).
4499 If TABLE is "cust_bill" or the unapplied_date option is true, only
4500 considers records with date earlier than START_TIME, and optionally not
4501 later than END_TIME .
4505 sub _money_table_where {
4506 my( $class, $table, $start, $end, %opt ) = @_;
4509 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4510 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4511 push @where, "$table._date <= $start" if defined($start) && length($start);
4512 push @where, "$table._date > $end" if defined($end) && length($end);
4514 push @where, @{$opt{'where'}} if $opt{'where'};
4515 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4521 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4522 use FS::cust_main::Search;
4525 FS::cust_main::Search->search(@_);
4540 #warn join('-',keys %$param);
4541 my $fh = $param->{filehandle};
4542 my $agentnum = $param->{agentnum};
4543 my $format = $param->{format};
4545 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4548 if ( $format eq 'simple' ) {
4549 @fields = qw( custnum agent_custid amount pkg );
4551 die "unknown format $format";
4554 eval "use Text::CSV_XS;";
4557 my $csv = new Text::CSV_XS;
4564 local $SIG{HUP} = 'IGNORE';
4565 local $SIG{INT} = 'IGNORE';
4566 local $SIG{QUIT} = 'IGNORE';
4567 local $SIG{TERM} = 'IGNORE';
4568 local $SIG{TSTP} = 'IGNORE';
4569 local $SIG{PIPE} = 'IGNORE';
4571 my $oldAutoCommit = $FS::UID::AutoCommit;
4572 local $FS::UID::AutoCommit = 0;
4575 #while ( $columns = $csv->getline($fh) ) {
4577 while ( defined($line=<$fh>) ) {
4579 $csv->parse($line) or do {
4580 $dbh->rollback if $oldAutoCommit;
4581 return "can't parse: ". $csv->error_input();
4584 my @columns = $csv->fields();
4585 #warn join('-',@columns);
4588 foreach my $field ( @fields ) {
4589 $row{$field} = shift @columns;
4592 if ( $row{custnum} && $row{agent_custid} ) {
4593 dbh->rollback if $oldAutoCommit;
4594 return "can't specify custnum with agent_custid $row{agent_custid}";
4598 if ( $row{agent_custid} && $agentnum ) {
4599 %hash = ( 'agent_custid' => $row{agent_custid},
4600 'agentnum' => $agentnum,
4604 if ( $row{custnum} ) {
4605 %hash = ( 'custnum' => $row{custnum} );
4608 unless ( scalar(keys %hash) ) {
4609 $dbh->rollback if $oldAutoCommit;
4610 return "can't find customer without custnum or agent_custid and agentnum";
4613 my $cust_main = qsearchs('cust_main', { %hash } );
4614 unless ( $cust_main ) {
4615 $dbh->rollback if $oldAutoCommit;
4616 my $custnum = $row{custnum} || $row{agent_custid};
4617 return "unknown custnum $custnum";
4620 if ( $row{'amount'} > 0 ) {
4621 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4623 $dbh->rollback if $oldAutoCommit;
4627 } elsif ( $row{'amount'} < 0 ) {
4628 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4631 $dbh->rollback if $oldAutoCommit;
4641 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4643 return "Empty file!" unless $imported;
4649 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4651 Deprecated. Use event notification and message templates
4652 (L<FS::msg_template>) instead.
4654 Sends a templated email notification to the customer (see L<Text::Template>).
4656 OPTIONS is a hash and may include
4658 I<from> - the email sender (default is invoice_from)
4660 I<to> - comma-separated scalar or arrayref of recipients
4661 (default is invoicing_list)
4663 I<subject> - The subject line of the sent email notification
4664 (default is "Notice from company_name")
4666 I<extra_fields> - a hashref of name/value pairs which will be substituted
4669 The following variables are vavailable in the template.
4671 I<$first> - the customer first name
4672 I<$last> - the customer last name
4673 I<$company> - the customer company
4674 I<$payby> - a description of the method of payment for the customer
4675 # would be nice to use FS::payby::shortname
4676 I<$payinfo> - the account information used to collect for this customer
4677 I<$expdate> - the expiration of the customer payment in seconds from epoch
4682 my ($self, $template, %options) = @_;
4684 return unless $conf->exists($template);
4686 my $from = $conf->config('invoice_from', $self->agentnum)
4687 if $conf->exists('invoice_from', $self->agentnum);
4688 $from = $options{from} if exists($options{from});
4690 my $to = join(',', $self->invoicing_list_emailonly);
4691 $to = $options{to} if exists($options{to});
4693 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4694 if $conf->exists('company_name', $self->agentnum);
4695 $subject = $options{subject} if exists($options{subject});
4697 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4698 SOURCE => [ map "$_\n",
4699 $conf->config($template)]
4701 or die "can't create new Text::Template object: Text::Template::ERROR";
4702 $notify_template->compile()
4703 or die "can't compile template: Text::Template::ERROR";
4705 $FS::notify_template::_template::company_name =
4706 $conf->config('company_name', $self->agentnum);
4707 $FS::notify_template::_template::company_address =
4708 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4710 my $paydate = $self->paydate || '2037-12-31';
4711 $FS::notify_template::_template::first = $self->first;
4712 $FS::notify_template::_template::last = $self->last;
4713 $FS::notify_template::_template::company = $self->company;
4714 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4715 my $payby = $self->payby;
4716 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4717 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4719 #credit cards expire at the end of the month/year of their exp date
4720 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4721 $FS::notify_template::_template::payby = 'credit card';
4722 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4723 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4725 }elsif ($payby eq 'COMP') {
4726 $FS::notify_template::_template::payby = 'complimentary account';
4728 $FS::notify_template::_template::payby = 'current method';
4730 $FS::notify_template::_template::expdate = $expire_time;
4732 for (keys %{$options{extra_fields}}){
4734 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4737 send_email(from => $from,
4739 subject => $subject,
4740 body => $notify_template->fill_in( PACKAGE =>
4741 'FS::notify_template::_template' ),
4746 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4748 Generates a templated notification to the customer (see L<Text::Template>).
4750 OPTIONS is a hash and may include
4752 I<extra_fields> - a hashref of name/value pairs which will be substituted
4753 into the template. These values may override values mentioned below
4754 and those from the customer record.
4756 The following variables are available in the template instead of or in addition
4757 to the fields of the customer record.
4759 I<$payby> - a description of the method of payment for the customer
4760 # would be nice to use FS::payby::shortname
4761 I<$payinfo> - the masked account information used to collect for this customer
4762 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4763 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4767 # a lot like cust_bill::print_latex
4768 sub generate_letter {
4769 my ($self, $template, %options) = @_;
4771 return unless $conf->exists($template);
4773 my $letter_template = new Text::Template
4775 SOURCE => [ map "$_\n", $conf->config($template)],
4776 DELIMITERS => [ '[@--', '--@]' ],
4778 or die "can't create new Text::Template object: Text::Template::ERROR";
4780 $letter_template->compile()
4781 or die "can't compile template: Text::Template::ERROR";
4783 my %letter_data = map { $_ => $self->$_ } $self->fields;
4784 $letter_data{payinfo} = $self->mask_payinfo;
4786 #my $paydate = $self->paydate || '2037-12-31';
4787 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4789 my $payby = $self->payby;
4790 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4791 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4793 #credit cards expire at the end of the month/year of their exp date
4794 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4795 $letter_data{payby} = 'credit card';
4796 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4797 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4799 }elsif ($payby eq 'COMP') {
4800 $letter_data{payby} = 'complimentary account';
4802 $letter_data{payby} = 'current method';
4804 $letter_data{expdate} = $expire_time;
4806 for (keys %{$options{extra_fields}}){
4807 $letter_data{$_} = $options{extra_fields}->{$_};
4810 unless(exists($letter_data{returnaddress})){
4811 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4812 $self->agent_template)
4814 if ( length($retadd) ) {
4815 $letter_data{returnaddress} = $retadd;
4816 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4817 $letter_data{returnaddress} =
4818 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4822 ( $conf->config('company_name', $self->agentnum),
4823 $conf->config('company_address', $self->agentnum),
4827 $letter_data{returnaddress} = '~';
4831 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4833 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4835 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4837 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4841 ) or die "can't open temp file: $!\n";
4842 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4843 or die "can't write temp file: $!\n";
4845 $letter_data{'logo_file'} = $lh->filename;
4847 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4851 ) or die "can't open temp file: $!\n";
4853 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4855 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4856 return ($1, $letter_data{'logo_file'});
4860 =item print_ps TEMPLATE
4862 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4868 my($file, $lfile) = $self->generate_letter(@_);
4869 my $ps = FS::Misc::generate_ps($file);
4870 unlink($file.'.tex');
4876 =item print TEMPLATE
4878 Prints the filled in template.
4880 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4884 sub queueable_print {
4887 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4888 or die "invalid customer number: " . $opt{custvnum};
4890 my $error = $self->print( $opt{template} );
4891 die $error if $error;
4895 my ($self, $template) = (shift, shift);
4897 [ $self->print_ps($template) ],
4898 'agentnum' => $self->agentnum,
4902 #these three subs should just go away once agent stuff is all config overrides
4904 sub agent_template {
4906 $self->_agent_plandata('agent_templatename');
4909 sub agent_invoice_from {
4911 $self->_agent_plandata('agent_invoice_from');
4914 sub _agent_plandata {
4915 my( $self, $option ) = @_;
4917 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4918 #agent-specific Conf
4920 use FS::part_event::Condition;
4922 my $agentnum = $self->agentnum;
4924 my $regexp = regexp_sql();
4926 my $part_event_option =
4928 'select' => 'part_event_option.*',
4929 'table' => 'part_event_option',
4931 LEFT JOIN part_event USING ( eventpart )
4932 LEFT JOIN part_event_option AS peo_agentnum
4933 ON ( part_event.eventpart = peo_agentnum.eventpart
4934 AND peo_agentnum.optionname = 'agentnum'
4935 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4937 LEFT JOIN part_event_condition
4938 ON ( part_event.eventpart = part_event_condition.eventpart
4939 AND part_event_condition.conditionname = 'cust_bill_age'
4941 LEFT JOIN part_event_condition_option
4942 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4943 AND part_event_condition_option.optionname = 'age'
4946 #'hashref' => { 'optionname' => $option },
4947 #'hashref' => { 'part_event_option.optionname' => $option },
4949 " WHERE part_event_option.optionname = ". dbh->quote($option).
4950 " AND action = 'cust_bill_send_agent' ".
4951 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4952 " AND peo_agentnum.optionname = 'agentnum' ".
4953 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4955 CASE WHEN part_event_condition_option.optionname IS NULL
4957 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4959 , part_event.weight".
4963 unless ( $part_event_option ) {
4964 return $self->agent->invoice_template || ''
4965 if $option eq 'agent_templatename';
4969 $part_event_option->optionvalue;
4973 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4975 Subroutine (not a method), designed to be called from the queue.
4977 Takes a list of options and values.
4979 Pulls up the customer record via the custnum option and calls bill_and_collect.
4984 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4986 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4987 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4989 $cust_main->bill_and_collect( %args );
4992 sub process_bill_and_collect {
4994 my $param = thaw(decode_base64(shift));
4995 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4996 or die "custnum '$param->{custnum}' not found!\n";
4997 $param->{'job'} = $job;
4998 $param->{'fatal'} = 1; # runs from job queue, will be caught
4999 $param->{'retry'} = 1;
5001 $cust_main->bill_and_collect( %$param );
5004 #starting to take quite a while for big dbs
5005 # (JRNL: journaled so it only happens once per database)
5006 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5007 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5008 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5009 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5010 # JRNL leading/trailing spaces in first, last, company
5011 # - otaker upgrade? journal and call it good? (double check to make sure
5012 # we're not still setting otaker here)
5014 #only going to get worse with new location stuff...
5016 sub _upgrade_data { #class method
5017 my ($class, %opts) = @_;
5020 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5023 #this seems to be the only expensive one.. why does it take so long?
5024 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5026 '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';
5027 FS::upgrade_journal->set_done('cust_main__signupdate');
5030 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5032 # fix yyyy-m-dd formatted paydates
5033 if ( driver_name =~ /^mysql/i ) {
5035 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5036 } else { # the SQL standard
5038 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5040 FS::upgrade_journal->set_done('cust_main__paydate');
5043 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5045 push @statements, #fix the weird BILL with a cc# in payinfo problem
5047 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5049 FS::upgrade_journal->set_done('cust_main__payinfo');
5054 foreach my $sql ( @statements ) {
5055 my $sth = dbh->prepare($sql) or die dbh->errstr;
5056 $sth->execute or die $sth->errstr;
5057 #warn ( (time - $t). " seconds\n" );
5061 local($ignore_expired_card) = 1;
5062 local($ignore_banned_card) = 1;
5063 local($skip_fuzzyfiles) = 1;
5064 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5066 FS::cust_main::Location->_upgrade_data(%opts);
5068 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5070 foreach my $cust_main ( qsearch({
5071 'table' => 'cust_main',
5073 'extra_sql' => 'WHERE '.
5075 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5076 qw( first last company )
5079 my $error = $cust_main->replace;
5080 die $error if $error;
5083 FS::upgrade_journal->set_done('cust_main__trimspaces');
5087 $class->_upgrade_otaker(%opts);
5097 The delete method should possibly take an FS::cust_main object reference
5098 instead of a scalar customer number.
5100 Bill and collect options should probably be passed as references instead of a
5103 There should probably be a configuration file with a list of allowed credit
5106 No multiple currency support (probably a larger project than just this module).
5108 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5110 Birthdates rely on negative epoch values.
5112 The payby for card/check batches is broken. With mixed batching, bad
5115 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5119 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5120 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5121 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.