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::Location
10 FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
11 FS::geocode_Mixin FS::Quotable_Mixin
15 use vars qw( $DEBUG $me $conf
18 $ignore_expired_card $ignore_banned_card $ignore_illegal_zip
23 use Scalar::Util qw( blessed );
24 use Time::Local qw(timelocal);
25 use Storable qw(thaw);
29 use Digest::MD5 qw(md5_base64);
32 use File::Temp; #qw( tempfile );
33 use Business::CreditCard 0.28;
35 use FS::UID qw( getotaker dbh driver_name );
36 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
37 use FS::Misc qw( generate_email send_email generate_ps do_print );
38 use FS::Msgcat qw(gettext);
45 use FS::cust_bill_void;
46 use FS::legacy_cust_bill;
48 use FS::cust_pay_pending;
49 use FS::cust_pay_void;
50 use FS::cust_pay_batch;
53 use FS::part_referral;
54 use FS::cust_main_county;
55 use FS::cust_location;
57 use FS::cust_main_exemption;
58 use FS::cust_tax_adjustment;
59 use FS::cust_tax_location;
61 use FS::cust_main_invoice;
63 use FS::prepay_credit;
69 use FS::payment_gateway;
70 use FS::agent_payment_gateway;
72 use FS::cust_main_note;
73 use FS::cust_attachment;
76 use FS::upgrade_journal;
78 # 1 is mostly method/subroutine entry and options
79 # 2 traces progress of some operations
80 # 3 is even more information including possibly sensitive data
82 $me = '[FS::cust_main]';
85 $ignore_expired_card = 0;
86 $ignore_banned_card = 0;
90 @encrypted_fields = ('payinfo', 'paycvv');
91 sub nohistory_fields { ('payinfo', 'paycvv'); }
93 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
95 #ask FS::UID to run this stuff for us later
96 #$FS::UID::callback{'FS::cust_main'} = sub {
97 install_callback FS::UID sub {
99 #yes, need it for stuff below (prolly should be cached)
104 my ( $hashref, $cache ) = @_;
105 if ( exists $hashref->{'pkgnum'} ) {
106 #@{ $self->{'_pkgnum'} } = ();
107 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
108 $self->{'_pkgnum'} = $subcache;
109 #push @{ $self->{'_pkgnum'} },
110 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
116 FS::cust_main - Object methods for cust_main records
122 $record = new FS::cust_main \%hash;
123 $record = new FS::cust_main { 'column' => 'value' };
125 $error = $record->insert;
127 $error = $new_record->replace($old_record);
129 $error = $record->delete;
131 $error = $record->check;
133 @cust_pkg = $record->all_pkgs;
135 @cust_pkg = $record->ncancelled_pkgs;
137 @cust_pkg = $record->suspended_pkgs;
139 $error = $record->bill;
140 $error = $record->bill %options;
141 $error = $record->bill 'time' => $time;
143 $error = $record->collect;
144 $error = $record->collect %options;
145 $error = $record->collect 'invoice_time' => $time,
150 An FS::cust_main object represents a customer. FS::cust_main inherits from
151 FS::Record. The following fields are currently supported:
157 Primary key (assigned automatically for new customers)
161 Agent (see L<FS::agent>)
165 Advertising source (see L<FS::part_referral>)
177 Cocial security number (optional)
201 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
205 Payment Information (See L<FS::payinfo_Mixin> for data format)
209 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
213 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
217 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
221 Start date month (maestro/solo cards only)
225 Start date year (maestro/solo cards only)
229 Issue number (maestro/solo cards only)
233 Name on card or billing name
237 IP address from which payment information was received
241 Tax exempt, empty or `Y'
245 Order taker (see L<FS::access_user>)
251 =item referral_custnum
253 Referring customer number
257 Enable individual CDR spooling, empty or `Y'
261 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
265 Discourage individual CDR printing, empty or `Y'
269 Allow self-service editing of ticket subjects, empty or 'Y'
271 =item calling_list_exempt
273 Do not call, empty or 'Y'
283 Creates a new customer. To add the customer to the database, see L<"insert">.
285 Note that this stores the hash reference, not a distinct copy of the hash it
286 points to. You can ask the object for a copy with the I<hash> method.
290 sub table { 'cust_main'; }
292 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
294 Adds this customer to the database. If there is an error, returns the error,
295 otherwise returns false.
297 Usually the customer's location will not yet exist in the database, and
298 the C<bill_location> and C<ship_location> pseudo-fields must be set to
299 uninserted L<FS::cust_location> objects. These will be inserted and linked
300 (in both directions) to the new customer record. If they're references
301 to the same object, they will become the same location.
303 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
304 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
305 are inserted atomicly, or the transaction is rolled back. Passing an empty
306 hash reference is equivalent to not supplying this parameter. There should be
307 a better explanation of this, but until then, here's an example:
310 tie %hash, 'Tie::RefHash'; #this part is important
312 $cust_pkg => [ $svc_acct ],
315 $cust_main->insert( \%hash );
317 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
318 be set as the invoicing list (see L<"invoicing_list">). Errors return as
319 expected and rollback the entire transaction; it is not necessary to call
320 check_invoicing_list first. The invoicing_list is set after the records in the
321 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
322 invoicing_list destination to the newly-created svc_acct. Here's an example:
324 $cust_main->insert( {}, [ $email, 'POST' ] );
326 Currently available options are: I<depend_jobnum>, I<noexport>,
327 I<tax_exemption> and I<prospectnum>.
329 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
330 on the supplied jobnum (they will not run until the specific job completes).
331 This can be used to defer provisioning until some action completes (such
332 as running the customer's credit card successfully).
334 The I<noexport> option is deprecated. If I<noexport> is set true, no
335 provisioning jobs (exports) are scheduled. (You can schedule them later with
336 the B<reexport> method.)
338 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
339 of tax names and exemption numbers. FS::cust_main_exemption records will be
340 created and inserted.
342 If I<prospectnum> is set, moves contacts and locations from that prospect.
348 my $cust_pkgs = @_ ? shift : {};
349 my $invoicing_list = @_ ? shift : '';
351 warn "$me insert called with options ".
352 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
355 local $SIG{HUP} = 'IGNORE';
356 local $SIG{INT} = 'IGNORE';
357 local $SIG{QUIT} = 'IGNORE';
358 local $SIG{TERM} = 'IGNORE';
359 local $SIG{TSTP} = 'IGNORE';
360 local $SIG{PIPE} = 'IGNORE';
362 my $oldAutoCommit = $FS::UID::AutoCommit;
363 local $FS::UID::AutoCommit = 0;
366 my $prepay_identifier = '';
367 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
369 if ( $self->payby eq 'PREPAY' ) {
371 $self->payby('BILL');
372 $prepay_identifier = $self->payinfo;
375 warn " looking up prepaid card $prepay_identifier\n"
378 my $error = $self->get_prepay( $prepay_identifier,
379 'amount_ref' => \$amount,
380 'seconds_ref' => \$seconds,
381 'upbytes_ref' => \$upbytes,
382 'downbytes_ref' => \$downbytes,
383 'totalbytes_ref' => \$totalbytes,
386 $dbh->rollback if $oldAutoCommit;
387 #return "error applying prepaid card (transaction rolled back): $error";
391 $payby = 'PREP' if $amount;
393 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
396 $self->payby('BILL');
397 $amount = $self->paid;
402 foreach my $l (qw(bill_location ship_location)) {
403 my $loc = delete $self->hashref->{$l};
404 # XXX if we're moving a prospect's locations, do that here
409 if ( !$loc->locationnum ) {
410 # warn the location that we're going to insert it with no custnum
411 $loc->set(custnum_pending => 1);
412 warn " inserting $l\n"
414 my $error = $loc->insert;
416 $dbh->rollback if $oldAutoCommit;
417 my $label = $l eq 'ship_location' ? 'service' : 'billing';
418 return "$error (in $label location)";
421 elsif ( ($loc->custnum || 0) > 0 or $loc->prospectnum ) {
422 # then it somehow belongs to another customer--shouldn't happen
423 $dbh->rollback if $oldAutoCommit;
424 return "$l belongs to customer ".$loc->custnum;
426 # else it already belongs to this customer
427 # (happens when ship_location is identical to bill_location)
429 $self->set($l.'num', $loc->locationnum);
431 if ( $self->get($l.'num') eq '' ) {
432 $dbh->rollback if $oldAutoCommit;
437 warn " inserting $self\n"
440 $self->signupdate(time) unless $self->signupdate;
442 $self->auto_agent_custid()
443 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
445 my $error = $self->SUPER::insert;
447 $dbh->rollback if $oldAutoCommit;
448 #return "inserting cust_main record (transaction rolled back): $error";
452 # now set cust_location.custnum
453 foreach my $l (qw(bill_location ship_location)) {
454 warn " setting $l.custnum\n"
457 unless ( $loc->custnum ) {
458 $loc->set(custnum => $self->custnum);
459 $error ||= $loc->replace;
463 $dbh->rollback if $oldAutoCommit;
464 return "error setting $l custnum: $error";
468 warn " setting invoicing list\n"
471 if ( $invoicing_list ) {
472 $error = $self->check_invoicing_list( $invoicing_list );
474 $dbh->rollback if $oldAutoCommit;
475 #return "checking invoicing_list (transaction rolled back): $error";
478 $self->invoicing_list( $invoicing_list );
481 warn " setting customer tags\n"
484 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
485 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
486 'custnum' => $self->custnum };
487 my $error = $cust_tag->insert;
489 $dbh->rollback if $oldAutoCommit;
494 my $prospectnum = delete $options{'prospectnum'};
495 if ( $prospectnum ) {
497 warn " moving contacts and locations from prospect $prospectnum\n"
501 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
502 unless ( $prospect_main ) {
503 $dbh->rollback if $oldAutoCommit;
504 return "Unknown prospectnum $prospectnum";
506 $prospect_main->custnum($self->custnum);
507 $prospect_main->disabled('Y');
508 my $error = $prospect_main->replace;
510 $dbh->rollback if $oldAutoCommit;
514 my @contact = $prospect_main->contact;
515 my @cust_location = $prospect_main->cust_location;
516 my @qual = $prospect_main->qual;
518 foreach my $r ( @contact, @cust_location, @qual ) {
520 $r->custnum($self->custnum);
521 my $error = $r->replace;
523 $dbh->rollback if $oldAutoCommit;
530 warn " setting cust_main_exemption\n"
533 my $tax_exemption = delete $options{'tax_exemption'};
534 if ( $tax_exemption ) {
536 $tax_exemption = { map { $_ => '' } @$tax_exemption }
537 if ref($tax_exemption) eq 'ARRAY';
539 foreach my $taxname ( keys %$tax_exemption ) {
540 my $cust_main_exemption = new FS::cust_main_exemption {
541 'custnum' => $self->custnum,
542 'taxname' => $taxname,
543 'exempt_number' => $tax_exemption->{$taxname},
545 my $error = $cust_main_exemption->insert;
547 $dbh->rollback if $oldAutoCommit;
548 return "inserting cust_main_exemption (transaction rolled back): $error";
553 if ( $self->can('start_copy_skel') ) {
554 my $error = $self->start_copy_skel;
556 $dbh->rollback if $oldAutoCommit;
561 warn " ordering packages\n"
564 $error = $self->order_pkgs( $cust_pkgs,
566 'seconds_ref' => \$seconds,
567 'upbytes_ref' => \$upbytes,
568 'downbytes_ref' => \$downbytes,
569 'totalbytes_ref' => \$totalbytes,
572 $dbh->rollback if $oldAutoCommit;
577 $dbh->rollback if $oldAutoCommit;
578 return "No svc_acct record to apply pre-paid time";
580 if ( $upbytes || $downbytes || $totalbytes ) {
581 $dbh->rollback if $oldAutoCommit;
582 return "No svc_acct record to apply pre-paid data";
586 warn " inserting initial $payby payment of $amount\n"
588 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
590 $dbh->rollback if $oldAutoCommit;
591 return "inserting payment (transaction rolled back): $error";
595 unless ( $import || $skip_fuzzyfiles ) {
596 warn " queueing fuzzyfiles update\n"
598 $error = $self->queue_fuzzyfiles_update;
600 $dbh->rollback if $oldAutoCommit;
601 return "updating fuzzy search cache: $error";
605 # FS::geocode_Mixin::after_insert or something?
606 if ( $conf->config('tax_district_method') and !$import ) {
607 # if anything non-empty, try to look it up
608 my $queue = new FS::queue {
609 'job' => 'FS::geocode_Mixin::process_district_update',
610 'custnum' => $self->custnum,
612 my $error = $queue->insert( ref($self), $self->custnum );
614 $dbh->rollback if $oldAutoCommit;
615 return "queueing tax district update: $error";
620 warn " exporting\n" if $DEBUG > 1;
622 my $export_args = $options{'export_args'} || [];
625 map qsearch( 'part_export', {exportnum=>$_} ),
626 $conf->config('cust_main-exports'); #, $agentnum
628 foreach my $part_export ( @part_export ) {
629 my $error = $part_export->export_insert($self, @$export_args);
631 $dbh->rollback if $oldAutoCommit;
632 return "exporting to ". $part_export->exporttype.
633 " (transaction rolled back): $error";
637 #foreach my $depend_jobnum ( @$depend_jobnums ) {
638 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
640 # foreach my $jobnum ( @jobnums ) {
641 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
642 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
644 # my $error = $queue->depend_insert($depend_jobnum);
646 # $dbh->rollback if $oldAutoCommit;
647 # return "error queuing job dependancy: $error";
654 #if ( exists $options{'jobnums'} ) {
655 # push @{ $options{'jobnums'} }, @jobnums;
658 warn " insert complete; committing transaction\n"
661 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
666 use File::CounterFile;
667 sub auto_agent_custid {
670 my $format = $conf->config('cust_main-auto_agent_custid');
672 if ( $format eq '1YMMXXXXXXXX' ) {
674 my $counter = new File::CounterFile 'cust_main.agent_custid';
677 my $ym = 100000000000 + time2str('%y%m00000000', time);
678 if ( $ym > $counter->value ) {
679 $counter->{'value'} = $agent_custid = $ym;
680 $counter->{'updated'} = 1;
682 $agent_custid = $counter->inc;
688 die "Unknown cust_main-auto_agent_custid format: $format";
691 $self->agent_custid($agent_custid);
695 =item PACKAGE METHODS
697 Documentation on customer package methods has been moved to
698 L<FS::cust_main::Packages>.
700 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
702 Recharges this (existing) customer with the specified prepaid card (see
703 L<FS::prepay_credit>), specified either by I<identifier> or as an
704 FS::prepay_credit object. If there is an error, returns the error, otherwise
707 Optionally, five scalar references can be passed as well. They will have their
708 values filled in with the amount, number of seconds, and number of upload,
709 download, and total bytes applied by this prepaid card.
713 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
714 #the only place that uses these args
715 sub recharge_prepay {
716 my( $self, $prepay_credit, $amountref, $secondsref,
717 $upbytesref, $downbytesref, $totalbytesref ) = @_;
719 local $SIG{HUP} = 'IGNORE';
720 local $SIG{INT} = 'IGNORE';
721 local $SIG{QUIT} = 'IGNORE';
722 local $SIG{TERM} = 'IGNORE';
723 local $SIG{TSTP} = 'IGNORE';
724 local $SIG{PIPE} = 'IGNORE';
726 my $oldAutoCommit = $FS::UID::AutoCommit;
727 local $FS::UID::AutoCommit = 0;
730 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
732 my $error = $self->get_prepay( $prepay_credit,
733 'amount_ref' => \$amount,
734 'seconds_ref' => \$seconds,
735 'upbytes_ref' => \$upbytes,
736 'downbytes_ref' => \$downbytes,
737 'totalbytes_ref' => \$totalbytes,
739 || $self->increment_seconds($seconds)
740 || $self->increment_upbytes($upbytes)
741 || $self->increment_downbytes($downbytes)
742 || $self->increment_totalbytes($totalbytes)
743 || $self->insert_cust_pay_prepay( $amount,
745 ? $prepay_credit->identifier
750 $dbh->rollback if $oldAutoCommit;
754 if ( defined($amountref) ) { $$amountref = $amount; }
755 if ( defined($secondsref) ) { $$secondsref = $seconds; }
756 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
757 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
758 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
760 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
765 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
767 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
768 specified either by I<identifier> or as an FS::prepay_credit object.
770 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
771 incremented by the values of the prepaid card.
773 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
774 check or set this customer's I<agentnum>.
776 If there is an error, returns the error, otherwise returns false.
782 my( $self, $prepay_credit, %opt ) = @_;
784 local $SIG{HUP} = 'IGNORE';
785 local $SIG{INT} = 'IGNORE';
786 local $SIG{QUIT} = 'IGNORE';
787 local $SIG{TERM} = 'IGNORE';
788 local $SIG{TSTP} = 'IGNORE';
789 local $SIG{PIPE} = 'IGNORE';
791 my $oldAutoCommit = $FS::UID::AutoCommit;
792 local $FS::UID::AutoCommit = 0;
795 unless ( ref($prepay_credit) ) {
797 my $identifier = $prepay_credit;
799 $prepay_credit = qsearchs(
801 { 'identifier' => $identifier },
806 unless ( $prepay_credit ) {
807 $dbh->rollback if $oldAutoCommit;
808 return "Invalid prepaid card: ". $identifier;
813 if ( $prepay_credit->agentnum ) {
814 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
815 $dbh->rollback if $oldAutoCommit;
816 return "prepaid card not valid for agent ". $self->agentnum;
818 $self->agentnum($prepay_credit->agentnum);
821 my $error = $prepay_credit->delete;
823 $dbh->rollback if $oldAutoCommit;
824 return "removing prepay_credit (transaction rolled back): $error";
827 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
828 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
830 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
835 =item increment_upbytes SECONDS
837 Updates this customer's single or primary account (see L<FS::svc_acct>) by
838 the specified number of upbytes. If there is an error, returns the error,
839 otherwise returns false.
843 sub increment_upbytes {
844 _increment_column( shift, 'upbytes', @_);
847 =item increment_downbytes SECONDS
849 Updates this customer's single or primary account (see L<FS::svc_acct>) by
850 the specified number of downbytes. If there is an error, returns the error,
851 otherwise returns false.
855 sub increment_downbytes {
856 _increment_column( shift, 'downbytes', @_);
859 =item increment_totalbytes SECONDS
861 Updates this customer's single or primary account (see L<FS::svc_acct>) by
862 the specified number of totalbytes. If there is an error, returns the error,
863 otherwise returns false.
867 sub increment_totalbytes {
868 _increment_column( shift, 'totalbytes', @_);
871 =item increment_seconds SECONDS
873 Updates this customer's single or primary account (see L<FS::svc_acct>) by
874 the specified number of seconds. If there is an error, returns the error,
875 otherwise returns false.
879 sub increment_seconds {
880 _increment_column( shift, 'seconds', @_);
883 =item _increment_column AMOUNT
885 Updates this customer's single or primary account (see L<FS::svc_acct>) by
886 the specified number of seconds or bytes. If there is an error, returns
887 the error, otherwise returns false.
891 sub _increment_column {
892 my( $self, $column, $amount ) = @_;
893 warn "$me increment_column called: $column, $amount\n"
896 return '' unless $amount;
898 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
899 $self->ncancelled_pkgs;
902 return 'No packages with primary or single services found'.
903 ' to apply pre-paid time';
904 } elsif ( scalar(@cust_pkg) > 1 ) {
905 #maybe have a way to specify the package/account?
906 return 'Multiple packages found to apply pre-paid time';
909 my $cust_pkg = $cust_pkg[0];
910 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
914 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
917 return 'No account found to apply pre-paid time';
918 } elsif ( scalar(@cust_svc) > 1 ) {
919 return 'Multiple accounts found to apply pre-paid time';
922 my $svc_acct = $cust_svc[0]->svc_x;
923 warn " found service svcnum ". $svc_acct->pkgnum.
924 ' ('. $svc_acct->email. ")\n"
927 $column = "increment_$column";
928 $svc_acct->$column($amount);
932 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
934 Inserts a prepayment in the specified amount for this customer. An optional
935 second argument can specify the prepayment identifier for tracking purposes.
936 If there is an error, returns the error, otherwise returns false.
940 sub insert_cust_pay_prepay {
941 shift->insert_cust_pay('PREP', @_);
944 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
946 Inserts a cash payment in the specified amount for this customer. An optional
947 second argument can specify the payment identifier for tracking purposes.
948 If there is an error, returns the error, otherwise returns false.
952 sub insert_cust_pay_cash {
953 shift->insert_cust_pay('CASH', @_);
956 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
958 Inserts a Western Union payment in the specified amount for this customer. An
959 optional second argument can specify the prepayment identifier for tracking
960 purposes. If there is an error, returns the error, otherwise returns false.
964 sub insert_cust_pay_west {
965 shift->insert_cust_pay('WEST', @_);
968 sub insert_cust_pay {
969 my( $self, $payby, $amount ) = splice(@_, 0, 3);
970 my $payinfo = scalar(@_) ? shift : '';
972 my $cust_pay = new FS::cust_pay {
973 'custnum' => $self->custnum,
974 'paid' => sprintf('%.2f', $amount),
975 #'_date' => #date the prepaid card was purchased???
977 'payinfo' => $payinfo,
985 This method is deprecated. See the I<depend_jobnum> option to the insert and
986 order_pkgs methods for a better way to defer provisioning.
988 Re-schedules all exports by calling the B<reexport> method of all associated
989 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
990 otherwise returns false.
997 carp "WARNING: FS::cust_main::reexport is deprectated; ".
998 "use the depend_jobnum option to insert or order_pkgs to delay export";
1000 local $SIG{HUP} = 'IGNORE';
1001 local $SIG{INT} = 'IGNORE';
1002 local $SIG{QUIT} = 'IGNORE';
1003 local $SIG{TERM} = 'IGNORE';
1004 local $SIG{TSTP} = 'IGNORE';
1005 local $SIG{PIPE} = 'IGNORE';
1007 my $oldAutoCommit = $FS::UID::AutoCommit;
1008 local $FS::UID::AutoCommit = 0;
1011 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1012 my $error = $cust_pkg->reexport;
1014 $dbh->rollback if $oldAutoCommit;
1019 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1024 =item delete [ OPTION => VALUE ... ]
1026 This deletes the customer. If there is an error, returns the error, otherwise
1029 This will completely remove all traces of the customer record. This is not
1030 what you want when a customer cancels service; for that, cancel all of the
1031 customer's packages (see L</cancel>).
1033 If the customer has any uncancelled packages, you need to pass a new (valid)
1034 customer number for those packages to be transferred to, as the "new_customer"
1035 option. Cancelled packages will be deleted. Did I mention that this is NOT
1036 what you want when a customer cancels service and that you really should be
1037 looking at L<FS::cust_pkg/cancel>?
1039 You can't delete a customer with invoices (see L<FS::cust_bill>),
1040 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1041 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1042 set the "delete_financials" option to a true value.
1047 my( $self, %opt ) = @_;
1049 local $SIG{HUP} = 'IGNORE';
1050 local $SIG{INT} = 'IGNORE';
1051 local $SIG{QUIT} = 'IGNORE';
1052 local $SIG{TERM} = 'IGNORE';
1053 local $SIG{TSTP} = 'IGNORE';
1054 local $SIG{PIPE} = 'IGNORE';
1056 my $oldAutoCommit = $FS::UID::AutoCommit;
1057 local $FS::UID::AutoCommit = 0;
1060 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1061 $dbh->rollback if $oldAutoCommit;
1062 return "Can't delete a master agent customer";
1065 #use FS::access_user
1066 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1067 $dbh->rollback if $oldAutoCommit;
1068 return "Can't delete a master employee customer";
1071 tie my %financial_tables, 'Tie::IxHash',
1072 'cust_bill' => 'invoices',
1073 'cust_statement' => 'statements',
1074 'cust_credit' => 'credits',
1075 'cust_pay' => 'payments',
1076 'cust_refund' => 'refunds',
1079 foreach my $table ( keys %financial_tables ) {
1081 my @records = $self->$table();
1083 if ( @records && ! $opt{'delete_financials'} ) {
1084 $dbh->rollback if $oldAutoCommit;
1085 return "Can't delete a customer with ". $financial_tables{$table};
1088 foreach my $record ( @records ) {
1089 my $error = $record->delete;
1091 $dbh->rollback if $oldAutoCommit;
1092 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1098 my @cust_pkg = $self->ncancelled_pkgs;
1100 my $new_custnum = $opt{'new_custnum'};
1101 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1102 $dbh->rollback if $oldAutoCommit;
1103 return "Invalid new customer number: $new_custnum";
1105 foreach my $cust_pkg ( @cust_pkg ) {
1106 my %hash = $cust_pkg->hash;
1107 $hash{'custnum'} = $new_custnum;
1108 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1109 my $error = $new_cust_pkg->replace($cust_pkg,
1110 options => { $cust_pkg->options },
1113 $dbh->rollback if $oldAutoCommit;
1118 my @cancelled_cust_pkg = $self->all_pkgs;
1119 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1120 my $error = $cust_pkg->delete;
1122 $dbh->rollback if $oldAutoCommit;
1127 #cust_tax_adjustment in financials?
1128 #cust_pay_pending? ouch
1130 foreach my $table (qw(
1131 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1132 cust_location cust_main_note cust_tax_adjustment
1133 cust_pay_void cust_pay_batch queue cust_tax_exempt
1135 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1136 my $error = $record->delete;
1138 $dbh->rollback if $oldAutoCommit;
1144 my $sth = $dbh->prepare(
1145 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1147 my $errstr = $dbh->errstr;
1148 $dbh->rollback if $oldAutoCommit;
1151 $sth->execute($self->custnum) or do {
1152 my $errstr = $sth->errstr;
1153 $dbh->rollback if $oldAutoCommit;
1159 my $ticket_dbh = '';
1160 if ($conf->config('ticket_system') eq 'RT_Internal') {
1162 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1163 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1164 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1165 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1168 if ( $ticket_dbh ) {
1170 my $ticket_sth = $ticket_dbh->prepare(
1171 'DELETE FROM Links WHERE Target = ?'
1173 my $errstr = $ticket_dbh->errstr;
1174 $dbh->rollback if $oldAutoCommit;
1177 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1179 my $errstr = $ticket_sth->errstr;
1180 $dbh->rollback if $oldAutoCommit;
1184 #check and see if the customer is the only link on the ticket, and
1185 #if so, set the ticket to deleted status in RT?
1186 #maybe someday, for now this will at least fix tickets not displaying
1190 #delete the customer record
1192 my $error = $self->SUPER::delete;
1194 $dbh->rollback if $oldAutoCommit;
1198 # cust_main exports!
1200 #my $export_args = $options{'export_args'} || [];
1203 map qsearch( 'part_export', {exportnum=>$_} ),
1204 $conf->config('cust_main-exports'); #, $agentnum
1206 foreach my $part_export ( @part_export ) {
1207 my $error = $part_export->export_delete( $self ); #, @$export_args);
1209 $dbh->rollback if $oldAutoCommit;
1210 return "exporting to ". $part_export->exporttype.
1211 " (transaction rolled back): $error";
1215 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1220 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1222 This merges this customer into the provided new custnum, and then deletes the
1223 customer. If there is an error, returns the error, otherwise returns false.
1225 The source customer's name, company name, phone numbers, agent,
1226 referring customer, customer class, advertising source, order taker, and
1227 billing information (except balance) are discarded.
1229 All packages are moved to the target customer. Packages with package locations
1230 are preserved. Packages without package locations are moved to a new package
1231 location with the source customer's service/shipping address.
1233 All invoices, statements, payments, credits and refunds are moved to the target
1234 customer. The source customer's balance is added to the target customer.
1236 All notes, attachments, tickets and customer tags are moved to the target
1239 Change history is not currently moved.
1244 my( $self, $new_custnum, %opt ) = @_;
1246 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1248 my $new_cust_main = qsearchs( 'cust_main', { 'custnum' => $new_custnum } )
1249 or return "Invalid new customer number: $new_custnum";
1251 return 'Access denied: "Merge customer across agents" access right required to merge into a customer of a different agent'
1252 if $self->agentnum != $new_cust_main->agentnum
1253 && ! $FS::CurrentUser::CurrentUser->access_right('Merge customer across agents');
1255 local $SIG{HUP} = 'IGNORE';
1256 local $SIG{INT} = 'IGNORE';
1257 local $SIG{QUIT} = 'IGNORE';
1258 local $SIG{TERM} = 'IGNORE';
1259 local $SIG{TSTP} = 'IGNORE';
1260 local $SIG{PIPE} = 'IGNORE';
1262 my $oldAutoCommit = $FS::UID::AutoCommit;
1263 local $FS::UID::AutoCommit = 0;
1266 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1267 $dbh->rollback if $oldAutoCommit;
1268 return "Can't merge a master agent customer";
1271 #use FS::access_user
1272 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1273 $dbh->rollback if $oldAutoCommit;
1274 return "Can't merge a master employee customer";
1277 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1278 'status' => { op=>'!=', value=>'done' },
1282 $dbh->rollback if $oldAutoCommit;
1283 return "Can't merge a customer with pending payments";
1286 tie my %financial_tables, 'Tie::IxHash',
1287 'cust_bill' => 'invoices',
1288 'cust_bill_void' => 'voided invoices',
1289 'cust_statement' => 'statements',
1290 'cust_credit' => 'credits',
1291 'cust_pay' => 'payments',
1292 'cust_pay_void' => 'voided payments',
1293 'cust_refund' => 'refunds',
1296 foreach my $table ( keys %financial_tables ) {
1298 my @records = $self->$table();
1300 foreach my $record ( @records ) {
1301 $record->custnum($new_custnum);
1302 my $error = $record->replace;
1304 $dbh->rollback if $oldAutoCommit;
1305 return "Error merging ". $financial_tables{$table}. ": $error\n";
1311 my $name = $self->ship_name; #?
1313 my $locationnum = '';
1314 foreach my $cust_pkg ( $self->all_pkgs ) {
1315 $cust_pkg->custnum($new_custnum);
1317 unless ( $cust_pkg->locationnum ) {
1318 unless ( $locationnum ) {
1319 my $cust_location = new FS::cust_location {
1320 $self->location_hash,
1321 'custnum' => $new_custnum,
1323 my $error = $cust_location->insert;
1325 $dbh->rollback if $oldAutoCommit;
1328 $locationnum = $cust_location->locationnum;
1330 $cust_pkg->locationnum($locationnum);
1333 my $error = $cust_pkg->replace;
1335 $dbh->rollback if $oldAutoCommit;
1339 # add customer (ship) name to svc_phone.phone_name if blank
1340 my @cust_svc = $cust_pkg->cust_svc;
1341 foreach my $cust_svc (@cust_svc) {
1342 my($label, $value, $svcdb) = $cust_svc->label;
1343 next unless $svcdb eq 'svc_phone';
1344 my $svc_phone = $cust_svc->svc_x;
1345 next if $svc_phone->phone_name;
1346 $svc_phone->phone_name($name);
1347 my $error = $svc_phone->replace;
1349 $dbh->rollback if $oldAutoCommit;
1357 # cust_tax_exempt (texas tax exemptions)
1358 # cust_recon (some sort of not-well understood thing for OnPac)
1360 #these are moved over
1361 foreach my $table (qw(
1362 cust_tag cust_location contact cust_attachment cust_main_note
1363 cust_tax_adjustment cust_pay_batch queue
1365 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1366 $record->custnum($new_custnum);
1367 my $error = $record->replace;
1369 $dbh->rollback if $oldAutoCommit;
1375 #these aren't preserved
1376 foreach my $table (qw(
1377 cust_main_exemption cust_main_invoice
1379 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1380 my $error = $record->delete;
1382 $dbh->rollback if $oldAutoCommit;
1389 my $sth = $dbh->prepare(
1390 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1392 my $errstr = $dbh->errstr;
1393 $dbh->rollback if $oldAutoCommit;
1396 $sth->execute($new_custnum, $self->custnum) or do {
1397 my $errstr = $sth->errstr;
1398 $dbh->rollback if $oldAutoCommit;
1404 my $ticket_dbh = '';
1405 if ($conf->config('ticket_system') eq 'RT_Internal') {
1407 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1408 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1409 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1410 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1413 if ( $ticket_dbh ) {
1415 my $ticket_sth = $ticket_dbh->prepare(
1416 'UPDATE Links SET Target = ? WHERE Target = ?'
1418 my $errstr = $ticket_dbh->errstr;
1419 $dbh->rollback if $oldAutoCommit;
1422 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1423 'freeside://freeside/cust_main/'.$self->custnum)
1425 my $errstr = $ticket_sth->errstr;
1426 $dbh->rollback if $oldAutoCommit;
1432 #delete the customer record
1434 my $error = $self->delete;
1436 $dbh->rollback if $oldAutoCommit;
1440 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1445 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1447 Replaces the OLD_RECORD with this one in the database. If there is an error,
1448 returns the error, otherwise returns false.
1450 To change the customer's address, set the pseudo-fields C<bill_location> and
1451 C<ship_location>. The address will still only change if at least one of the
1452 address fields differs from the existing values.
1454 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1455 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1456 expected and rollback the entire transaction; it is not necessary to call
1457 check_invoicing_list first. Here's an example:
1459 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1461 Currently available options are: I<tax_exemption>.
1463 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1464 of tax names and exemption numbers. FS::cust_main_exemption records will be
1465 deleted and inserted as appropriate.
1472 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1474 : $self->replace_old;
1478 warn "$me replace called\n"
1481 my $curuser = $FS::CurrentUser::CurrentUser;
1482 if ( $self->payby eq 'COMP'
1483 && $self->payby ne $old->payby
1484 && ! $curuser->access_right('Complimentary customer')
1487 return "You are not permitted to create complimentary accounts.";
1490 local($ignore_expired_card) = 1
1491 if $old->payby =~ /^(CARD|DCRD)$/
1492 && $self->payby =~ /^(CARD|DCRD)$/
1493 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1495 local($ignore_banned_card) = 1
1496 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1497 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1498 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1500 return "Invoicing locale is required"
1503 && $conf->exists('cust_main-require_locale');
1505 local $SIG{HUP} = 'IGNORE';
1506 local $SIG{INT} = 'IGNORE';
1507 local $SIG{QUIT} = 'IGNORE';
1508 local $SIG{TERM} = 'IGNORE';
1509 local $SIG{TSTP} = 'IGNORE';
1510 local $SIG{PIPE} = 'IGNORE';
1512 my $oldAutoCommit = $FS::UID::AutoCommit;
1513 local $FS::UID::AutoCommit = 0;
1516 for my $l (qw(bill_location ship_location)) {
1517 my $old_loc = $old->$l;
1518 my $new_loc = $self->$l;
1520 if ( !$new_loc->locationnum ) {
1522 # If the new location is all empty fields, or if it's identical to
1523 # the old location in all fields, don't replace.
1524 my @nonempty = grep { $new_loc->$_ } $self->location_fields;
1526 my @unlike = grep { $new_loc->$_ ne $old_loc->$_ } $self->location_fields;
1528 if ( @unlike or $old_loc->disabled ) {
1529 warn " changed $l fields: ".join(',',@unlike)."\n"
1531 $new_loc->set(custnum => $self->custnum);
1533 # insert it--the old location will be disabled later
1534 my $error = $new_loc->insert;
1536 $dbh->rollback if $oldAutoCommit;
1541 # no fields have changed and $old_loc isn't disabled, so don't change it
1546 elsif ( $new_loc->custnum ne $self->custnum or $new_loc->prospectnum ) {
1547 $dbh->rollback if $oldAutoCommit;
1548 return "$l belongs to customer ".$new_loc->custnum;
1550 # else the new location belongs to this customer so we're good
1552 # set the foo_locationnum now that we have one.
1553 $self->set($l.'num', $new_loc->locationnum);
1557 my $error = $self->SUPER::replace($old);
1560 $dbh->rollback if $oldAutoCommit;
1564 # now move packages to the new service location
1565 $self->set('ship_location', ''); #flush cache
1566 if ( $old->ship_locationnum and # should only be null during upgrade...
1567 $old->ship_locationnum != $self->ship_locationnum ) {
1568 $error = $old->ship_location->move_to($self->ship_location);
1570 $dbh->rollback if $oldAutoCommit;
1574 # don't move packages based on the billing location, but
1575 # disable it if it's no longer in use
1576 if ( $old->bill_locationnum and
1577 $old->bill_locationnum != $self->bill_locationnum ) {
1578 $error = $old->bill_location->disable_if_unused;
1580 $dbh->rollback if $oldAutoCommit;
1585 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1586 my $invoicing_list = shift @param;
1587 $error = $self->check_invoicing_list( $invoicing_list );
1589 $dbh->rollback if $oldAutoCommit;
1592 $self->invoicing_list( $invoicing_list );
1595 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1597 #this could be more efficient than deleting and re-inserting, if it matters
1598 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1599 my $error = $cust_tag->delete;
1601 $dbh->rollback if $oldAutoCommit;
1605 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1606 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1607 'custnum' => $self->custnum };
1608 my $error = $cust_tag->insert;
1610 $dbh->rollback if $oldAutoCommit;
1617 my %options = @param;
1619 my $tax_exemption = delete $options{'tax_exemption'};
1620 if ( $tax_exemption ) {
1622 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1623 if ref($tax_exemption) eq 'ARRAY';
1625 my %cust_main_exemption =
1626 map { $_->taxname => $_ }
1627 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1629 foreach my $taxname ( keys %$tax_exemption ) {
1631 if ( $cust_main_exemption{$taxname} &&
1632 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1635 delete $cust_main_exemption{$taxname};
1639 my $cust_main_exemption = new FS::cust_main_exemption {
1640 'custnum' => $self->custnum,
1641 'taxname' => $taxname,
1642 'exempt_number' => $tax_exemption->{$taxname},
1644 my $error = $cust_main_exemption->insert;
1646 $dbh->rollback if $oldAutoCommit;
1647 return "inserting cust_main_exemption (transaction rolled back): $error";
1651 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1652 my $error = $cust_main_exemption->delete;
1654 $dbh->rollback if $oldAutoCommit;
1655 return "deleting cust_main_exemption (transaction rolled back): $error";
1661 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1662 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1663 && $self->get('payinfo') !~ /^99\d{14}$/
1665 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1670 # card/check/lec info has changed, want to retry realtime_ invoice events
1671 my $error = $self->retry_realtime;
1673 $dbh->rollback if $oldAutoCommit;
1678 unless ( $import || $skip_fuzzyfiles ) {
1679 $error = $self->queue_fuzzyfiles_update;
1681 $dbh->rollback if $oldAutoCommit;
1682 return "updating fuzzy search cache: $error";
1686 # tax district update in cust_location
1688 # cust_main exports!
1690 my $export_args = $options{'export_args'} || [];
1693 map qsearch( 'part_export', {exportnum=>$_} ),
1694 $conf->config('cust_main-exports'); #, $agentnum
1696 foreach my $part_export ( @part_export ) {
1697 my $error = $part_export->export_replace( $self, $old, @$export_args);
1699 $dbh->rollback if $oldAutoCommit;
1700 return "exporting to ". $part_export->exporttype.
1701 " (transaction rolled back): $error";
1705 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1710 =item queue_fuzzyfiles_update
1712 Used by insert & replace to update the fuzzy search cache
1716 use FS::cust_main::Search;
1717 sub queue_fuzzyfiles_update {
1720 local $SIG{HUP} = 'IGNORE';
1721 local $SIG{INT} = 'IGNORE';
1722 local $SIG{QUIT} = 'IGNORE';
1723 local $SIG{TERM} = 'IGNORE';
1724 local $SIG{TSTP} = 'IGNORE';
1725 local $SIG{PIPE} = 'IGNORE';
1727 my $oldAutoCommit = $FS::UID::AutoCommit;
1728 local $FS::UID::AutoCommit = 0;
1731 my @locations = $self->bill_location;
1732 push @locations, $self->ship_location if $self->has_ship_address;
1733 foreach my $location (@locations) {
1734 my $queue = new FS::queue {
1735 'job' => 'FS::cust_main::Search::append_fuzzyfiles'
1737 my @args = map $location->get($_), @FS::cust_main::Search::fuzzyfields;
1738 my $error = $queue->insert( @args );
1740 $dbh->rollback if $oldAutoCommit;
1741 return "queueing job (transaction rolled back): $error";
1745 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1752 Checks all fields to make sure this is a valid customer record. If there is
1753 an error, returns the error, otherwise returns false. Called by the insert
1754 and replace methods.
1761 warn "$me check BEFORE: \n". $self->_dump
1765 $self->ut_numbern('custnum')
1766 || $self->ut_number('agentnum')
1767 || $self->ut_textn('agent_custid')
1768 || $self->ut_number('refnum')
1769 || $self->ut_foreign_key('bill_locationnum', 'cust_location','locationnum')
1770 || $self->ut_foreign_key('ship_locationnum', 'cust_location','locationnum')
1771 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1772 || $self->ut_textn('custbatch')
1773 || $self->ut_name('last')
1774 || $self->ut_name('first')
1775 || $self->ut_snumbern('signupdate')
1776 || $self->ut_snumbern('birthdate')
1777 || $self->ut_snumbern('spouse_birthdate')
1778 || $self->ut_snumbern('anniversary_date')
1779 || $self->ut_textn('company')
1780 || $self->ut_anything('comments')
1781 || $self->ut_numbern('referral_custnum')
1782 || $self->ut_textn('stateid')
1783 || $self->ut_textn('stateid_state')
1784 || $self->ut_textn('invoice_terms')
1785 || $self->ut_floatn('cdr_termination_percentage')
1786 || $self->ut_floatn('credit_limit')
1787 || $self->ut_numbern('billday')
1788 || $self->ut_numbern('prorate_day')
1789 || $self->ut_enum('edit_subject', [ '', 'Y' ] )
1790 || $self->ut_enum('calling_list_exempt', [ '', 'Y' ] )
1791 || $self->ut_enum('invoice_noemail', [ '', 'Y' ] )
1792 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1795 #barf. need message catalogs. i18n. etc.
1796 $error .= "Please select an advertising source."
1797 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1798 return $error if $error;
1800 return "Unknown agent"
1801 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1803 return "Unknown refnum"
1804 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1806 return "Unknown referring custnum: ". $self->referral_custnum
1807 unless ! $self->referral_custnum
1808 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1810 if ( $self->ss eq '' ) {
1815 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1816 or return "Illegal social security number: ". $self->ss;
1817 $self->ss("$1-$2-$3");
1820 # cust_main_county verification now handled by cust_location check
1823 $self->ut_phonen('daytime', $self->country)
1824 || $self->ut_phonen('night', $self->country)
1825 || $self->ut_phonen('fax', $self->country)
1826 || $self->ut_phonen('mobile', $self->country)
1828 return $error if $error;
1830 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1832 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1835 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1837 : FS::Msgcat::_gettext('daytime');
1838 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1840 : FS::Msgcat::_gettext('night');
1842 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1844 : FS::Msgcat::_gettext('mobile');
1846 return "$daytime_label, $night_label or $mobile_label is required"
1850 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1851 # or return "Illegal payby: ". $self->payby;
1853 FS::payby->can_payby($self->table, $self->payby)
1854 or return "Illegal payby: ". $self->payby;
1856 $error = $self->ut_numbern('paystart_month')
1857 || $self->ut_numbern('paystart_year')
1858 || $self->ut_numbern('payissue')
1859 || $self->ut_textn('paytype')
1861 return $error if $error;
1863 if ( $self->payip eq '' ) {
1866 $error = $self->ut_ip('payip');
1867 return $error if $error;
1870 # If it is encrypted and the private key is not availaible then we can't
1871 # check the credit card.
1872 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1874 # Need some kind of global flag to accept invalid cards, for testing
1876 if ( !$import && $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1878 my $payinfo = $self->payinfo;
1879 $payinfo =~ s/\D//g;
1880 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1881 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1883 $self->payinfo($payinfo);
1885 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1887 return gettext('unknown_card_type')
1888 if $self->payinfo !~ /^99\d{14}$/ #token
1889 && cardtype($self->payinfo) eq "Unknown";
1891 unless ( $ignore_banned_card ) {
1892 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1894 if ( $ban->bantype eq 'warn' ) {
1895 #or others depending on value of $ban->reason ?
1896 return '_duplicate_card'.
1897 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1898 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1899 ' (ban# '. $ban->bannum. ')'
1900 unless $self->override_ban_warn;
1902 return 'Banned credit card: banned on '.
1903 time2str('%a %h %o at %r', $ban->_date).
1904 ' by '. $ban->otaker.
1905 ' (ban# '. $ban->bannum. ')';
1910 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1911 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1912 $self->paycvv =~ /^(\d{4})$/
1913 or return "CVV2 (CID) for American Express cards is four digits.";
1916 $self->paycvv =~ /^(\d{3})$/
1917 or return "CVV2 (CVC2/CID) is three digits.";
1924 my $cardtype = cardtype($payinfo);
1925 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1927 return "Start date or issue number is required for $cardtype cards"
1928 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1930 return "Start month must be between 1 and 12"
1931 if $self->paystart_month
1932 and $self->paystart_month < 1 || $self->paystart_month > 12;
1934 return "Start year must be 1990 or later"
1935 if $self->paystart_year
1936 and $self->paystart_year < 1990;
1938 return "Issue number must be beween 1 and 99"
1940 and $self->payissue < 1 || $self->payissue > 99;
1943 $self->paystart_month('');
1944 $self->paystart_year('');
1945 $self->payissue('');
1948 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1950 my $payinfo = $self->payinfo;
1951 $payinfo =~ s/[^\d\@\.]//g;
1952 if ( $conf->config('echeck-country') eq 'CA' ) {
1953 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1954 or return 'invalid echeck account@branch.bank';
1955 $payinfo = "$1\@$2.$3";
1956 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1957 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1958 $payinfo = "$1\@$2";
1960 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1961 $payinfo = "$1\@$2";
1963 $self->payinfo($payinfo);
1966 unless ( $ignore_banned_card ) {
1967 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1969 if ( $ban->bantype eq 'warn' ) {
1970 #or others depending on value of $ban->reason ?
1971 return '_duplicate_ach' unless $self->override_ban_warn;
1973 return 'Banned ACH account: banned on '.
1974 time2str('%a %h %o at %r', $ban->_date).
1975 ' by '. $ban->otaker.
1976 ' (ban# '. $ban->bannum. ')';
1981 } elsif ( $self->payby eq 'LECB' ) {
1983 my $payinfo = $self->payinfo;
1984 $payinfo =~ s/\D//g;
1985 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1987 $self->payinfo($payinfo);
1990 } elsif ( $self->payby eq 'BILL' ) {
1992 $error = $self->ut_textn('payinfo');
1993 return "Illegal P.O. number: ". $self->payinfo if $error;
1996 } elsif ( $self->payby eq 'COMP' ) {
1998 my $curuser = $FS::CurrentUser::CurrentUser;
1999 if ( ! $self->custnum
2000 && ! $curuser->access_right('Complimentary customer')
2003 return "You are not permitted to create complimentary accounts."
2006 $error = $self->ut_textn('payinfo');
2007 return "Illegal comp account issuer: ". $self->payinfo if $error;
2010 } elsif ( $self->payby eq 'PREPAY' ) {
2012 my $payinfo = $self->payinfo;
2013 $payinfo =~ s/\W//g; #anything else would just confuse things
2014 $self->payinfo($payinfo);
2015 $error = $self->ut_alpha('payinfo');
2016 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2017 return "Unknown prepayment identifier"
2018 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2023 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2024 return "Expiration date required"
2025 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
2029 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2030 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2031 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2032 ( $m, $y ) = ( $2, "19$1" );
2033 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2034 ( $m, $y ) = ( $3, "20$2" );
2036 return "Illegal expiration date: ". $self->paydate;
2038 $m = sprintf('%02d',$m);
2039 $self->paydate("$y-$m-01");
2040 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2041 return gettext('expired_card')
2043 && !$ignore_expired_card
2044 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2047 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2048 ( ! $conf->exists('require_cardname')
2049 || $self->payby !~ /^(CARD|DCRD)$/ )
2051 $self->payname( $self->first. " ". $self->getfield('last') );
2053 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2054 or return gettext('illegal_name'). " payname: ". $self->payname;
2058 return "Please select an invoicing locale"
2061 && $conf->exists('cust_main-require_locale');
2063 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2064 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2068 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2070 warn "$me check AFTER: \n". $self->_dump
2073 $self->SUPER::check;
2078 Returns a list of fields which have ship_ duplicates.
2083 qw( last first company
2084 address1 address2 city county state zip country
2086 daytime night fax mobile
2090 =item has_ship_address
2092 Returns true if this customer record has a separate shipping address.
2096 sub has_ship_address {
2098 $self->bill_locationnum != $self->ship_locationnum;
2103 Returns a list of key/value pairs, with the following keys: address1,
2104 adddress2, city, county, state, zip, country, district, and geocode. The
2105 shipping address is used if present.
2111 $self->ship_location->location_hash;
2116 Returns all locations (see L<FS::cust_location>) for this customer.
2122 qsearch('cust_location', { 'custnum' => $self->custnum,
2123 'prospectnum' => '' } );
2128 Returns all contacts (see L<FS::contact>) for this customer.
2132 #already used :/ sub contact {
2135 qsearch('contact', { 'custnum' => $self->custnum } );
2140 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2141 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2142 on success or a list of errors.
2148 grep { $_->unsuspend } $self->suspended_pkgs;
2153 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2155 Returns a list: an empty list on success or a list of errors.
2161 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2164 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2166 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2167 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2168 of a list of pkgparts; the hashref has the following keys:
2172 =item pkgparts - listref of pkgparts
2174 =item (other options are passed to the suspend method)
2179 Returns a list: an empty list on success or a list of errors.
2183 sub suspend_if_pkgpart {
2185 my (@pkgparts, %opt);
2186 if (ref($_[0]) eq 'HASH'){
2187 @pkgparts = @{$_[0]{pkgparts}};
2192 grep { $_->suspend(%opt) }
2193 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2194 $self->unsuspended_pkgs;
2197 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2199 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2200 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2201 instead of a list of pkgparts; the hashref has the following keys:
2205 =item pkgparts - listref of pkgparts
2207 =item (other options are passed to the suspend method)
2211 Returns a list: an empty list on success or a list of errors.
2215 sub suspend_unless_pkgpart {
2217 my (@pkgparts, %opt);
2218 if (ref($_[0]) eq 'HASH'){
2219 @pkgparts = @{$_[0]{pkgparts}};
2224 grep { $_->suspend(%opt) }
2225 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2226 $self->unsuspended_pkgs;
2229 =item cancel [ OPTION => VALUE ... ]
2231 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2233 Available options are:
2237 =item quiet - can be set true to supress email cancellation notices.
2239 =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.
2241 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2243 =item nobill - can be set true to skip billing if it might otherwise be done.
2247 Always returns a list: an empty list on success or a list of errors.
2251 # nb that dates are not specified as valid options to this method
2254 my( $self, %opt ) = @_;
2256 warn "$me cancel called on customer ". $self->custnum. " with options ".
2257 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2260 return ( 'access denied' )
2261 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2263 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2265 #should try decryption (we might have the private key)
2266 # and if not maybe queue a job for the server that does?
2267 return ( "Can't (yet) ban encrypted credit cards" )
2268 if $self->is_encrypted($self->payinfo);
2270 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2271 my $error = $ban->insert;
2272 return ( $error ) if $error;
2276 my @pkgs = $self->ncancelled_pkgs;
2278 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2280 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2281 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2285 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2286 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2289 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2292 sub _banned_pay_hashref {
2303 'payby' => $payby2ban{$self->payby},
2304 'payinfo' => $self->payinfo,
2305 #don't ever *search* on reason! #'reason' =>
2309 sub _new_banned_pay_hashref {
2311 my $hr = $self->_banned_pay_hashref;
2312 $hr->{payinfo} = md5_base64($hr->{payinfo});
2318 Returns all notes (see L<FS::cust_main_note>) for this customer.
2323 my($self,$orderby_classnum) = (shift,shift);
2324 my $orderby = "_DATE DESC";
2325 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2326 qsearch( 'cust_main_note',
2327 { 'custnum' => $self->custnum },
2329 "ORDER BY $orderby",
2335 Returns the agent (see L<FS::agent>) for this customer.
2341 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2346 Returns the agent name (see L<FS::agent>) for this customer.
2352 $self->agent->agent;
2357 Returns any tags associated with this customer, as FS::cust_tag objects,
2358 or an empty list if there are no tags.
2364 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2369 Returns any tags associated with this customer, as FS::part_tag objects,
2370 or an empty list if there are no tags.
2376 map $_->part_tag, $self->cust_tag;
2382 Returns the customer class, as an FS::cust_class object, or the empty string
2383 if there is no customer class.
2389 if ( $self->classnum ) {
2390 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2398 Returns the customer category name, or the empty string if there is no customer
2405 my $cust_class = $self->cust_class;
2407 ? $cust_class->categoryname
2413 Returns the customer class name, or the empty string if there is no customer
2420 my $cust_class = $self->cust_class;
2422 ? $cust_class->classname
2426 =item BILLING METHODS
2428 Documentation on billing methods has been moved to
2429 L<FS::cust_main::Billing>.
2431 =item REALTIME BILLING METHODS
2433 Documentation on realtime billing methods has been moved to
2434 L<FS::cust_main::Billing_Realtime>.
2438 Removes the I<paycvv> field from the database directly.
2440 If there is an error, returns the error, otherwise returns false.
2446 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2447 or return dbh->errstr;
2448 $sth->execute($self->custnum)
2449 or return $sth->errstr;
2454 =item batch_card OPTION => VALUE...
2456 Adds a payment for this invoice to the pending credit card batch (see
2457 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2458 runs the payment using a realtime gateway.
2460 Options may include:
2462 B<amount>: the amount to be paid; defaults to the customer's balance minus
2463 any payments in transit.
2465 B<payby>: the payment method; defaults to cust_main.payby
2467 B<realtime>: runs this as a realtime payment instead of adding it to a
2470 B<invnum>: sets cust_pay_batch.invnum.
2472 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2473 the billing address for the payment; defaults to the customer's billing
2476 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2477 date, and name; defaults to those fields in cust_main.
2482 my ($self, %options) = @_;
2485 if (exists($options{amount})) {
2486 $amount = $options{amount};
2488 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2490 return '' unless $amount > 0;
2492 my $invnum = delete $options{invnum};
2493 my $payby = $options{payby} || $self->payby; #still dubious
2495 if ($options{'realtime'}) {
2496 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2502 my $oldAutoCommit = $FS::UID::AutoCommit;
2503 local $FS::UID::AutoCommit = 0;
2506 #this needs to handle mysql as well as Pg, like svc_acct.pm
2507 #(make it into a common function if folks need to do batching with mysql)
2508 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2509 or return "Cannot lock pay_batch: " . $dbh->errstr;
2513 'payby' => FS::payby->payby2payment($payby),
2515 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2517 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2519 unless ( $pay_batch ) {
2520 $pay_batch = new FS::pay_batch \%pay_batch;
2521 my $error = $pay_batch->insert;
2523 $dbh->rollback if $oldAutoCommit;
2524 die "error creating new batch: $error\n";
2528 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2529 'batchnum' => $pay_batch->batchnum,
2530 'custnum' => $self->custnum,
2533 foreach (qw( address1 address2 city state zip country latitude longitude
2534 payby payinfo paydate payname ))
2536 $options{$_} = '' unless exists($options{$_});
2539 my $loc = $self->bill_location;
2541 my $cust_pay_batch = new FS::cust_pay_batch ( {
2542 'batchnum' => $pay_batch->batchnum,
2543 'invnum' => $invnum || 0, # is there a better value?
2544 # this field should be
2546 # cust_bill_pay_batch now
2547 'custnum' => $self->custnum,
2548 'last' => $self->getfield('last'),
2549 'first' => $self->getfield('first'),
2550 'address1' => $options{address1} || $loc->address1,
2551 'address2' => $options{address2} || $loc->address2,
2552 'city' => $options{city} || $loc->city,
2553 'state' => $options{state} || $loc->state,
2554 'zip' => $options{zip} || $loc->zip,
2555 'country' => $options{country} || $loc->country,
2556 'payby' => $options{payby} || $self->payby,
2557 'payinfo' => $options{payinfo} || $self->payinfo,
2558 'exp' => $options{paydate} || $self->paydate,
2559 'payname' => $options{payname} || $self->payname,
2560 'amount' => $amount, # consolidating
2563 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2564 if $old_cust_pay_batch;
2567 if ($old_cust_pay_batch) {
2568 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2570 $error = $cust_pay_batch->insert;
2574 $dbh->rollback if $oldAutoCommit;
2578 my $unapplied = $self->total_unapplied_credits
2579 + $self->total_unapplied_payments
2580 + $self->in_transit_payments;
2581 foreach my $cust_bill ($self->open_cust_bill) {
2582 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2583 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2584 'invnum' => $cust_bill->invnum,
2585 'paybatchnum' => $cust_pay_batch->paybatchnum,
2586 'amount' => $cust_bill->owed,
2589 if ($unapplied >= $cust_bill_pay_batch->amount){
2590 $unapplied -= $cust_bill_pay_batch->amount;
2593 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2594 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2596 $error = $cust_bill_pay_batch->insert;
2598 $dbh->rollback if $oldAutoCommit;
2603 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2609 Returns the total owed for this customer on all invoices
2610 (see L<FS::cust_bill/owed>).
2616 $self->total_owed_date(2145859200); #12/31/2037
2619 =item total_owed_date TIME
2621 Returns the total owed for this customer on all invoices with date earlier than
2622 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2623 see L<Time::Local> and L<Date::Parse> for conversion functions.
2627 sub total_owed_date {
2631 my $custnum = $self->custnum;
2633 my $owed_sql = FS::cust_bill->owed_sql;
2636 SELECT SUM($owed_sql) FROM cust_bill
2637 WHERE custnum = $custnum
2641 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2645 =item total_owed_pkgnum PKGNUM
2647 Returns the total owed on all invoices for this customer's specific package
2648 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2652 sub total_owed_pkgnum {
2653 my( $self, $pkgnum ) = @_;
2654 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2657 =item total_owed_date_pkgnum TIME PKGNUM
2659 Returns the total owed for this customer's specific package when using
2660 experimental package balances on all invoices with date earlier than
2661 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2662 see L<Time::Local> and L<Date::Parse> for conversion functions.
2666 sub total_owed_date_pkgnum {
2667 my( $self, $time, $pkgnum ) = @_;
2670 foreach my $cust_bill (
2671 grep { $_->_date <= $time }
2672 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2674 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2676 sprintf( "%.2f", $total_bill );
2682 Returns the total amount of all payments.
2689 $total += $_->paid foreach $self->cust_pay;
2690 sprintf( "%.2f", $total );
2693 =item total_unapplied_credits
2695 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2696 customer. See L<FS::cust_credit/credited>.
2698 =item total_credited
2700 Old name for total_unapplied_credits. Don't use.
2704 sub total_credited {
2705 #carp "total_credited deprecated, use total_unapplied_credits";
2706 shift->total_unapplied_credits(@_);
2709 sub total_unapplied_credits {
2712 my $custnum = $self->custnum;
2714 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2717 SELECT SUM($unapplied_sql) FROM cust_credit
2718 WHERE custnum = $custnum
2721 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2725 =item total_unapplied_credits_pkgnum PKGNUM
2727 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2728 customer. See L<FS::cust_credit/credited>.
2732 sub total_unapplied_credits_pkgnum {
2733 my( $self, $pkgnum ) = @_;
2734 my $total_credit = 0;
2735 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2736 sprintf( "%.2f", $total_credit );
2740 =item total_unapplied_payments
2742 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2743 See L<FS::cust_pay/unapplied>.
2747 sub total_unapplied_payments {
2750 my $custnum = $self->custnum;
2752 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2755 SELECT SUM($unapplied_sql) FROM cust_pay
2756 WHERE custnum = $custnum
2759 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2763 =item total_unapplied_payments_pkgnum PKGNUM
2765 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2766 specific package when using experimental package balances. See
2767 L<FS::cust_pay/unapplied>.
2771 sub total_unapplied_payments_pkgnum {
2772 my( $self, $pkgnum ) = @_;
2773 my $total_unapplied = 0;
2774 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2775 sprintf( "%.2f", $total_unapplied );
2779 =item total_unapplied_refunds
2781 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2782 customer. See L<FS::cust_refund/unapplied>.
2786 sub total_unapplied_refunds {
2788 my $custnum = $self->custnum;
2790 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2793 SELECT SUM($unapplied_sql) FROM cust_refund
2794 WHERE custnum = $custnum
2797 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2803 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2804 total_unapplied_credits minus total_unapplied_payments).
2810 $self->balance_date_range;
2813 =item balance_date TIME
2815 Returns the balance for this customer, only considering invoices with date
2816 earlier than TIME (total_owed_date minus total_credited minus
2817 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2818 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2825 $self->balance_date_range(shift);
2828 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2830 Returns the balance for this customer, optionally considering invoices with
2831 date earlier than START_TIME, and not later than END_TIME
2832 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2834 Times are specified as SQL fragments or numeric
2835 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2836 L<Date::Parse> for conversion functions. The empty string can be passed
2837 to disable that time constraint completely.
2839 Available options are:
2843 =item unapplied_date
2845 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)
2851 sub balance_date_range {
2853 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2854 ') FROM cust_main WHERE custnum='. $self->custnum;
2855 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2858 =item balance_pkgnum PKGNUM
2860 Returns the balance for this customer's specific package when using
2861 experimental package balances (total_owed plus total_unrefunded, minus
2862 total_unapplied_credits minus total_unapplied_payments)
2866 sub balance_pkgnum {
2867 my( $self, $pkgnum ) = @_;
2870 $self->total_owed_pkgnum($pkgnum)
2871 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2872 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2873 - $self->total_unapplied_credits_pkgnum($pkgnum)
2874 - $self->total_unapplied_payments_pkgnum($pkgnum)
2878 =item in_transit_payments
2880 Returns the total of requests for payments for this customer pending in
2881 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2885 sub in_transit_payments {
2887 my $in_transit_payments = 0;
2888 foreach my $pay_batch ( qsearch('pay_batch', {
2891 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2892 'batchnum' => $pay_batch->batchnum,
2893 'custnum' => $self->custnum,
2895 $in_transit_payments += $cust_pay_batch->amount;
2898 sprintf( "%.2f", $in_transit_payments );
2903 Returns a hash of useful information for making a payment.
2913 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2914 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2915 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2919 For credit card transactions:
2931 For electronic check transactions:
2946 $return{balance} = $self->balance;
2948 $return{payname} = $self->payname
2949 || ( $self->first. ' '. $self->get('last') );
2951 $return{$_} = $self->bill_location->$_
2952 for qw(address1 address2 city state zip);
2954 $return{payby} = $self->payby;
2955 $return{stateid_state} = $self->stateid_state;
2957 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2958 $return{card_type} = cardtype($self->payinfo);
2959 $return{payinfo} = $self->paymask;
2961 @return{'month', 'year'} = $self->paydate_monthyear;
2965 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2966 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2967 $return{payinfo1} = $payinfo1;
2968 $return{payinfo2} = $payinfo2;
2969 $return{paytype} = $self->paytype;
2970 $return{paystate} = $self->paystate;
2974 #doubleclick protection
2976 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2982 =item paydate_monthyear
2984 Returns a two-element list consisting of the month and year of this customer's
2985 paydate (credit card expiration date for CARD customers)
2989 sub paydate_monthyear {
2991 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2993 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3002 Returns the exact time in seconds corresponding to the payment method
3003 expiration date. For CARD/DCRD customers this is the end of the month;
3004 for others (COMP is the only other payby that uses paydate) it's the start.
3005 Returns 0 if the paydate is empty or set to the far future.
3011 my ($month, $year) = $self->paydate_monthyear;
3012 return 0 if !$year or $year >= 2037;
3013 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3015 if ( $month == 13 ) {
3019 return timelocal(0,0,0,1,$month-1,$year) - 1;
3022 return timelocal(0,0,0,1,$month-1,$year);
3026 =item paydate_epoch_sql
3028 Class method. Returns an SQL expression to obtain the payment expiration date
3029 as a number of seconds.
3033 # Special expiration date behavior for non-CARD/DCRD customers has been
3034 # carefully preserved. Do we really use that?
3035 sub paydate_epoch_sql {
3037 my $table = shift || 'cust_main';
3038 my ($case1, $case2);
3039 if ( driver_name eq 'Pg' ) {
3040 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3041 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3043 elsif ( lc(driver_name) eq 'mysql' ) {
3044 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3045 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3048 return "CASE WHEN $table.payby IN('CARD','DCRD')
3054 =item tax_exemption TAXNAME
3059 my( $self, $taxname ) = @_;
3061 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3062 'taxname' => $taxname,
3067 =item cust_main_exemption
3071 sub cust_main_exemption {
3073 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3076 =item invoicing_list [ ARRAYREF ]
3078 If an arguement is given, sets these email addresses as invoice recipients
3079 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3080 (except as warnings), so use check_invoicing_list first.
3082 Returns a list of email addresses (with svcnum entries expanded).
3084 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3085 check it without disturbing anything by passing nothing.
3087 This interface may change in the future.
3091 sub invoicing_list {
3092 my( $self, $arrayref ) = @_;
3095 my @cust_main_invoice;
3096 if ( $self->custnum ) {
3097 @cust_main_invoice =
3098 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3100 @cust_main_invoice = ();
3102 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3103 #warn $cust_main_invoice->destnum;
3104 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3105 #warn $cust_main_invoice->destnum;
3106 my $error = $cust_main_invoice->delete;
3107 warn $error if $error;
3110 if ( $self->custnum ) {
3111 @cust_main_invoice =
3112 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3114 @cust_main_invoice = ();
3116 my %seen = map { $_->address => 1 } @cust_main_invoice;
3117 foreach my $address ( @{$arrayref} ) {
3118 next if exists $seen{$address} && $seen{$address};
3119 $seen{$address} = 1;
3120 my $cust_main_invoice = new FS::cust_main_invoice ( {
3121 'custnum' => $self->custnum,
3124 my $error = $cust_main_invoice->insert;
3125 warn $error if $error;
3129 if ( $self->custnum ) {
3131 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3138 =item check_invoicing_list ARRAYREF
3140 Checks these arguements as valid input for the invoicing_list method. If there
3141 is an error, returns the error, otherwise returns false.
3145 sub check_invoicing_list {
3146 my( $self, $arrayref ) = @_;
3148 foreach my $address ( @$arrayref ) {
3150 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3151 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3154 my $cust_main_invoice = new FS::cust_main_invoice ( {
3155 'custnum' => $self->custnum,
3158 my $error = $self->custnum
3159 ? $cust_main_invoice->check
3160 : $cust_main_invoice->checkdest
3162 return $error if $error;
3166 return "Email address required"
3167 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3168 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3173 =item set_default_invoicing_list
3175 Sets the invoicing list to all accounts associated with this customer,
3176 overwriting any previous invoicing list.
3180 sub set_default_invoicing_list {
3182 $self->invoicing_list($self->all_emails);
3187 Returns the email addresses of all accounts provisioned for this customer.
3194 foreach my $cust_pkg ( $self->all_pkgs ) {
3195 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3197 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3198 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3200 $list{$_}=1 foreach map { $_->email } @svc_acct;
3205 =item invoicing_list_addpost
3207 Adds postal invoicing to this customer. If this customer is already configured
3208 to receive postal invoices, does nothing.
3212 sub invoicing_list_addpost {
3214 return if grep { $_ eq 'POST' } $self->invoicing_list;
3215 my @invoicing_list = $self->invoicing_list;
3216 push @invoicing_list, 'POST';
3217 $self->invoicing_list(\@invoicing_list);
3220 =item invoicing_list_emailonly
3222 Returns the list of email invoice recipients (invoicing_list without non-email
3223 destinations such as POST and FAX).
3227 sub invoicing_list_emailonly {
3229 warn "$me invoicing_list_emailonly called"
3231 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3234 =item invoicing_list_emailonly_scalar
3236 Returns the list of email invoice recipients (invoicing_list without non-email
3237 destinations such as POST and FAX) as a comma-separated scalar.
3241 sub invoicing_list_emailonly_scalar {
3243 warn "$me invoicing_list_emailonly_scalar called"
3245 join(', ', $self->invoicing_list_emailonly);
3248 =item referral_custnum_cust_main
3250 Returns the customer who referred this customer (or the empty string, if
3251 this customer was not referred).
3253 Note the difference with referral_cust_main method: This method,
3254 referral_custnum_cust_main returns the single customer (if any) who referred
3255 this customer, while referral_cust_main returns an array of customers referred
3260 sub referral_custnum_cust_main {
3262 return '' unless $self->referral_custnum;
3263 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3266 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3268 Returns an array of customers referred by this customer (referral_custnum set
3269 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3270 customers referred by customers referred by this customer and so on, inclusive.
3271 The default behavior is DEPTH 1 (no recursion).
3273 Note the difference with referral_custnum_cust_main method: This method,
3274 referral_cust_main, returns an array of customers referred BY this customer,
3275 while referral_custnum_cust_main returns the single customer (if any) who
3276 referred this customer.
3280 sub referral_cust_main {
3282 my $depth = @_ ? shift : 1;
3283 my $exclude = @_ ? shift : {};
3286 map { $exclude->{$_->custnum}++; $_; }
3287 grep { ! $exclude->{ $_->custnum } }
3288 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3292 map { $_->referral_cust_main($depth-1, $exclude) }
3299 =item referral_cust_main_ncancelled
3301 Same as referral_cust_main, except only returns customers with uncancelled
3306 sub referral_cust_main_ncancelled {
3308 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3311 =item referral_cust_pkg [ DEPTH ]
3313 Like referral_cust_main, except returns a flat list of all unsuspended (and
3314 uncancelled) packages for each customer. The number of items in this list may
3315 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3319 sub referral_cust_pkg {
3321 my $depth = @_ ? shift : 1;
3323 map { $_->unsuspended_pkgs }
3324 grep { $_->unsuspended_pkgs }
3325 $self->referral_cust_main($depth);
3328 =item referring_cust_main
3330 Returns the single cust_main record for the customer who referred this customer
3331 (referral_custnum), or false.
3335 sub referring_cust_main {
3337 return '' unless $self->referral_custnum;
3338 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3341 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3343 Applies a credit to this customer. If there is an error, returns the error,
3344 otherwise returns false.
3346 REASON can be a text string, an FS::reason object, or a scalar reference to
3347 a reasonnum. If a text string, it will be automatically inserted as a new
3348 reason, and a 'reason_type' option must be passed to indicate the
3349 FS::reason_type for the new reason.
3351 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3353 Any other options are passed to FS::cust_credit::insert.
3358 my( $self, $amount, $reason, %options ) = @_;
3360 my $cust_credit = new FS::cust_credit {
3361 'custnum' => $self->custnum,
3362 'amount' => $amount,
3365 if ( ref($reason) ) {
3367 if ( ref($reason) eq 'SCALAR' ) {
3368 $cust_credit->reasonnum( $$reason );
3370 $cust_credit->reasonnum( $reason->reasonnum );
3374 $cust_credit->set('reason', $reason)
3377 for (qw( addlinfo eventnum )) {
3378 $cust_credit->$_( delete $options{$_} )
3379 if exists($options{$_});
3382 $cust_credit->insert(%options);
3386 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3388 Creates a one-time charge for this customer. If there is an error, returns
3389 the error, otherwise returns false.
3391 New-style, with a hashref of options:
3393 my $error = $cust_main->charge(
3397 'start_date' => str2time('7/4/2009'),
3398 'pkg' => 'Description',
3399 'comment' => 'Comment',
3400 'additional' => [], #extra invoice detail
3401 'classnum' => 1, #pkg_class
3403 'setuptax' => '', # or 'Y' for tax exempt
3405 'locationnum'=> 1234, # optional
3408 'taxclass' => 'Tax class',
3411 'taxproduct' => 2, #part_pkg_taxproduct
3412 'override' => {}, #XXX describe
3414 #will be filled in with the new object
3415 'cust_pkg_ref' => \$cust_pkg,
3417 #generate an invoice immediately
3419 'invoice_terms' => '', #with these terms
3425 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3431 my ( $amount, $quantity, $start_date, $classnum );
3432 my ( $pkg, $comment, $additional );
3433 my ( $setuptax, $taxclass ); #internal taxes
3434 my ( $taxproduct, $override ); #vendor (CCH) taxes
3436 my $cust_pkg_ref = '';
3437 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3439 if ( ref( $_[0] ) ) {
3440 $amount = $_[0]->{amount};
3441 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3442 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3443 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3444 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3445 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3446 : '$'. sprintf("%.2f",$amount);
3447 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3448 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3449 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3450 $additional = $_[0]->{additional} || [];
3451 $taxproduct = $_[0]->{taxproductnum};
3452 $override = { '' => $_[0]->{tax_override} };
3453 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3454 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3455 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3456 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3461 $pkg = @_ ? shift : 'One-time charge';
3462 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3464 $taxclass = @_ ? shift : '';
3468 local $SIG{HUP} = 'IGNORE';
3469 local $SIG{INT} = 'IGNORE';
3470 local $SIG{QUIT} = 'IGNORE';
3471 local $SIG{TERM} = 'IGNORE';
3472 local $SIG{TSTP} = 'IGNORE';
3473 local $SIG{PIPE} = 'IGNORE';
3475 my $oldAutoCommit = $FS::UID::AutoCommit;
3476 local $FS::UID::AutoCommit = 0;
3479 my $part_pkg = new FS::part_pkg ( {
3481 'comment' => $comment,
3485 'classnum' => ( $classnum ? $classnum : '' ),
3486 'setuptax' => $setuptax,
3487 'taxclass' => $taxclass,
3488 'taxproductnum' => $taxproduct,
3491 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3492 ( 0 .. @$additional - 1 )
3494 'additional_count' => scalar(@$additional),
3495 'setup_fee' => $amount,
3498 my $error = $part_pkg->insert( options => \%options,
3499 tax_overrides => $override,
3502 $dbh->rollback if $oldAutoCommit;
3506 my $pkgpart = $part_pkg->pkgpart;
3507 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3508 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3509 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3510 $error = $type_pkgs->insert;
3512 $dbh->rollback if $oldAutoCommit;
3517 my $cust_pkg = new FS::cust_pkg ( {
3518 'custnum' => $self->custnum,
3519 'pkgpart' => $pkgpart,
3520 'quantity' => $quantity,
3521 'start_date' => $start_date,
3522 'no_auto' => $no_auto,
3523 'locationnum'=> $locationnum,
3526 $error = $cust_pkg->insert;
3528 $dbh->rollback if $oldAutoCommit;
3530 } elsif ( $cust_pkg_ref ) {
3531 ${$cust_pkg_ref} = $cust_pkg;
3535 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3536 'pkg_list' => [ $cust_pkg ],
3539 $dbh->rollback if $oldAutoCommit;
3544 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3549 #=item charge_postal_fee
3551 #Applies a one time charge this customer. If there is an error,
3552 #returns the error, returns the cust_pkg charge object or false
3553 #if there was no charge.
3557 # This should be a customer event. For that to work requires that bill
3558 # also be a customer event.
3560 sub charge_postal_fee {
3563 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3564 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3566 my $cust_pkg = new FS::cust_pkg ( {
3567 'custnum' => $self->custnum,
3568 'pkgpart' => $pkgpart,
3572 my $error = $cust_pkg->insert;
3573 $error ? $error : $cust_pkg;
3576 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3578 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3580 Optionally, a list or hashref of additional arguments to the qsearch call can
3587 my $opt = ref($_[0]) ? shift : { @_ };
3589 #return $self->num_cust_bill unless wantarray || keys %$opt;
3591 $opt->{'table'} = 'cust_bill';
3592 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3593 $opt->{'hashref'}{'custnum'} = $self->custnum;
3594 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3596 map { $_ } #behavior of sort undefined in scalar context
3597 sort { $a->_date <=> $b->_date }
3601 =item open_cust_bill
3603 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3608 sub open_cust_bill {
3612 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3618 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3620 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3624 sub legacy_cust_bill {
3627 #return $self->num_legacy_cust_bill unless wantarray;
3629 map { $_ } #behavior of sort undefined in scalar context
3630 sort { $a->_date <=> $b->_date }
3631 qsearch({ 'table' => 'legacy_cust_bill',
3632 'hashref' => { 'custnum' => $self->custnum, },
3633 'order_by' => 'ORDER BY _date ASC',
3637 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3639 Returns all the statements (see L<FS::cust_statement>) for this customer.
3641 Optionally, a list or hashref of additional arguments to the qsearch call can
3646 =item cust_bill_void
3648 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3652 sub cust_bill_void {
3655 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3656 sort { $a->_date <=> $b->_date }
3657 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3660 sub cust_statement {
3662 my $opt = ref($_[0]) ? shift : { @_ };
3664 #return $self->num_cust_statement unless wantarray || keys %$opt;
3666 $opt->{'table'} = 'cust_statement';
3667 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3668 $opt->{'hashref'}{'custnum'} = $self->custnum;
3669 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3671 map { $_ } #behavior of sort undefined in scalar context
3672 sort { $a->_date <=> $b->_date }
3676 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3678 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3680 Optionally, a list or hashref of additional arguments to the qsearch call can
3681 be passed following the SVCDB.
3688 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3689 warn "$me svc_x requires a svcdb";
3692 my $opt = ref($_[0]) ? shift : { @_ };
3694 $opt->{'table'} = $svcdb;
3695 $opt->{'addl_from'} =
3696 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3697 ($opt->{'addl_from'} || '');
3699 my $custnum = $self->custnum;
3700 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3701 my $where = "cust_pkg.custnum = $custnum";
3703 my $extra_sql = $opt->{'extra_sql'} || '';
3704 if ( keys %{ $opt->{'hashref'} } ) {
3705 $extra_sql = " AND $where $extra_sql";
3708 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3709 $extra_sql = "WHERE $where AND $1";
3712 $extra_sql = "WHERE $where $extra_sql";
3715 $opt->{'extra_sql'} = $extra_sql;
3720 # required for use as an eventtable;
3723 $self->svc_x('svc_acct', @_);
3728 Returns all the credits (see L<FS::cust_credit>) for this customer.
3734 map { $_ } #return $self->num_cust_credit unless wantarray;
3735 sort { $a->_date <=> $b->_date }
3736 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3739 =item cust_credit_pkgnum
3741 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3742 package when using experimental package balances.
3746 sub cust_credit_pkgnum {
3747 my( $self, $pkgnum ) = @_;
3748 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3749 sort { $a->_date <=> $b->_date }
3750 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3751 'pkgnum' => $pkgnum,
3758 Returns all the payments (see L<FS::cust_pay>) for this customer.
3764 return $self->num_cust_pay unless wantarray;
3765 sort { $a->_date <=> $b->_date }
3766 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3771 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3772 called automatically when the cust_pay method is used in a scalar context.
3778 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3779 my $sth = dbh->prepare($sql) or die dbh->errstr;
3780 $sth->execute($self->custnum) or die $sth->errstr;
3781 $sth->fetchrow_arrayref->[0];
3784 =item cust_pay_pkgnum
3786 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3787 package when using experimental package balances.
3791 sub cust_pay_pkgnum {
3792 my( $self, $pkgnum ) = @_;
3793 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3794 sort { $a->_date <=> $b->_date }
3795 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3796 'pkgnum' => $pkgnum,
3803 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3809 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3810 sort { $a->_date <=> $b->_date }
3811 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3814 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3816 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3818 Optionally, a list or hashref of additional arguments to the qsearch call can
3823 sub cust_pay_batch {
3825 my $opt = ref($_[0]) ? shift : { @_ };
3827 #return $self->num_cust_statement unless wantarray || keys %$opt;
3829 $opt->{'table'} = 'cust_pay_batch';
3830 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3831 $opt->{'hashref'}{'custnum'} = $self->custnum;
3832 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3834 map { $_ } #behavior of sort undefined in scalar context
3835 sort { $a->paybatchnum <=> $b->paybatchnum }
3839 =item cust_pay_pending
3841 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3842 (without status "done").
3846 sub cust_pay_pending {
3848 return $self->num_cust_pay_pending unless wantarray;
3849 sort { $a->_date <=> $b->_date }
3850 qsearch( 'cust_pay_pending', {
3851 'custnum' => $self->custnum,
3852 'status' => { op=>'!=', value=>'done' },
3857 =item cust_pay_pending_attempt
3859 Returns all payment attempts / declined payments for this customer, as pending
3860 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3861 a corresponding payment (see L<FS::cust_pay>).
3865 sub cust_pay_pending_attempt {
3867 return $self->num_cust_pay_pending_attempt unless wantarray;
3868 sort { $a->_date <=> $b->_date }
3869 qsearch( 'cust_pay_pending', {
3870 'custnum' => $self->custnum,
3877 =item num_cust_pay_pending
3879 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3880 customer (without status "done"). Also called automatically when the
3881 cust_pay_pending method is used in a scalar context.
3885 sub num_cust_pay_pending {
3888 " SELECT COUNT(*) FROM cust_pay_pending ".
3889 " WHERE custnum = ? AND status != 'done' ",
3894 =item num_cust_pay_pending_attempt
3896 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3897 customer, with status "done" but without a corresp. Also called automatically when the
3898 cust_pay_pending method is used in a scalar context.
3902 sub num_cust_pay_pending_attempt {
3905 " SELECT COUNT(*) FROM cust_pay_pending ".
3906 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3913 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3919 map { $_ } #return $self->num_cust_refund unless wantarray;
3920 sort { $a->_date <=> $b->_date }
3921 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3924 =item display_custnum
3926 Returns the displayed customer number for this customer: agent_custid if
3927 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3931 sub display_custnum {
3934 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3935 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3936 if ( $special eq 'CoStAg' ) {
3937 $prefix = uc( join('',
3939 ($self->state =~ /^(..)/),
3940 $prefix || ($self->agent->agent =~ /^(..)/)
3943 elsif ( $special eq 'CoStCl' ) {
3944 $prefix = uc( join('',
3946 ($self->state =~ /^(..)/),
3947 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3950 # add any others here if needed
3953 my $length = $conf->config('cust_main-custnum-display_length');
3954 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3955 return $self->agent_custid;
3956 } elsif ( $prefix ) {
3957 $length = 8 if !defined($length);
3959 sprintf('%0'.$length.'d', $self->custnum)
3960 } elsif ( $length ) {
3961 return sprintf('%0'.$length.'d', $self->custnum);
3963 return $self->custnum;
3969 Returns a name string for this customer, either "Company (Last, First)" or
3976 my $name = $self->contact;
3977 $name = $self->company. " ($name)" if $self->company;
3981 =item service_contact
3983 Returns the L<FS::contact> object for this customer that has the 'Service'
3984 contact class, or undef if there is no such contact. Deprecated; don't use
3989 sub service_contact {
3991 if ( !exists($self->{service_contact}) ) {
3992 my $classnum = $self->scalar_sql(
3993 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3994 ) || 0; #if it's zero, qsearchs will return nothing
3995 $self->{service_contact} = qsearchs('contact', {
3996 'classnum' => $classnum, 'custnum' => $self->custnum
3999 $self->{service_contact};
4004 Returns a name string for this (service/shipping) contact, either
4005 "Company (Last, First)" or "Last, First".
4012 my $name = $self->ship_contact;
4013 $name = $self->company. " ($name)" if $self->company;
4019 Returns a name string for this customer, either "Company" or "First Last".
4025 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4028 =item ship_name_short
4030 Returns a name string for this (service/shipping) contact, either "Company"
4035 sub ship_name_short {
4037 $self->service_contact
4038 ? $self->ship_contact_firstlast
4044 Returns this customer's full (billing) contact name only, "Last, First"
4050 $self->get('last'). ', '. $self->first;
4055 Returns this customer's full (shipping) contact name only, "Last, First"
4061 my $contact = $self->service_contact || $self;
4062 $contact->get('last') . ', ' . $contact->get('first');
4065 =item contact_firstlast
4067 Returns this customers full (billing) contact name only, "First Last".
4071 sub contact_firstlast {
4073 $self->first. ' '. $self->get('last');
4076 =item ship_contact_firstlast
4078 Returns this customer's full (shipping) contact name only, "First Last".
4082 sub ship_contact_firstlast {
4084 my $contact = $self->service_contact || $self;
4085 $contact->get('first') . ' '. $contact->get('last');
4088 #XXX this doesn't work in 3.x+
4091 #Returns this customer's full country name
4097 # code2country($self->country);
4100 =item county_state_county [ PREFIX ]
4102 Returns a string consisting of just the county, state and country.
4106 sub county_state_country {
4109 if ( @_ && $_[0] && $self->has_ship_address ) {
4110 $locationnum = $self->ship_locationnum;
4112 $locationnum = $self->bill_locationnum;
4114 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4115 $cust_location->county_state_country;
4118 =item geocode DATA_VENDOR
4120 Returns a value for the customer location as encoded by DATA_VENDOR.
4121 Currently this only makes sense for "CCH" as DATA_VENDOR.
4129 Returns a status string for this customer, currently:
4133 =item prospect - No packages have ever been ordered
4135 =item ordered - Recurring packages all are new (not yet billed).
4137 =item active - One or more recurring packages is active
4139 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4141 =item suspended - All non-cancelled recurring packages are suspended
4143 =item cancelled - All recurring packages are cancelled
4147 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4148 cust_main-status_module configuration option.
4152 sub status { shift->cust_status(@_); }
4156 for my $status ( FS::cust_main->statuses() ) {
4157 my $method = $status.'_sql';
4158 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4159 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4160 $sth->execute( ($self->custnum) x $numnum )
4161 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4162 return $status if $sth->fetchrow_arrayref->[0];
4166 =item ucfirst_cust_status
4168 =item ucfirst_status
4170 Returns the status with the first character capitalized.
4174 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4176 sub ucfirst_cust_status {
4178 ucfirst($self->cust_status);
4183 Returns a hex triplet color string for this customer's status.
4187 sub statuscolor { shift->cust_statuscolor(@_); }
4189 sub cust_statuscolor {
4191 __PACKAGE__->statuscolors->{$self->cust_status};
4196 Returns an array of hashes representing the customer's RT tickets.
4203 my $num = $conf->config('cust_main-max_tickets') || 10;
4206 if ( $conf->config('ticket_system') ) {
4207 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4209 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4213 foreach my $priority (
4214 $conf->config('ticket_system-custom_priority_field-values'), ''
4216 last if scalar(@tickets) >= $num;
4218 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4219 $num - scalar(@tickets),
4229 # Return services representing svc_accts in customer support packages
4230 sub support_services {
4232 my %packages = map { $_ => 1 } $conf->config('support_packages');
4234 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4235 grep { $_->part_svc->svcdb eq 'svc_acct' }
4236 map { $_->cust_svc }
4237 grep { exists $packages{ $_->pkgpart } }
4238 $self->ncancelled_pkgs;
4242 # Return a list of latitude/longitude for one of the services (if any)
4243 sub service_coordinates {
4247 grep { $_->latitude && $_->longitude }
4249 map { $_->cust_svc }
4250 $self->ncancelled_pkgs;
4252 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4257 Returns a masked version of the named field
4262 my ($self,$field) = @_;
4266 'x'x(length($self->getfield($field))-4).
4267 substr($self->getfield($field), (length($self->getfield($field))-4));
4273 =head1 CLASS METHODS
4279 Class method that returns the list of possible status strings for customers
4280 (see L<the status method|/status>). For example:
4282 @statuses = FS::cust_main->statuses();
4288 keys %{ $self->statuscolors };
4291 =item cust_status_sql
4293 Returns an SQL fragment to determine the status of a cust_main record, as a
4298 sub cust_status_sql {
4300 for my $status ( FS::cust_main->statuses() ) {
4301 my $method = $status.'_sql';
4302 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4311 Returns an SQL expression identifying prospective cust_main records (customers
4312 with no packages ever ordered)
4316 use vars qw($select_count_pkgs);
4317 $select_count_pkgs =
4318 "SELECT COUNT(*) FROM cust_pkg
4319 WHERE cust_pkg.custnum = cust_main.custnum";
4321 sub select_count_pkgs_sql {
4326 " 0 = ( $select_count_pkgs ) ";
4331 Returns an SQL expression identifying ordered cust_main records (customers with
4332 no active packages, but recurring packages not yet setup or one time charges
4338 FS::cust_main->none_active_sql.
4339 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4344 Returns an SQL expression identifying active cust_main records (customers with
4345 active recurring packages).
4350 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4353 =item none_active_sql
4355 Returns an SQL expression identifying cust_main records with no active
4356 recurring packages. This includes customers of status prospect, ordered,
4357 inactive, and suspended.
4361 sub none_active_sql {
4362 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4367 Returns an SQL expression identifying inactive cust_main records (customers with
4368 no active recurring packages, but otherwise unsuspended/uncancelled).
4373 FS::cust_main->none_active_sql.
4374 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4380 Returns an SQL expression identifying suspended cust_main records.
4385 sub suspended_sql { susp_sql(@_); }
4387 FS::cust_main->none_active_sql.
4388 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4394 Returns an SQL expression identifying cancelled cust_main records.
4398 sub cancel_sql { shift->cancelled_sql(@_); }
4401 =item uncancelled_sql
4403 Returns an SQL expression identifying un-cancelled cust_main records.
4407 sub uncancelled_sql { uncancel_sql(@_); }
4408 sub uncancel_sql { "
4409 ( 0 < ( $select_count_pkgs
4410 AND ( cust_pkg.cancel IS NULL
4411 OR cust_pkg.cancel = 0
4414 OR 0 = ( $select_count_pkgs )
4420 Returns an SQL fragment to retreive the balance.
4425 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4426 WHERE cust_bill.custnum = cust_main.custnum )
4427 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4428 WHERE cust_pay.custnum = cust_main.custnum )
4429 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4430 WHERE cust_credit.custnum = cust_main.custnum )
4431 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4432 WHERE cust_refund.custnum = cust_main.custnum )
4435 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4437 Returns an SQL fragment to retreive the balance for this customer, optionally
4438 considering invoices with date earlier than START_TIME, and not
4439 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4440 total_unapplied_payments).
4442 Times are specified as SQL fragments or numeric
4443 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4444 L<Date::Parse> for conversion functions. The empty string can be passed
4445 to disable that time constraint completely.
4447 Available options are:
4451 =item unapplied_date
4453 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)
4458 set to true to remove all customer comparison clauses, for totals
4463 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4468 JOIN clause (typically used with the total option)
4472 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4473 time will be ignored. Note that START_TIME and END_TIME only limit the date
4474 range for invoices and I<unapplied> payments, credits, and refunds.
4480 sub balance_date_sql {
4481 my( $class, $start, $end, %opt ) = @_;
4483 my $cutoff = $opt{'cutoff'};
4485 my $owed = FS::cust_bill->owed_sql($cutoff);
4486 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4487 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4488 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4490 my $j = $opt{'join'} || '';
4492 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4493 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4494 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4495 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4497 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4498 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4499 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4500 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4505 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4507 Returns an SQL fragment to retreive the total unapplied payments for this
4508 customer, only considering payments with date earlier than START_TIME, and
4509 optionally not later than END_TIME.
4511 Times are specified as SQL fragments or numeric
4512 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4513 L<Date::Parse> for conversion functions. The empty string can be passed
4514 to disable that time constraint completely.
4516 Available options are:
4520 sub unapplied_payments_date_sql {
4521 my( $class, $start, $end, %opt ) = @_;
4523 my $cutoff = $opt{'cutoff'};
4525 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4527 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4528 'unapplied_date'=>1 );
4530 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4533 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4535 Helper method for balance_date_sql; name (and usage) subject to change
4536 (suggestions welcome).
4538 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4539 cust_refund, cust_credit or cust_pay).
4541 If TABLE is "cust_bill" or the unapplied_date option is true, only
4542 considers records with date earlier than START_TIME, and optionally not
4543 later than END_TIME .
4547 sub _money_table_where {
4548 my( $class, $table, $start, $end, %opt ) = @_;
4551 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4552 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4553 push @where, "$table._date <= $start" if defined($start) && length($start);
4554 push @where, "$table._date > $end" if defined($end) && length($end);
4556 push @where, @{$opt{'where'}} if $opt{'where'};
4557 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4563 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4564 use FS::cust_main::Search;
4567 FS::cust_main::Search->search(@_);
4582 #warn join('-',keys %$param);
4583 my $fh = $param->{filehandle};
4584 my $agentnum = $param->{agentnum};
4585 my $format = $param->{format};
4587 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4590 if ( $format eq 'simple' ) {
4591 @fields = qw( custnum agent_custid amount pkg );
4593 die "unknown format $format";
4596 eval "use Text::CSV_XS;";
4599 my $csv = new Text::CSV_XS;
4606 local $SIG{HUP} = 'IGNORE';
4607 local $SIG{INT} = 'IGNORE';
4608 local $SIG{QUIT} = 'IGNORE';
4609 local $SIG{TERM} = 'IGNORE';
4610 local $SIG{TSTP} = 'IGNORE';
4611 local $SIG{PIPE} = 'IGNORE';
4613 my $oldAutoCommit = $FS::UID::AutoCommit;
4614 local $FS::UID::AutoCommit = 0;
4617 #while ( $columns = $csv->getline($fh) ) {
4619 while ( defined($line=<$fh>) ) {
4621 $csv->parse($line) or do {
4622 $dbh->rollback if $oldAutoCommit;
4623 return "can't parse: ". $csv->error_input();
4626 my @columns = $csv->fields();
4627 #warn join('-',@columns);
4630 foreach my $field ( @fields ) {
4631 $row{$field} = shift @columns;
4634 if ( $row{custnum} && $row{agent_custid} ) {
4635 dbh->rollback if $oldAutoCommit;
4636 return "can't specify custnum with agent_custid $row{agent_custid}";
4640 if ( $row{agent_custid} && $agentnum ) {
4641 %hash = ( 'agent_custid' => $row{agent_custid},
4642 'agentnum' => $agentnum,
4646 if ( $row{custnum} ) {
4647 %hash = ( 'custnum' => $row{custnum} );
4650 unless ( scalar(keys %hash) ) {
4651 $dbh->rollback if $oldAutoCommit;
4652 return "can't find customer without custnum or agent_custid and agentnum";
4655 my $cust_main = qsearchs('cust_main', { %hash } );
4656 unless ( $cust_main ) {
4657 $dbh->rollback if $oldAutoCommit;
4658 my $custnum = $row{custnum} || $row{agent_custid};
4659 return "unknown custnum $custnum";
4662 if ( $row{'amount'} > 0 ) {
4663 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4665 $dbh->rollback if $oldAutoCommit;
4669 } elsif ( $row{'amount'} < 0 ) {
4670 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4673 $dbh->rollback if $oldAutoCommit;
4683 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4685 return "Empty file!" unless $imported;
4691 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4693 Deprecated. Use event notification and message templates
4694 (L<FS::msg_template>) instead.
4696 Sends a templated email notification to the customer (see L<Text::Template>).
4698 OPTIONS is a hash and may include
4700 I<from> - the email sender (default is invoice_from)
4702 I<to> - comma-separated scalar or arrayref of recipients
4703 (default is invoicing_list)
4705 I<subject> - The subject line of the sent email notification
4706 (default is "Notice from company_name")
4708 I<extra_fields> - a hashref of name/value pairs which will be substituted
4711 The following variables are vavailable in the template.
4713 I<$first> - the customer first name
4714 I<$last> - the customer last name
4715 I<$company> - the customer company
4716 I<$payby> - a description of the method of payment for the customer
4717 # would be nice to use FS::payby::shortname
4718 I<$payinfo> - the account information used to collect for this customer
4719 I<$expdate> - the expiration of the customer payment in seconds from epoch
4724 my ($self, $template, %options) = @_;
4726 return unless $conf->exists($template);
4728 my $from = $conf->config('invoice_from', $self->agentnum)
4729 if $conf->exists('invoice_from', $self->agentnum);
4730 $from = $options{from} if exists($options{from});
4732 my $to = join(',', $self->invoicing_list_emailonly);
4733 $to = $options{to} if exists($options{to});
4735 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4736 if $conf->exists('company_name', $self->agentnum);
4737 $subject = $options{subject} if exists($options{subject});
4739 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4740 SOURCE => [ map "$_\n",
4741 $conf->config($template)]
4743 or die "can't create new Text::Template object: Text::Template::ERROR";
4744 $notify_template->compile()
4745 or die "can't compile template: Text::Template::ERROR";
4747 $FS::notify_template::_template::company_name =
4748 $conf->config('company_name', $self->agentnum);
4749 $FS::notify_template::_template::company_address =
4750 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4752 my $paydate = $self->paydate || '2037-12-31';
4753 $FS::notify_template::_template::first = $self->first;
4754 $FS::notify_template::_template::last = $self->last;
4755 $FS::notify_template::_template::company = $self->company;
4756 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4757 my $payby = $self->payby;
4758 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4759 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4761 #credit cards expire at the end of the month/year of their exp date
4762 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4763 $FS::notify_template::_template::payby = 'credit card';
4764 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4765 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4767 }elsif ($payby eq 'COMP') {
4768 $FS::notify_template::_template::payby = 'complimentary account';
4770 $FS::notify_template::_template::payby = 'current method';
4772 $FS::notify_template::_template::expdate = $expire_time;
4774 for (keys %{$options{extra_fields}}){
4776 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4779 send_email(from => $from,
4781 subject => $subject,
4782 body => $notify_template->fill_in( PACKAGE =>
4783 'FS::notify_template::_template' ),
4788 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4790 Generates a templated notification to the customer (see L<Text::Template>).
4792 OPTIONS is a hash and may include
4794 I<extra_fields> - a hashref of name/value pairs which will be substituted
4795 into the template. These values may override values mentioned below
4796 and those from the customer record.
4798 The following variables are available in the template instead of or in addition
4799 to the fields of the customer record.
4801 I<$payby> - a description of the method of payment for the customer
4802 # would be nice to use FS::payby::shortname
4803 I<$payinfo> - the masked account information used to collect for this customer
4804 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4805 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4809 # a lot like cust_bill::print_latex
4810 sub generate_letter {
4811 my ($self, $template, %options) = @_;
4813 return unless $conf->exists($template);
4815 my $letter_template = new Text::Template
4817 SOURCE => [ map "$_\n", $conf->config($template)],
4818 DELIMITERS => [ '[@--', '--@]' ],
4820 or die "can't create new Text::Template object: Text::Template::ERROR";
4822 $letter_template->compile()
4823 or die "can't compile template: Text::Template::ERROR";
4825 my %letter_data = map { $_ => $self->$_ } $self->fields;
4826 $letter_data{payinfo} = $self->mask_payinfo;
4828 #my $paydate = $self->paydate || '2037-12-31';
4829 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4831 my $payby = $self->payby;
4832 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4833 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4835 #credit cards expire at the end of the month/year of their exp date
4836 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4837 $letter_data{payby} = 'credit card';
4838 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4839 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4841 }elsif ($payby eq 'COMP') {
4842 $letter_data{payby} = 'complimentary account';
4844 $letter_data{payby} = 'current method';
4846 $letter_data{expdate} = $expire_time;
4848 for (keys %{$options{extra_fields}}){
4849 $letter_data{$_} = $options{extra_fields}->{$_};
4852 unless(exists($letter_data{returnaddress})){
4853 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4854 $self->agent_template)
4856 if ( length($retadd) ) {
4857 $letter_data{returnaddress} = $retadd;
4858 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4859 $letter_data{returnaddress} =
4860 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4864 ( $conf->config('company_name', $self->agentnum),
4865 $conf->config('company_address', $self->agentnum),
4869 $letter_data{returnaddress} = '~';
4873 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4875 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4877 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4879 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4883 ) or die "can't open temp file: $!\n";
4884 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4885 or die "can't write temp file: $!\n";
4887 $letter_data{'logo_file'} = $lh->filename;
4889 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4893 ) or die "can't open temp file: $!\n";
4895 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4897 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4898 return ($1, $letter_data{'logo_file'});
4902 =item print_ps TEMPLATE
4904 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4910 my($file, $lfile) = $self->generate_letter(@_);
4911 my $ps = FS::Misc::generate_ps($file);
4912 unlink($file.'.tex');
4918 =item print TEMPLATE
4920 Prints the filled in template.
4922 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4926 sub queueable_print {
4929 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4930 or die "invalid customer number: " . $opt{custvnum};
4932 my $error = $self->print( $opt{template} );
4933 die $error if $error;
4937 my ($self, $template) = (shift, shift);
4939 [ $self->print_ps($template) ],
4940 'agentnum' => $self->agentnum,
4944 #these three subs should just go away once agent stuff is all config overrides
4946 sub agent_template {
4948 $self->_agent_plandata('agent_templatename');
4951 sub agent_invoice_from {
4953 $self->_agent_plandata('agent_invoice_from');
4956 sub _agent_plandata {
4957 my( $self, $option ) = @_;
4959 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4960 #agent-specific Conf
4962 use FS::part_event::Condition;
4964 my $agentnum = $self->agentnum;
4966 my $regexp = regexp_sql();
4968 my $part_event_option =
4970 'select' => 'part_event_option.*',
4971 'table' => 'part_event_option',
4973 LEFT JOIN part_event USING ( eventpart )
4974 LEFT JOIN part_event_option AS peo_agentnum
4975 ON ( part_event.eventpart = peo_agentnum.eventpart
4976 AND peo_agentnum.optionname = 'agentnum'
4977 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4979 LEFT JOIN part_event_condition
4980 ON ( part_event.eventpart = part_event_condition.eventpart
4981 AND part_event_condition.conditionname = 'cust_bill_age'
4983 LEFT JOIN part_event_condition_option
4984 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4985 AND part_event_condition_option.optionname = 'age'
4988 #'hashref' => { 'optionname' => $option },
4989 #'hashref' => { 'part_event_option.optionname' => $option },
4991 " WHERE part_event_option.optionname = ". dbh->quote($option).
4992 " AND action = 'cust_bill_send_agent' ".
4993 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4994 " AND peo_agentnum.optionname = 'agentnum' ".
4995 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4997 CASE WHEN part_event_condition_option.optionname IS NULL
4999 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5001 , part_event.weight".
5005 unless ( $part_event_option ) {
5006 return $self->agent->invoice_template || ''
5007 if $option eq 'agent_templatename';
5011 $part_event_option->optionvalue;
5015 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5017 Subroutine (not a method), designed to be called from the queue.
5019 Takes a list of options and values.
5021 Pulls up the customer record via the custnum option and calls bill_and_collect.
5026 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5028 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5029 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5031 $cust_main->bill_and_collect( %args );
5034 sub process_bill_and_collect {
5036 my $param = thaw(decode_base64(shift));
5037 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5038 or die "custnum '$param->{custnum}' not found!\n";
5039 $param->{'job'} = $job;
5040 $param->{'fatal'} = 1; # runs from job queue, will be caught
5041 $param->{'retry'} = 1;
5043 $cust_main->bill_and_collect( %$param );
5046 =item process_censustract_update CUSTNUM
5048 Queueable function to update the census tract to the current year (as set in
5049 the 'census_year' configuration variable) and retrieve the new tract code.
5053 sub process_censustract_update {
5054 eval "use FS::Misc::Geo qw(get_censustract)";
5056 my $custnum = shift;
5057 my $cust_main = qsearchs( 'cust_main', { custnum => $custnum })
5058 or die "custnum '$custnum' not found!\n";
5060 my $new_year = $conf->config('census_year') or return;
5061 my $new_tract = get_censustract({ $cust_main->location_hash }, $new_year);
5062 if ( $new_tract =~ /^\d/ ) {
5063 # then it's a tract code
5064 $cust_main->set('censustract', $new_tract);
5065 $cust_main->set('censusyear', $new_year);
5067 local($ignore_expired_card) = 1;
5068 local($ignore_illegal_zip) = 1;
5069 local($ignore_banned_card) = 1;
5070 local($skip_fuzzyfiles) = 1;
5071 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5072 my $error = $cust_main->replace;
5073 die $error if $error;
5076 # it's an error message
5082 #starting to take quite a while for big dbs
5083 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5084 # - seq scan of cust_main on signupdate... index signupdate? will that help?
5085 # - seq scan of cust_main on paydate... index on substrings? maybe set an
5086 # upgrade journal flag now that we have that, yyyy-m-dd paydates are ancient
5087 # - seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5088 # upgrade journal again? this is also an ancient problem
5089 # - otaker upgrade? journal and call it good? (double check to make sure
5090 # we're not still setting otaker here)
5092 #only going to get worse with new location stuff...
5094 sub _upgrade_data { #class method
5095 my ($class, %opts) = @_;
5098 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5101 #this seems to be the only expensive one.. why does it take so long?
5102 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5104 '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';
5105 FS::upgrade_journal->set_done('cust_main__signupdate');
5108 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5110 # fix yyyy-m-dd formatted paydates
5111 if ( driver_name =~ /^mysql/i ) {
5113 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5114 } else { # the SQL standard
5116 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5118 FS::upgrade_journal->set_done('cust_main__paydate');
5121 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5123 push @statements, #fix the weird BILL with a cc# in payinfo problem
5125 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5127 FS::upgrade_journal->set_done('cust_main__payinfo');
5132 foreach my $sql ( @statements ) {
5133 my $sth = dbh->prepare($sql) or die dbh->errstr;
5134 $sth->execute or die $sth->errstr;
5135 #warn ( (time - $t). " seconds\n" );
5139 local($ignore_expired_card) = 1;
5140 local($ignore_banned_card) = 1;
5141 local($skip_fuzzyfiles) = 1;
5142 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5143 $class->_upgrade_otaker(%opts);
5145 FS::cust_main::Location->_upgrade_data(%opts);
5155 The delete method should possibly take an FS::cust_main object reference
5156 instead of a scalar customer number.
5158 Bill and collect options should probably be passed as references instead of a
5161 There should probably be a configuration file with a list of allowed credit
5164 No multiple currency support (probably a larger project than just this module).
5166 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5168 Birthdates rely on negative epoch values.
5170 The payby for card/check batches is broken. With mixed batching, bad
5173 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5177 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5178 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5179 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.