2 use base qw( FS::cust_main::Packages
4 FS::cust_main::NationalID
6 FS::cust_main::Billing_Realtime
7 FS::cust_main::Billing_Batch
8 FS::cust_main::Billing_Discount
9 FS::cust_main::Billing_ThirdParty
10 FS::cust_main::Location
11 FS::cust_main::Credit_Limit
14 FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
15 FS::geocode_Mixin FS::Quotable_Mixin FS::Sales_Mixin
24 use Scalar::Util qw( blessed );
25 use List::Util qw(min);
27 use File::Temp; #qw( tempfile );
29 use Time::Local qw(timelocal);
33 use Business::CreditCard 0.28;
34 use FS::UID qw( dbh driver_name );
35 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
37 use FS::Misc qw( generate_ps do_print money_pretty card_types );
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;
58 use FS::cust_main_exemption;
59 use FS::cust_tax_adjustment;
60 use FS::cust_tax_location;
61 use FS::agent_currency;
62 use FS::cust_main_invoice;
64 use FS::prepay_credit;
70 use FS::payment_gateway;
71 use FS::agent_payment_gateway;
73 use FS::cust_main_note;
74 use FS::cust_attachment;
77 use FS::upgrade_journal;
82 use FS::Misc::Savepoint;
85 # 1 is mostly method/subroutine entry and options
86 # 2 traces progress of some operations
87 # 3 is even more information including possibly sensitive data
89 our $me = '[FS::cust_main]';
92 our $ignore_expired_card = 0;
93 our $ignore_banned_card = 0;
94 our $ignore_invalid_card = 0;
96 our $skip_fuzzyfiles = 0;
98 our $ucfirst_nowarn = 0;
100 #this info is in cust_payby as of 4.x
101 #this and the fields themselves can be removed in 5.x
102 our @encrypted_fields = ('payinfo', 'paycvv');
103 sub nohistory_fields { ('payinfo', 'paycvv'); }
106 our $default_agent_custid;
107 our $custnum_display_length;
108 #ask FS::UID to run this stuff for us later
109 #$FS::UID::callback{'FS::cust_main'} = sub {
110 install_callback FS::UID sub {
111 $conf = new FS::Conf;
112 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
113 $default_agent_custid = $conf->exists('cust_main-default_agent_custid');
114 $custnum_display_length = $conf->config('cust_main-custnum-display_length');
119 my ( $hashref, $cache ) = @_;
120 if ( exists $hashref->{'pkgnum'} ) {
121 #@{ $self->{'_pkgnum'} } = ();
122 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
123 $self->{'_pkgnum'} = $subcache;
124 #push @{ $self->{'_pkgnum'} },
125 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
131 FS::cust_main - Object methods for cust_main records
137 $record = new FS::cust_main \%hash;
138 $record = new FS::cust_main { 'column' => 'value' };
140 $error = $record->insert;
142 $error = $new_record->replace($old_record);
144 $error = $record->delete;
146 $error = $record->check;
148 @cust_pkg = $record->all_pkgs;
150 @cust_pkg = $record->ncancelled_pkgs;
152 @cust_pkg = $record->suspended_pkgs;
154 $error = $record->bill;
155 $error = $record->bill %options;
156 $error = $record->bill 'time' => $time;
158 $error = $record->collect;
159 $error = $record->collect %options;
160 $error = $record->collect 'invoice_time' => $time,
165 An FS::cust_main object represents a customer. FS::cust_main inherits from
166 FS::Record. The following fields are currently supported:
172 Primary key (assigned automatically for new customers)
176 Agent (see L<FS::agent>)
180 Advertising source (see L<FS::part_referral>)
192 Cocial security number (optional)
216 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
220 Payment Information (See L<FS::payinfo_Mixin> for data format)
224 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
228 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
232 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
236 Start date month (maestro/solo cards only)
240 Start date year (maestro/solo cards only)
244 Issue number (maestro/solo cards only)
248 Name on card or billing name
252 IP address from which payment information was received
256 Tax exempt, empty or `Y'
260 Order taker (see L<FS::access_user>)
266 =item referral_custnum
268 Referring customer number
272 Enable individual CDR spooling, empty or `Y'
276 A suggestion to events (see L<FS::part_bill_event>) to delay until this unix timestamp
280 Discourage individual CDR printing, empty or `Y'
284 Allow self-service editing of ticket subjects, empty or 'Y'
286 =item calling_list_exempt
288 Do not call, empty or 'Y'
290 =item invoice_ship_address
292 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
302 Creates a new customer. To add the customer to the database, see L<"insert">.
304 Note that this stores the hash reference, not a distinct copy of the hash it
305 points to. You can ask the object for a copy with the I<hash> method.
309 sub table { 'cust_main'; }
311 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
313 Adds this customer to the database. If there is an error, returns the error,
314 otherwise returns false.
316 Usually the customer's location will not yet exist in the database, and
317 the C<bill_location> and C<ship_location> pseudo-fields must be set to
318 uninserted L<FS::cust_location> objects. These will be inserted and linked
319 (in both directions) to the new customer record. If they're references
320 to the same object, they will become the same location.
322 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
323 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
324 are inserted atomicly, or the transaction is rolled back. Passing an empty
325 hash reference is equivalent to not supplying this parameter. There should be
326 a better explanation of this, but until then, here's an example:
329 tie %hash, 'Tie::RefHash'; #this part is important
331 $cust_pkg => [ $svc_acct ],
334 $cust_main->insert( \%hash );
336 INVOICING_LIST_ARYREF: No longer supported.
338 Currently available options are: I<depend_jobnum>, I<noexport>,
339 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
341 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
342 on the supplied jobnum (they will not run until the specific job completes).
343 This can be used to defer provisioning until some action completes (such
344 as running the customer's credit card successfully).
346 The I<noexport> option is deprecated. If I<noexport> is set true, no
347 provisioning jobs (exports) are scheduled. (You can schedule them later with
348 the B<reexport> method.)
350 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
351 of tax names and exemption numbers. FS::cust_main_exemption records will be
352 created and inserted.
354 If I<prospectnum> is set, moves contacts and locations from that prospect.
356 If I<contact> is set to an arrayref of FS::contact objects, those will be
359 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
360 unset), inserts those new contacts with this new customer. Handles CGI
361 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
363 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
364 new stored payment records with this new customer. Handles CGI parameters
365 for an "m2" multiple entry field as passed by edit/cust_main.cgi
371 my $cust_pkgs = @_ ? shift : {};
373 if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
374 warn "cust_main::insert using deprecated invoicing list argument";
375 $invoicing_list = shift;
378 warn "$me insert called with options ".
379 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
382 return "You are not permitted to change customer invoicing terms."
383 if $self->invoice_terms #i.e. not the default
384 && ! $FS::CurrentUser::CurrentUser->access_right('Edit customer invoice terms');
386 local $SIG{HUP} = 'IGNORE';
387 local $SIG{INT} = 'IGNORE';
388 local $SIG{QUIT} = 'IGNORE';
389 local $SIG{TERM} = 'IGNORE';
390 local $SIG{TSTP} = 'IGNORE';
391 local $SIG{PIPE} = 'IGNORE';
393 my $oldAutoCommit = $FS::UID::AutoCommit;
394 local $FS::UID::AutoCommit = 0;
397 my $prepay_identifier = '';
398 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
400 if ( $self->payby eq 'PREPAY' ) {
402 $self->payby(''); #'BILL');
403 $prepay_identifier = $self->payinfo;
406 warn " looking up prepaid card $prepay_identifier\n"
409 my $error = $self->get_prepay( $prepay_identifier,
410 'amount_ref' => \$amount,
411 'seconds_ref' => \$seconds,
412 'upbytes_ref' => \$upbytes,
413 'downbytes_ref' => \$downbytes,
414 'totalbytes_ref' => \$totalbytes,
417 $dbh->rollback if $oldAutoCommit;
418 #return "error applying prepaid card (transaction rolled back): $error";
422 $payby = 'PREP' if $amount;
424 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
427 $self->payby(''); #'BILL');
428 $amount = $self->paid;
433 foreach my $l (qw(bill_location ship_location)) {
435 my $loc = delete $self->hashref->{$l} or next;
437 if ( !$loc->locationnum ) {
438 # warn the location that we're going to insert it with no custnum
439 $loc->set(custnum_pending => 1);
440 warn " inserting $l\n"
442 my $error = $loc->insert;
444 $dbh->rollback if $oldAutoCommit;
445 my $label = $l eq 'ship_location' ? 'service' : 'billing';
446 return "$error (in $label location)";
449 } elsif ( $loc->prospectnum ) {
451 $loc->prospectnum('');
452 $loc->set(custnum_pending => 1);
453 my $error = $loc->replace;
455 $dbh->rollback if $oldAutoCommit;
456 my $label = $l eq 'ship_location' ? 'service' : 'billing';
457 return "$error (moving $label location)";
460 } elsif ( ($loc->custnum || 0) > 0 ) {
461 # then it somehow belongs to another customer--shouldn't happen
462 $dbh->rollback if $oldAutoCommit;
463 return "$l belongs to customer ".$loc->custnum;
465 # else it already belongs to this customer
466 # (happens when ship_location is identical to bill_location)
468 $self->set($l.'num', $loc->locationnum);
470 if ( $self->get($l.'num') eq '' ) {
471 $dbh->rollback if $oldAutoCommit;
476 warn " inserting $self\n"
479 $self->signupdate(time) unless $self->signupdate;
481 $self->auto_agent_custid()
482 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
484 my $error = $self->check_payinfo_cardtype
485 || $self->SUPER::insert;
487 $dbh->rollback if $oldAutoCommit;
488 #return "inserting cust_main record (transaction rolled back): $error";
492 # now set cust_location.custnum
493 foreach my $l (qw(bill_location ship_location)) {
494 warn " setting $l.custnum\n"
496 my $loc = $self->$l or next;
497 unless ( $loc->custnum ) {
498 $loc->set(custnum => $self->custnum);
499 $error ||= $loc->replace;
503 $dbh->rollback if $oldAutoCommit;
504 return "error setting $l custnum: $error";
508 warn " setting customer tags\n"
511 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
512 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
513 'custnum' => $self->custnum };
514 my $error = $cust_tag->insert;
516 $dbh->rollback if $oldAutoCommit;
521 my $prospectnum = delete $options{'prospectnum'};
522 if ( $prospectnum ) {
524 warn " moving contacts and locations from prospect $prospectnum\n"
528 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
529 unless ( $prospect_main ) {
530 $dbh->rollback if $oldAutoCommit;
531 return "Unknown prospectnum $prospectnum";
533 $prospect_main->custnum($self->custnum);
534 $prospect_main->disabled('Y');
535 my $error = $prospect_main->replace;
537 $dbh->rollback if $oldAutoCommit;
541 foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
542 my $cust_contact = new FS::cust_contact {
543 'custnum' => $self->custnum,
544 'invoice_dest' => 'Y', # invoice_dest currently not set for prospect contacts
545 map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
547 my $error = $cust_contact->insert
548 || $prospect_contact->delete;
550 $dbh->rollback if $oldAutoCommit;
555 my @cust_location = $prospect_main->cust_location;
556 my @qual = $prospect_main->qual;
558 foreach my $r ( @cust_location, @qual ) {
560 $r->custnum($self->custnum);
561 my $error = $r->replace;
563 $dbh->rollback if $oldAutoCommit;
567 # since we set invoice_dest on all migrated prospect contacts (for now),
568 # don't process invoicing_list.
569 delete $options{'invoicing_list'};
570 $invoicing_list = undef;
573 warn " setting contacts\n"
576 $invoicing_list ||= $options{'invoicing_list'};
577 if ( $invoicing_list ) {
579 $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
582 foreach my $dest (@$invoicing_list ) {
583 if ($dest eq 'POST') {
584 $self->set('postal_invoice', 'Y');
587 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
588 if ( $contact_email ) {
589 my $cust_contact = FS::cust_contact->new({
590 contactnum => $contact_email->contactnum,
591 custnum => $self->custnum,
593 $cust_contact->set('invoice_dest', 'Y');
594 my $error = $cust_contact->insert;
596 $dbh->rollback if $oldAutoCommit;
597 return "$error (linking to email address $dest)";
601 # this email address is not yet linked to any contact
602 $email .= ',' if length($email);
610 my $contact = FS::contact->new({
611 'custnum' => $self->get('custnum'),
612 'last' => $self->get('last'),
613 'first' => $self->get('first'),
614 'emailaddress' => $email,
615 'invoice_dest' => 'Y', # yes, you can set this via the contact
617 my $error = $contact->insert;
619 $dbh->rollback if $oldAutoCommit;
627 if ( my $contact = delete $options{'contact'} ) {
629 foreach my $c ( @$contact ) {
630 $c->custnum($self->custnum);
631 my $error = $c->insert;
633 $dbh->rollback if $oldAutoCommit;
639 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
641 my $error = $self->process_o2m( 'table' => 'contact',
642 'fields' => FS::contact->cgi_contact_fields,
643 'params' => $contact_params,
646 $dbh->rollback if $oldAutoCommit;
651 warn " setting cust_payby\n"
654 if ( $options{cust_payby} ) {
656 foreach my $cust_payby ( @{ $options{cust_payby} } ) {
657 $cust_payby->custnum($self->custnum);
658 my $error = $cust_payby->insert;
660 $dbh->rollback if $oldAutoCommit;
665 } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
667 my $error = $self->process_o2m(
668 'table' => 'cust_payby',
669 'fields' => FS::cust_payby->cgi_cust_payby_fields,
670 'params' => $cust_payby_params,
671 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
674 $dbh->rollback if $oldAutoCommit;
680 warn " setting cust_main_exemption\n"
683 my $tax_exemption = delete $options{'tax_exemption'};
684 if ( $tax_exemption ) {
686 $tax_exemption = { map { $_ => '' } @$tax_exemption }
687 if ref($tax_exemption) eq 'ARRAY';
689 foreach my $taxname ( keys %$tax_exemption ) {
690 my $cust_main_exemption = new FS::cust_main_exemption {
691 'custnum' => $self->custnum,
692 'taxname' => $taxname,
693 'exempt_number' => $tax_exemption->{$taxname},
695 my $error = $cust_main_exemption->insert;
697 $dbh->rollback if $oldAutoCommit;
698 return "inserting cust_main_exemption (transaction rolled back): $error";
703 warn " ordering packages\n"
706 $error = $self->order_pkgs( $cust_pkgs,
708 'seconds_ref' => \$seconds,
709 'upbytes_ref' => \$upbytes,
710 'downbytes_ref' => \$downbytes,
711 'totalbytes_ref' => \$totalbytes,
714 $dbh->rollback if $oldAutoCommit;
719 $dbh->rollback if $oldAutoCommit;
720 return "No svc_acct record to apply pre-paid time";
722 if ( $upbytes || $downbytes || $totalbytes ) {
723 $dbh->rollback if $oldAutoCommit;
724 return "No svc_acct record to apply pre-paid data";
728 warn " inserting initial $payby payment of $amount\n"
730 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
732 $dbh->rollback if $oldAutoCommit;
733 return "inserting payment (transaction rolled back): $error";
737 unless ( $import || $skip_fuzzyfiles ) {
738 warn " queueing fuzzyfiles update\n"
740 $error = $self->queue_fuzzyfiles_update;
742 $dbh->rollback if $oldAutoCommit;
743 return "updating fuzzy search cache: $error";
748 warn " exporting\n" if $DEBUG > 1;
750 my $export_args = $options{'export_args'} || [];
753 map qsearch( 'part_export', {exportnum=>$_} ),
754 $conf->config('cust_main-exports'); #, $agentnum
756 foreach my $part_export ( @part_export ) {
757 my $error = $part_export->export_insert($self, @$export_args);
759 $dbh->rollback if $oldAutoCommit;
760 return "exporting to ". $part_export->exporttype.
761 " (transaction rolled back): $error";
765 #foreach my $depend_jobnum ( @$depend_jobnums ) {
766 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
768 # foreach my $jobnum ( @jobnums ) {
769 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
770 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
772 # my $error = $queue->depend_insert($depend_jobnum);
774 # $dbh->rollback if $oldAutoCommit;
775 # return "error queuing job dependancy: $error";
782 #if ( exists $options{'jobnums'} ) {
783 # push @{ $options{'jobnums'} }, @jobnums;
786 warn " insert complete; committing transaction\n"
789 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
794 use File::CounterFile;
795 sub auto_agent_custid {
798 my $format = $conf->config('cust_main-auto_agent_custid');
800 if ( $format eq '1YMMXXXXXXXX' ) {
802 my $counter = new File::CounterFile 'cust_main.agent_custid';
805 my $ym = 100000000000 + time2str('%y%m00000000', time);
806 if ( $ym > $counter->value ) {
807 $counter->{'value'} = $agent_custid = $ym;
808 $counter->{'updated'} = 1;
810 $agent_custid = $counter->inc;
816 die "Unknown cust_main-auto_agent_custid format: $format";
819 $self->agent_custid($agent_custid);
823 =item PACKAGE METHODS
825 Documentation on customer package methods has been moved to
826 L<FS::cust_main::Packages>.
828 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
830 Recharges this (existing) customer with the specified prepaid card (see
831 L<FS::prepay_credit>), specified either by I<identifier> or as an
832 FS::prepay_credit object. If there is an error, returns the error, otherwise
835 Optionally, five scalar references can be passed as well. They will have their
836 values filled in with the amount, number of seconds, and number of upload,
837 download, and total bytes applied by this prepaid card.
841 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
842 #the only place that uses these args
843 sub recharge_prepay {
844 my( $self, $prepay_credit, $amountref, $secondsref,
845 $upbytesref, $downbytesref, $totalbytesref ) = @_;
847 local $SIG{HUP} = 'IGNORE';
848 local $SIG{INT} = 'IGNORE';
849 local $SIG{QUIT} = 'IGNORE';
850 local $SIG{TERM} = 'IGNORE';
851 local $SIG{TSTP} = 'IGNORE';
852 local $SIG{PIPE} = 'IGNORE';
854 my $oldAutoCommit = $FS::UID::AutoCommit;
855 local $FS::UID::AutoCommit = 0;
858 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
860 my $error = $self->get_prepay( $prepay_credit,
861 'amount_ref' => \$amount,
862 'seconds_ref' => \$seconds,
863 'upbytes_ref' => \$upbytes,
864 'downbytes_ref' => \$downbytes,
865 'totalbytes_ref' => \$totalbytes,
867 || $self->increment_seconds($seconds)
868 || $self->increment_upbytes($upbytes)
869 || $self->increment_downbytes($downbytes)
870 || $self->increment_totalbytes($totalbytes)
871 || $self->insert_cust_pay_prepay( $amount,
873 ? $prepay_credit->identifier
878 $dbh->rollback if $oldAutoCommit;
882 if ( defined($amountref) ) { $$amountref = $amount; }
883 if ( defined($secondsref) ) { $$secondsref = $seconds; }
884 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
885 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
886 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
888 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
893 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
895 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
896 specified either by I<identifier> or as an FS::prepay_credit object.
898 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
899 incremented by the values of the prepaid card.
901 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
902 check or set this customer's I<agentnum>.
904 If there is an error, returns the error, otherwise returns false.
910 my( $self, $prepay_credit, %opt ) = @_;
912 local $SIG{HUP} = 'IGNORE';
913 local $SIG{INT} = 'IGNORE';
914 local $SIG{QUIT} = 'IGNORE';
915 local $SIG{TERM} = 'IGNORE';
916 local $SIG{TSTP} = 'IGNORE';
917 local $SIG{PIPE} = 'IGNORE';
919 my $oldAutoCommit = $FS::UID::AutoCommit;
920 local $FS::UID::AutoCommit = 0;
923 unless ( ref($prepay_credit) ) {
925 my $identifier = $prepay_credit;
927 $prepay_credit = qsearchs(
929 { 'identifier' => $identifier },
934 unless ( $prepay_credit ) {
935 $dbh->rollback if $oldAutoCommit;
936 return "Invalid prepaid card: ". $identifier;
941 if ( $prepay_credit->agentnum ) {
942 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
943 $dbh->rollback if $oldAutoCommit;
944 return "prepaid card not valid for agent ". $self->agentnum;
946 $self->agentnum($prepay_credit->agentnum);
949 my $error = $prepay_credit->delete;
951 $dbh->rollback if $oldAutoCommit;
952 return "removing prepay_credit (transaction rolled back): $error";
955 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
956 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
958 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
963 =item increment_upbytes SECONDS
965 Updates this customer's single or primary account (see L<FS::svc_acct>) by
966 the specified number of upbytes. If there is an error, returns the error,
967 otherwise returns false.
971 sub increment_upbytes {
972 _increment_column( shift, 'upbytes', @_);
975 =item increment_downbytes SECONDS
977 Updates this customer's single or primary account (see L<FS::svc_acct>) by
978 the specified number of downbytes. If there is an error, returns the error,
979 otherwise returns false.
983 sub increment_downbytes {
984 _increment_column( shift, 'downbytes', @_);
987 =item increment_totalbytes SECONDS
989 Updates this customer's single or primary account (see L<FS::svc_acct>) by
990 the specified number of totalbytes. If there is an error, returns the error,
991 otherwise returns false.
995 sub increment_totalbytes {
996 _increment_column( shift, 'totalbytes', @_);
999 =item increment_seconds SECONDS
1001 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1002 the specified number of seconds. If there is an error, returns the error,
1003 otherwise returns false.
1007 sub increment_seconds {
1008 _increment_column( shift, 'seconds', @_);
1011 =item _increment_column AMOUNT
1013 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1014 the specified number of seconds or bytes. If there is an error, returns
1015 the error, otherwise returns false.
1019 sub _increment_column {
1020 my( $self, $column, $amount ) = @_;
1021 warn "$me increment_column called: $column, $amount\n"
1024 return '' unless $amount;
1026 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1027 $self->ncancelled_pkgs;
1029 if ( ! @cust_pkg ) {
1030 return 'No packages with primary or single services found'.
1031 ' to apply pre-paid time';
1032 } elsif ( scalar(@cust_pkg) > 1 ) {
1033 #maybe have a way to specify the package/account?
1034 return 'Multiple packages found to apply pre-paid time';
1037 my $cust_pkg = $cust_pkg[0];
1038 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1042 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1044 if ( ! @cust_svc ) {
1045 return 'No account found to apply pre-paid time';
1046 } elsif ( scalar(@cust_svc) > 1 ) {
1047 return 'Multiple accounts found to apply pre-paid time';
1050 my $svc_acct = $cust_svc[0]->svc_x;
1051 warn " found service svcnum ". $svc_acct->pkgnum.
1052 ' ('. $svc_acct->email. ")\n"
1055 $column = "increment_$column";
1056 $svc_acct->$column($amount);
1060 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1062 Inserts a prepayment in the specified amount for this customer. An optional
1063 second argument can specify the prepayment identifier for tracking purposes.
1064 If there is an error, returns the error, otherwise returns false.
1068 sub insert_cust_pay_prepay {
1069 shift->insert_cust_pay('PREP', @_);
1072 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1074 Inserts a cash payment in the specified amount for this customer. An optional
1075 second argument can specify the payment identifier for tracking purposes.
1076 If there is an error, returns the error, otherwise returns false.
1080 sub insert_cust_pay_cash {
1081 shift->insert_cust_pay('CASH', @_);
1084 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1086 Inserts a Western Union payment in the specified amount for this customer. An
1087 optional second argument can specify the prepayment identifier for tracking
1088 purposes. If there is an error, returns the error, otherwise returns false.
1092 sub insert_cust_pay_west {
1093 shift->insert_cust_pay('WEST', @_);
1096 sub insert_cust_pay {
1097 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1098 my $payinfo = scalar(@_) ? shift : '';
1100 my $cust_pay = new FS::cust_pay {
1101 'custnum' => $self->custnum,
1102 'paid' => sprintf('%.2f', $amount),
1103 #'_date' => #date the prepaid card was purchased???
1105 'payinfo' => $payinfo,
1111 =item delete [ OPTION => VALUE ... ]
1113 This deletes the customer. If there is an error, returns the error, otherwise
1116 This will completely remove all traces of the customer record. This is not
1117 what you want when a customer cancels service; for that, cancel all of the
1118 customer's packages (see L</cancel>).
1120 If the customer has any uncancelled packages, you need to pass a new (valid)
1121 customer number for those packages to be transferred to, as the "new_customer"
1122 option. Cancelled packages will be deleted. Did I mention that this is NOT
1123 what you want when a customer cancels service and that you really should be
1124 looking at L<FS::cust_pkg/cancel>?
1126 You can't delete a customer with invoices (see L<FS::cust_bill>),
1127 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1128 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1129 set the "delete_financials" option to a true value.
1134 my( $self, %opt ) = @_;
1136 local $SIG{HUP} = 'IGNORE';
1137 local $SIG{INT} = 'IGNORE';
1138 local $SIG{QUIT} = 'IGNORE';
1139 local $SIG{TERM} = 'IGNORE';
1140 local $SIG{TSTP} = 'IGNORE';
1141 local $SIG{PIPE} = 'IGNORE';
1143 my $oldAutoCommit = $FS::UID::AutoCommit;
1144 local $FS::UID::AutoCommit = 0;
1147 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1148 $dbh->rollback if $oldAutoCommit;
1149 return "Can't delete a master agent customer";
1152 #use FS::access_user
1153 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1154 $dbh->rollback if $oldAutoCommit;
1155 return "Can't delete a master employee customer";
1158 tie my %financial_tables, 'Tie::IxHash',
1159 'cust_bill' => 'invoices',
1160 'cust_statement' => 'statements',
1161 'cust_credit' => 'credits',
1162 'cust_pay' => 'payments',
1163 'cust_refund' => 'refunds',
1166 foreach my $table ( keys %financial_tables ) {
1168 my @records = $self->$table();
1170 if ( @records && ! $opt{'delete_financials'} ) {
1171 $dbh->rollback if $oldAutoCommit;
1172 return "Can't delete a customer with ". $financial_tables{$table};
1175 foreach my $record ( @records ) {
1176 my $error = $record->delete;
1178 $dbh->rollback if $oldAutoCommit;
1179 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1185 my @cust_pkg = $self->ncancelled_pkgs;
1187 my $new_custnum = $opt{'new_custnum'};
1188 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1189 $dbh->rollback if $oldAutoCommit;
1190 return "Invalid new customer number: $new_custnum";
1192 foreach my $cust_pkg ( @cust_pkg ) {
1193 my %hash = $cust_pkg->hash;
1194 $hash{'custnum'} = $new_custnum;
1195 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1196 my $error = $new_cust_pkg->replace($cust_pkg,
1197 options => { $cust_pkg->options },
1200 $dbh->rollback if $oldAutoCommit;
1205 my @cancelled_cust_pkg = $self->all_pkgs;
1206 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1207 my $error = $cust_pkg->delete;
1209 $dbh->rollback if $oldAutoCommit;
1214 #cust_tax_adjustment in financials?
1215 #cust_pay_pending? ouch
1216 foreach my $table (qw(
1217 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1218 cust_payby cust_location cust_main_note cust_tax_adjustment
1219 cust_pay_void cust_pay_batch queue cust_tax_exempt
1221 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1222 my $error = $record->delete;
1224 $dbh->rollback if $oldAutoCommit;
1230 my $sth = $dbh->prepare(
1231 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1233 my $errstr = $dbh->errstr;
1234 $dbh->rollback if $oldAutoCommit;
1237 $sth->execute($self->custnum) or do {
1238 my $errstr = $sth->errstr;
1239 $dbh->rollback if $oldAutoCommit;
1245 my $ticket_dbh = '';
1246 if ($conf->config('ticket_system') eq 'RT_Internal') {
1248 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1249 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1250 $ticket_dbh = FS::DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1251 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1254 if ( $ticket_dbh ) {
1256 my $ticket_sth = $ticket_dbh->prepare(
1257 'DELETE FROM Links WHERE Target = ?'
1259 my $errstr = $ticket_dbh->errstr;
1260 $dbh->rollback if $oldAutoCommit;
1263 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1265 my $errstr = $ticket_sth->errstr;
1266 $dbh->rollback if $oldAutoCommit;
1270 #check and see if the customer is the only link on the ticket, and
1271 #if so, set the ticket to deleted status in RT?
1272 #maybe someday, for now this will at least fix tickets not displaying
1276 #delete the customer record
1278 my $error = $self->SUPER::delete;
1280 $dbh->rollback if $oldAutoCommit;
1284 # cust_main exports!
1286 #my $export_args = $options{'export_args'} || [];
1289 map qsearch( 'part_export', {exportnum=>$_} ),
1290 $conf->config('cust_main-exports'); #, $agentnum
1292 foreach my $part_export ( @part_export ) {
1293 my $error = $part_export->export_delete( $self ); #, @$export_args);
1295 $dbh->rollback if $oldAutoCommit;
1296 return "exporting to ". $part_export->exporttype.
1297 " (transaction rolled back): $error";
1301 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1306 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1308 Replaces the OLD_RECORD with this one in the database. If there is an error,
1309 returns the error, otherwise returns false.
1311 To change the customer's address, set the pseudo-fields C<bill_location> and
1312 C<ship_location>. The address will still only change if at least one of the
1313 address fields differs from the existing values.
1315 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1316 set as the contact email address for a default contact with the same name as
1319 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1320 I<contact_params>, I<invoicing_list>.
1322 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1323 of tax names and exemption numbers. FS::cust_main_exemption records will be
1324 deleted and inserted as appropriate.
1326 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1327 groups (describing the customer's payment methods and contacts, respectively)
1328 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1329 and L<FS::contact> for the fields these can contain.
1331 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1332 should be used instead if possible.
1339 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1341 : $self->replace_old;
1345 warn "$me replace called\n"
1348 my $curuser = $FS::CurrentUser::CurrentUser;
1349 return "You are not permitted to create complimentary accounts."
1350 if $self->complimentary eq 'Y'
1351 && $self->complimentary ne $old->complimentary
1352 && ! $curuser->access_right('Complimentary customer');
1354 local($ignore_expired_card) = 1
1355 if $old->payby =~ /^(CARD|DCRD)$/
1356 && $self->payby =~ /^(CARD|DCRD)$/
1357 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1359 local($ignore_banned_card) = 1
1360 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1361 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1362 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1364 if ( $self->payby =~ /^(CARD|DCRD)$/
1365 && $old->payinfo ne $self->payinfo
1366 && $old->paymask ne $self->paymask )
1368 my $error = $self->check_payinfo_cardtype;
1369 return $error if $error;
1372 return "Invoicing locale is required"
1375 && $conf->exists('cust_main-require_locale');
1377 return "You are not permitted to change customer invoicing terms."
1378 if $old->invoice_terms ne $self->invoice_terms
1379 && ! $curuser->access_right('Edit customer invoice terms');
1381 local $SIG{HUP} = 'IGNORE';
1382 local $SIG{INT} = 'IGNORE';
1383 local $SIG{QUIT} = 'IGNORE';
1384 local $SIG{TERM} = 'IGNORE';
1385 local $SIG{TSTP} = 'IGNORE';
1386 local $SIG{PIPE} = 'IGNORE';
1388 my $oldAutoCommit = $FS::UID::AutoCommit;
1389 local $FS::UID::AutoCommit = 0;
1392 for my $l (qw(bill_location ship_location)) {
1393 #my $old_loc = $old->$l;
1394 my $new_loc = $self->$l or next;
1396 # find the existing location if there is one
1397 $new_loc->set('custnum' => $self->custnum);
1398 my $error = $new_loc->find_or_insert;
1400 $dbh->rollback if $oldAutoCommit;
1403 $self->set($l.'num', $new_loc->locationnum);
1407 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1408 warn "cust_main::replace: using deprecated invoicing list argument";
1409 $invoicing_list = shift @param;
1412 my %options = @param;
1414 $invoicing_list ||= $options{invoicing_list};
1416 my @contacts = map { $_->contact } $self->cust_contact;
1417 # find a contact that matches the customer's name
1418 my ($implicit_contact) = grep { $_->first eq $old->get('first')
1419 and $_->last eq $old->get('last') }
1421 $implicit_contact ||= FS::contact->new({
1422 'custnum' => $self->custnum,
1423 'locationnum' => $self->get('bill_locationnum'),
1426 # for any of these that are already contact emails, link to the existing
1428 if ( $invoicing_list ) {
1431 # kind of like process_m2m on these, except:
1432 # - the other side is two tables in a join
1433 # - and we might have to create new contact_emails
1434 # - and possibly a new contact
1436 # Find existing invoice emails that aren't on the implicit contact.
1437 # Any of these that are not on the new invoicing list will be removed.
1438 my %old_email_cust_contact;
1439 foreach my $cust_contact ($self->cust_contact) {
1440 next if !$cust_contact->invoice_dest;
1441 next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1443 foreach my $contact_email ($cust_contact->contact->contact_email) {
1444 $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1448 foreach my $dest (@$invoicing_list) {
1450 if ($dest eq 'POST') {
1452 $self->set('postal_invoice', 'Y');
1454 } elsif ( exists($old_email_cust_contact{$dest}) ) {
1456 delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1460 # See if it belongs to some other contact; if so, link it.
1461 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1463 and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1464 my $cust_contact = qsearchs('cust_contact', {
1465 contactnum => $contact_email->contactnum,
1466 custnum => $self->custnum,
1467 }) || FS::cust_contact->new({
1468 contactnum => $contact_email->contactnum,
1469 custnum => $self->custnum,
1471 $cust_contact->set('invoice_dest', 'Y');
1472 my $error = $cust_contact->custcontactnum ?
1473 $cust_contact->replace : $cust_contact->insert;
1475 $dbh->rollback if $oldAutoCommit;
1476 return "$error (linking to email address $dest)";
1480 # This email address is not yet linked to any contact, so it will
1481 # be added to the implicit contact.
1482 $email .= ',' if length($email);
1488 foreach my $remove_dest (keys %old_email_cust_contact) {
1489 my $cust_contact = $old_email_cust_contact{$remove_dest};
1490 # These were not in the list of requested destinations, so take them off.
1491 $cust_contact->set('invoice_dest', '');
1492 my $error = $cust_contact->replace;
1494 $dbh->rollback if $oldAutoCommit;
1495 return "$error (unlinking email address $remove_dest)";
1499 # make sure it keeps up with the changed customer name, if any
1500 $implicit_contact->set('last', $self->get('last'));
1501 $implicit_contact->set('first', $self->get('first'));
1502 $implicit_contact->set('emailaddress', $email);
1503 $implicit_contact->set('invoice_dest', 'Y');
1504 $implicit_contact->set('custnum', $self->custnum);
1505 my $i_cust_contact =
1506 qsearchs('cust_contact', {
1507 contactnum => $implicit_contact->contactnum,
1508 custnum => $self->custnum,
1511 if ( $i_cust_contact ) {
1512 $implicit_contact->set($_, $i_cust_contact->$_)
1513 foreach qw( classnum selfservice_access comment );
1517 if ( $implicit_contact->contactnum ) {
1518 $error = $implicit_contact->replace;
1519 } elsif ( length($email) ) { # don't create a new contact if not needed
1520 $error = $implicit_contact->insert;
1524 $dbh->rollback if $oldAutoCommit;
1525 return "$error (adding email address $email)";
1530 # replace the customer record
1531 my $error = $self->SUPER::replace($old);
1534 $dbh->rollback if $oldAutoCommit;
1538 # now move packages to the new service location
1539 $self->set('ship_location', ''); #flush cache
1540 if ( $old->ship_locationnum and # should only be null during upgrade...
1541 $old->ship_locationnum != $self->ship_locationnum ) {
1542 $error = $old->ship_location->move_to($self->ship_location);
1544 $dbh->rollback if $oldAutoCommit;
1548 # don't move packages based on the billing location, but
1549 # disable it if it's no longer in use
1550 if ( $old->bill_locationnum and
1551 $old->bill_locationnum != $self->bill_locationnum ) {
1552 $error = $old->bill_location->disable_if_unused;
1554 $dbh->rollback if $oldAutoCommit;
1559 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1561 #this could be more efficient than deleting and re-inserting, if it matters
1562 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1563 my $error = $cust_tag->delete;
1565 $dbh->rollback if $oldAutoCommit;
1569 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1570 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1571 'custnum' => $self->custnum };
1572 my $error = $cust_tag->insert;
1574 $dbh->rollback if $oldAutoCommit;
1581 my $tax_exemption = delete $options{'tax_exemption'};
1582 if ( $tax_exemption ) {
1584 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1585 if ref($tax_exemption) eq 'ARRAY';
1587 my %cust_main_exemption =
1588 map { $_->taxname => $_ }
1589 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1591 foreach my $taxname ( keys %$tax_exemption ) {
1593 if ( $cust_main_exemption{$taxname} &&
1594 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1597 delete $cust_main_exemption{$taxname};
1601 my $cust_main_exemption = new FS::cust_main_exemption {
1602 'custnum' => $self->custnum,
1603 'taxname' => $taxname,
1604 'exempt_number' => $tax_exemption->{$taxname},
1606 my $error = $cust_main_exemption->insert;
1608 $dbh->rollback if $oldAutoCommit;
1609 return "inserting cust_main_exemption (transaction rolled back): $error";
1613 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1614 my $error = $cust_main_exemption->delete;
1616 $dbh->rollback if $oldAutoCommit;
1617 return "deleting cust_main_exemption (transaction rolled back): $error";
1623 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1625 my $error = $self->process_o2m(
1626 'table' => 'cust_payby',
1627 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1628 'params' => $cust_payby_params,
1629 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1632 $dbh->rollback if $oldAutoCommit;
1638 if ( my $contact_params = delete $options{'contact_params'} ) {
1640 # this can potentially replace contacts that were created by the
1641 # invoicing list argument, but the UI shouldn't allow both of them
1644 my $error = $self->process_o2m(
1645 'table' => 'contact',
1646 'fields' => FS::contact->cgi_contact_fields,
1647 'params' => $contact_params,
1650 $dbh->rollback if $oldAutoCommit;
1656 unless ( $import || $skip_fuzzyfiles ) {
1657 $error = $self->queue_fuzzyfiles_update;
1659 $dbh->rollback if $oldAutoCommit;
1660 return "updating fuzzy search cache: $error";
1664 # tax district update in cust_location
1666 # cust_main exports!
1668 my $export_args = $options{'export_args'} || [];
1671 map qsearch( 'part_export', {exportnum=>$_} ),
1672 $conf->config('cust_main-exports'); #, $agentnum
1674 foreach my $part_export ( @part_export ) {
1675 my $error = $part_export->export_replace( $self, $old, @$export_args);
1677 $dbh->rollback if $oldAutoCommit;
1678 return "exporting to ". $part_export->exporttype.
1679 " (transaction rolled back): $error";
1683 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1688 =item queue_fuzzyfiles_update
1690 Used by insert & replace to update the fuzzy search cache
1694 use FS::cust_main::Search;
1695 sub queue_fuzzyfiles_update {
1698 local $SIG{HUP} = 'IGNORE';
1699 local $SIG{INT} = 'IGNORE';
1700 local $SIG{QUIT} = 'IGNORE';
1701 local $SIG{TERM} = 'IGNORE';
1702 local $SIG{TSTP} = 'IGNORE';
1703 local $SIG{PIPE} = 'IGNORE';
1705 my $oldAutoCommit = $FS::UID::AutoCommit;
1706 local $FS::UID::AutoCommit = 0;
1709 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1710 my $queue = new FS::queue {
1711 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1713 my @args = "cust_main.$field", $self->get($field);
1714 my $error = $queue->insert( @args );
1716 $dbh->rollback if $oldAutoCommit;
1717 return "queueing job (transaction rolled back): $error";
1722 push @locations, $self->bill_location if $self->bill_locationnum;
1723 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1724 foreach my $location (@locations) {
1725 my $queue = new FS::queue {
1726 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1728 my @args = 'cust_location.address1', $location->address1;
1729 my $error = $queue->insert( @args );
1731 $dbh->rollback if $oldAutoCommit;
1732 return "queueing job (transaction rolled back): $error";
1736 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1743 Checks all fields to make sure this is a valid customer record. If there is
1744 an error, returns the error, otherwise returns false. Called by the insert
1745 and replace methods.
1752 warn "$me check BEFORE: \n". $self->_dump
1756 $self->ut_numbern('custnum')
1757 || $self->ut_number('agentnum')
1758 || $self->ut_textn('agent_custid')
1759 || $self->ut_number('refnum')
1760 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1761 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1762 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1763 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1764 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1765 || $self->ut_textn('custbatch')
1766 || $self->ut_name('last')
1767 || $self->ut_name('first')
1768 || $self->ut_snumbern('signupdate')
1769 || $self->ut_snumbern('birthdate')
1770 || $self->ut_namen('spouse_last')
1771 || $self->ut_namen('spouse_first')
1772 || $self->ut_snumbern('spouse_birthdate')
1773 || $self->ut_snumbern('anniversary_date')
1774 || $self->ut_textn('company')
1775 || $self->ut_textn('ship_company')
1776 || $self->ut_anything('comments')
1777 || $self->ut_numbern('referral_custnum')
1778 || $self->ut_textn('stateid')
1779 || $self->ut_textn('stateid_state')
1780 || $self->ut_textn('invoice_terms')
1781 || $self->ut_floatn('cdr_termination_percentage')
1782 || $self->ut_floatn('credit_limit')
1783 || $self->ut_numbern('billday')
1784 || $self->ut_numbern('prorate_day')
1785 || $self->ut_flag('force_prorate_day')
1786 || $self->ut_flag('edit_subject')
1787 || $self->ut_flag('calling_list_exempt')
1788 || $self->ut_flag('invoice_noemail')
1789 || $self->ut_flag('message_noemail')
1790 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1791 || $self->ut_currencyn('currency')
1792 || $self->ut_textn('po_number')
1793 || $self->ut_enum('complimentary', [ '', 'Y' ])
1794 || $self->ut_flag('invoice_ship_address')
1795 || $self->ut_flag('invoice_dest')
1798 foreach (qw(company ship_company)) {
1799 my $company = $self->get($_);
1800 $company =~ s/^\s+//;
1801 $company =~ s/\s+$//;
1802 $company =~ s/\s+/ /g;
1803 $self->set($_, $company);
1806 #barf. need message catalogs. i18n. etc.
1807 $error .= "Please select an advertising source."
1808 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1809 return $error if $error;
1811 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1812 or return "Unknown agent";
1814 if ( $self->currency ) {
1815 my $agent_currency = qsearchs( 'agent_currency', {
1816 'agentnum' => $agent->agentnum,
1817 'currency' => $self->currency,
1819 or return "Agent ". $agent->agent.
1820 " not permitted to offer ". $self->currency. " invoicing";
1823 return "Unknown refnum"
1824 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1826 return "Unknown referring custnum: ". $self->referral_custnum
1827 unless ! $self->referral_custnum
1828 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1830 if ( $self->ss eq '' ) {
1835 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1836 or return "Illegal social security number: ". $self->ss;
1837 $self->ss("$1-$2-$3");
1840 #turn off invoice_ship_address if ship & bill are the same
1841 if ($self->bill_locationnum eq $self->ship_locationnum) {
1842 $self->invoice_ship_address('');
1845 # cust_main_county verification now handled by cust_location check
1848 $self->ut_phonen('daytime', $self->country)
1849 || $self->ut_phonen('night', $self->country)
1850 || $self->ut_phonen('fax', $self->country)
1851 || $self->ut_phonen('mobile', $self->country)
1853 return $error if $error;
1855 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1857 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1860 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1862 : FS::Msgcat::_gettext('daytime');
1863 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1865 : FS::Msgcat::_gettext('night');
1867 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1869 : FS::Msgcat::_gettext('mobile');
1871 return "$daytime_label, $night_label or $mobile_label is required"
1875 ### start of stuff moved to cust_payby
1876 # then mostly kept here to support upgrades (can remove in 5.x)
1877 # but modified to allow everything to be empty
1879 if ( $self->payby ) {
1880 FS::payby->can_payby($self->table, $self->payby)
1881 or return "Illegal payby: ". $self->payby;
1886 $error = $self->ut_numbern('paystart_month')
1887 || $self->ut_numbern('paystart_year')
1888 || $self->ut_numbern('payissue')
1889 || $self->ut_textn('paytype')
1891 return $error if $error;
1893 if ( $self->payip eq '' ) {
1896 $error = $self->ut_ip('payip');
1897 return $error if $error;
1900 # If it is encrypted and the private key is not availaible then we can't
1901 # check the credit card.
1902 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1904 # Need some kind of global flag to accept invalid cards, for testing
1906 if ( !$import && !$ignore_invalid_card && $check_payinfo &&
1907 $self->payby =~ /^(CARD|DCRD)$/ ) {
1909 my $payinfo = $self->payinfo;
1910 $payinfo =~ s/\D//g;
1911 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1912 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1914 $self->payinfo($payinfo);
1916 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1918 return gettext('unknown_card_type')
1919 if $self->payinfo !~ /^99\d{14}$/ #token
1920 && cardtype($self->payinfo) eq "Unknown";
1922 unless ( $ignore_banned_card ) {
1923 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1925 if ( $ban->bantype eq 'warn' ) {
1926 #or others depending on value of $ban->reason ?
1927 return '_duplicate_card'.
1928 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1929 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1930 ' (ban# '. $ban->bannum. ')'
1931 unless $self->override_ban_warn;
1933 return 'Banned credit card: banned on '.
1934 time2str('%a %h %o at %r', $ban->_date).
1935 ' by '. $ban->otaker.
1936 ' (ban# '. $ban->bannum. ')';
1941 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1942 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1943 $self->paycvv =~ /^(\d{4})$/
1944 or return "CVV2 (CID) for American Express cards is four digits.";
1947 $self->paycvv =~ /^(\d{3})$/
1948 or return "CVV2 (CVC2/CID) is three digits.";
1955 my $cardtype = cardtype($payinfo);
1956 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1958 return "Start date or issue number is required for $cardtype cards"
1959 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1961 return "Start month must be between 1 and 12"
1962 if $self->paystart_month
1963 and $self->paystart_month < 1 || $self->paystart_month > 12;
1965 return "Start year must be 1990 or later"
1966 if $self->paystart_year
1967 and $self->paystart_year < 1990;
1969 return "Issue number must be beween 1 and 99"
1971 and $self->payissue < 1 || $self->payissue > 99;
1974 $self->paystart_month('');
1975 $self->paystart_year('');
1976 $self->payissue('');
1979 } elsif ( !$ignore_invalid_card && $check_payinfo &&
1980 $self->payby =~ /^(CHEK|DCHK)$/ ) {
1982 my $payinfo = $self->payinfo;
1983 $payinfo =~ s/[^\d\@\.]//g;
1984 if ( $conf->config('echeck-country') eq 'CA' ) {
1985 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1986 or return 'invalid echeck account@branch.bank';
1987 $payinfo = "$1\@$2.$3";
1988 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1989 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1990 $payinfo = "$1\@$2";
1992 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1993 $payinfo = "$1\@$2";
1995 $self->payinfo($payinfo);
1998 unless ( $ignore_banned_card ) {
1999 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
2001 if ( $ban->bantype eq 'warn' ) {
2002 #or others depending on value of $ban->reason ?
2003 return '_duplicate_ach' unless $self->override_ban_warn;
2005 return 'Banned ACH account: banned on '.
2006 time2str('%a %h %o at %r', $ban->_date).
2007 ' by '. $ban->otaker.
2008 ' (ban# '. $ban->bannum. ')';
2013 } elsif ( $self->payby eq 'LECB' ) {
2015 my $payinfo = $self->payinfo;
2016 $payinfo =~ s/\D//g;
2017 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2019 $self->payinfo($payinfo);
2022 } elsif ( $self->payby eq 'BILL' ) {
2024 $error = $self->ut_textn('payinfo');
2025 return "Illegal P.O. number: ". $self->payinfo if $error;
2028 } elsif ( $self->payby eq 'COMP' ) {
2030 my $curuser = $FS::CurrentUser::CurrentUser;
2031 if ( ! $self->custnum
2032 && ! $curuser->access_right('Complimentary customer')
2035 return "You are not permitted to create complimentary accounts."
2038 $error = $self->ut_textn('payinfo');
2039 return "Illegal comp account issuer: ". $self->payinfo if $error;
2042 } elsif ( $self->payby eq 'PREPAY' ) {
2044 my $payinfo = $self->payinfo;
2045 $payinfo =~ s/\W//g; #anything else would just confuse things
2046 $self->payinfo($payinfo);
2047 $error = $self->ut_alpha('payinfo');
2048 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2049 return "Unknown prepayment identifier"
2050 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2055 return "You are not permitted to create complimentary accounts."
2057 && $self->complimentary eq 'Y'
2058 && ! $FS::CurrentUser::CurrentUser->access_right('Complimentary customer');
2060 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2061 return "Expiration date required"
2062 # shouldn't payinfo_check do this?
2063 unless ! $self->payby
2064 || $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2068 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2069 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2070 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2071 ( $m, $y ) = ( $2, "19$1" );
2072 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2073 ( $m, $y ) = ( $3, "20$2" );
2075 return "Illegal expiration date: ". $self->paydate;
2077 $m = sprintf('%02d',$m);
2078 $self->paydate("$y-$m-01");
2079 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2080 return gettext('expired_card')
2082 && !$ignore_expired_card
2083 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2086 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2087 ( ! $conf->exists('require_cardname')
2088 || $self->payby !~ /^(CARD|DCRD)$/ )
2090 $self->payname( $self->first. " ". $self->getfield('last') );
2093 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2094 $self->payname =~ /^([\w \,\.\-\']*)$/
2095 or return gettext('illegal_name'). " payname: ". $self->payname;
2098 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2099 or return gettext('illegal_name'). " payname: ". $self->payname;
2105 ### end of stuff moved to cust_payby
2107 return "Please select an invoicing locale"
2110 && $conf->exists('cust_main-require_locale');
2112 return "Please select a customer class"
2113 if ! $self->classnum
2114 && $conf->exists('cust_main-require_classnum');
2116 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2117 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2121 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2123 warn "$me check AFTER: \n". $self->_dump
2126 $self->SUPER::check;
2129 sub check_payinfo_cardtype {
2132 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
2134 my $payinfo = $self->payinfo;
2135 $payinfo =~ s/\D//g;
2137 return '' if $self->tokenized($payinfo); #token
2139 my %bop_card_types = map { $_=>1 } values %{ card_types() };
2140 my $cardtype = cardtype($payinfo);
2142 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
2150 Additional checks for replace only.
2155 my ($new,$old) = @_;
2156 #preserve old value if global config is set
2157 if ($old && $conf->exists('invoice-ship_address')) {
2158 $new->invoice_ship_address($old->invoice_ship_address);
2165 Returns a list of fields which have ship_ duplicates.
2170 qw( last first company
2172 address1 address2 city county state zip country
2174 daytime night fax mobile
2178 =item has_ship_address
2180 Returns true if this customer record has a separate shipping address.
2184 sub has_ship_address {
2186 $self->bill_locationnum != $self->ship_locationnum;
2191 Returns a list of key/value pairs, with the following keys: address1,
2192 adddress2, city, county, state, zip, country, district, and geocode. The
2193 shipping address is used if present.
2199 $self->ship_location->location_hash;
2204 Returns all locations (see L<FS::cust_location>) for this customer.
2211 'table' => 'cust_location',
2212 'hashref' => { 'custnum' => $self->custnum,
2213 'prospectnum' => '',
2215 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
2221 Returns all contact associations (see L<FS::cust_contact>) for this customer.
2227 qsearch('cust_contact', { 'custnum' => $self->custnum } );
2230 =item cust_payby PAYBY
2232 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2234 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
2235 Does not validate PAYBY.
2243 'table' => 'cust_payby',
2244 'hashref' => { 'custnum' => $self->custnum },
2245 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
2247 $search->{'extra_sql'} = ' AND payby IN ( '.
2248 join(',', map dbh->quote($_), @payby).
2255 =item has_cust_payby_auto
2257 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2261 sub has_cust_payby_auto {
2264 'table' => 'cust_payby',
2265 'hashref' => { 'custnum' => $self->custnum, },
2266 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2267 'order_by' => 'LIMIT 1',
2274 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2275 and L<FS::cust_pkg>) for this customer, except those on hold.
2277 Returns a list: an empty list on success or a list of errors.
2283 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs(@_);
2288 Unsuspends all suspended packages in the on-hold state (those without setup
2289 dates) for this customer.
2295 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2300 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2302 Returns a list: an empty list on success or a list of errors.
2307 my($self, %opt) = @_;
2309 my @pkgs = $self->unsuspended_pkgs;
2311 @pkgs = grep { ! $_->get('start_date') } @pkgs
2312 if $opt{skip_future_startdate};
2314 grep { $_->suspend(%opt) } @pkgs;
2317 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2319 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2320 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2321 of a list of pkgparts; the hashref has the following keys:
2325 =item pkgparts - listref of pkgparts
2327 =item (other options are passed to the suspend method)
2332 Returns a list: an empty list on success or a list of errors.
2336 sub suspend_if_pkgpart {
2338 my (@pkgparts, %opt);
2339 if (ref($_[0]) eq 'HASH'){
2340 @pkgparts = @{$_[0]{pkgparts}};
2345 grep { $_->suspend(%opt) }
2346 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2347 $self->unsuspended_pkgs;
2350 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2352 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2353 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2354 instead of a list of pkgparts; the hashref has the following keys:
2358 =item pkgparts - listref of pkgparts
2360 =item (other options are passed to the suspend method)
2364 Returns a list: an empty list on success or a list of errors.
2368 sub suspend_unless_pkgpart {
2370 my (@pkgparts, %opt);
2371 if (ref($_[0]) eq 'HASH'){
2372 @pkgparts = @{$_[0]{pkgparts}};
2377 grep { $_->suspend(%opt) }
2378 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2379 $self->unsuspended_pkgs;
2382 =item cancel [ OPTION => VALUE ... ]
2384 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2385 The cancellation time will be now.
2389 Always returns a list: an empty list on success or a list of errors.
2396 warn "$me cancel called on customer ". $self->custnum. " with options ".
2397 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2399 my @pkgs = $self->ncancelled_pkgs;
2401 $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2404 =item cancel_pkgs OPTIONS
2406 Cancels a specified list of packages. OPTIONS can include:
2410 =item cust_pkg - an arrayref of the packages. Required.
2412 =item time - the cancellation time, used to calculate final bills and
2413 unused-time credits if any. Will be passed through to the bill() and
2414 FS::cust_pkg::cancel() methods.
2416 =item quiet - can be set true to supress email cancellation notices.
2418 =item reason - can be set to a cancellation reason (see L<FS::reason>), either a
2419 reasonnum of an existing reason, or passing a hashref will create a new reason.
2420 The hashref should have the following keys:
2421 typenum - Reason type (see L<FS::reason_type>)
2422 reason - Text of the new reason.
2424 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2425 for the individual packages, parallel to the C<cust_pkg> argument. The
2426 reason and reason_otaker arguments will be taken from those objects.
2428 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2430 =item nobill - can be set true to skip billing if it might otherwise be done.
2435 my( $self, %opt ) = @_;
2437 # we're going to cancel services, which is not reversible
2438 # unless exports are suppressed
2439 die "cancel_pkgs cannot be run inside a transaction"
2440 if !$FS::UID::AutoCommit && !$FS::svc_Common::noexport_hack;
2442 my $oldAutoCommit = $FS::UID::AutoCommit;
2443 local $FS::UID::AutoCommit = 0;
2445 savepoint_create('cancel_pkgs');
2447 return ( 'access denied' )
2448 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2450 if ( $opt{'ban'} ) {
2452 foreach my $cust_payby ( $self->cust_payby ) {
2454 #well, if they didn't get decrypted on search, then we don't have to
2455 # try again... queue a job for the server that does have decryption
2456 # capability if we're in a paranoid multi-server implementation?
2457 return ( "Can't (yet) ban encrypted credit cards" )
2458 if $cust_payby->is_encrypted($cust_payby->payinfo);
2460 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2461 my $error = $ban->insert;
2463 savepoint_rollback_and_release('cancel_pkgs');
2464 dbh->rollback if $oldAutoCommit;
2472 my @pkgs = @{ delete $opt{'cust_pkg'} };
2473 my $cancel_time = $opt{'time'} || time;
2475 # bill all packages first, so we don't lose usage, service counts for
2476 # bulk billing, etc.
2477 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2479 my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2481 'time' => $cancel_time );
2483 warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2484 savepoint_rollback_and_release('cancel_pkgs');
2485 dbh->rollback if $oldAutoCommit;
2486 return ( "Error billing during cancellation: $error" );
2489 savepoint_release('cancel_pkgs');
2490 dbh->commit if $oldAutoCommit;
2493 # now cancel all services, the same way we would for individual packages.
2494 # if any of them fail, cancel the rest anyway.
2495 my @cust_svc = map { $_->cust_svc } @pkgs;
2496 my @sorted_cust_svc =
2498 sort { $a->[1] <=> $b->[1] }
2499 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2501 warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2505 foreach my $cust_svc (@sorted_cust_svc) {
2506 my $savepoint = 'cancel_pkgs_'.$i++;
2507 savepoint_create( $savepoint );
2508 my $part_svc = $cust_svc->part_svc;
2509 next if ( defined($part_svc) and $part_svc->preserve );
2510 # immediate cancel, no date option
2511 # transactionize individually
2512 my $error = try { $cust_svc->cancel } catch { $_ };
2514 savepoint_rollback_and_release( $savepoint );
2515 dbh->rollback if $oldAutoCommit;
2516 push @errors, $error;
2518 savepoint_release( $savepoint );
2519 dbh->commit if $oldAutoCommit;
2526 warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2527 $self->custnum. "\n"
2531 if ($opt{'cust_pkg_reason'}) {
2532 @cprs = @{ delete $opt{'cust_pkg_reason'} };
2538 my $savepoint = 'cancel_pkgs_'.$i++;
2539 savepoint_create( $savepoint );
2541 my $cpr = shift @cprs;
2543 $lopt{'reason'} = $cpr->reasonnum;
2544 $lopt{'reason_otaker'} = $cpr->otaker;
2546 warn "no reason found when canceling package ".$_->pkgnum."\n";
2547 # we're not actually required to pass a reason to cust_pkg::cancel,
2548 # but if we're getting to this point, something has gone awry.
2549 $null_reason ||= FS::reason->new_or_existing(
2550 reason => 'unknown reason',
2551 type => 'Cancel Reason',
2554 $lopt{'reason'} = $null_reason->reasonnum;
2555 $lopt{'reason_otaker'} = $FS::CurrentUser::CurrentUser->username;
2558 my $error = $_->cancel(%lopt);
2560 savepoint_rollback_and_release( $savepoint );
2561 dbh->rollback if $oldAutoCommit;
2562 push @errors, 'pkgnum '.$_->pkgnum.': '.$error;
2564 savepoint_release( $savepoint );
2565 dbh->commit if $oldAutoCommit;
2572 sub _banned_pay_hashref {
2583 'payby' => $payby2ban{$self->payby},
2584 'payinfo' => $self->payinfo,
2585 #don't ever *search* on reason! #'reason' =>
2591 Returns all notes (see L<FS::cust_main_note>) for this customer.
2596 my($self,$orderby_classnum) = (shift,shift);
2597 my $orderby = "sticky DESC, _date DESC";
2598 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2599 qsearch( 'cust_main_note',
2600 { 'custnum' => $self->custnum },
2602 "ORDER BY $orderby",
2608 Returns the agent (see L<FS::agent>) for this customer.
2612 Returns the agent name (see L<FS::agent>) for this customer.
2618 $self->agent->agent;
2623 Returns any tags associated with this customer, as FS::cust_tag objects,
2624 or an empty list if there are no tags.
2628 Returns any tags associated with this customer, as FS::part_tag objects,
2629 or an empty list if there are no tags.
2635 map $_->part_tag, $self->cust_tag;
2641 Returns the customer class, as an FS::cust_class object, or the empty string
2642 if there is no customer class.
2646 Returns the customer category name, or the empty string if there is no customer
2653 my $cust_class = $self->cust_class;
2655 ? $cust_class->categoryname
2661 Returns the customer class name, or the empty string if there is no customer
2668 my $cust_class = $self->cust_class;
2670 ? $cust_class->classname
2676 Returns the external tax status, as an FS::tax_status object, or the empty
2677 string if there is no tax status.
2683 if ( $self->taxstatusnum ) {
2684 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2692 Returns the tax status code if there is one.
2698 my $tax_status = $self->tax_status;
2700 ? $tax_status->taxstatus
2704 =item BILLING METHODS
2706 Documentation on billing methods has been moved to
2707 L<FS::cust_main::Billing>.
2709 =item REALTIME BILLING METHODS
2711 Documentation on realtime billing methods has been moved to
2712 L<FS::cust_main::Billing_Realtime>.
2716 Removes the I<paycvv> field from the database directly.
2718 If there is an error, returns the error, otherwise returns false.
2720 DEPRECATED. Use L</remove_cvv_from_cust_payby> instead.
2726 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2727 or return dbh->errstr;
2728 $sth->execute($self->custnum)
2729 or return $sth->errstr;
2736 Returns the total owed for this customer on all invoices
2737 (see L<FS::cust_bill/owed>).
2743 $self->total_owed_date(2145859200); #12/31/2037
2746 =item total_owed_date TIME
2748 Returns the total owed for this customer on all invoices with date earlier than
2749 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2750 see L<Time::Local> and L<Date::Parse> for conversion functions.
2754 sub total_owed_date {
2758 my $custnum = $self->custnum;
2760 my $owed_sql = FS::cust_bill->owed_sql;
2763 SELECT SUM($owed_sql) FROM cust_bill
2764 WHERE custnum = $custnum
2768 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2772 =item total_owed_pkgnum PKGNUM
2774 Returns the total owed on all invoices for this customer's specific package
2775 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2779 sub total_owed_pkgnum {
2780 my( $self, $pkgnum ) = @_;
2781 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2784 =item total_owed_date_pkgnum TIME PKGNUM
2786 Returns the total owed for this customer's specific package when using
2787 experimental package balances on all invoices with date earlier than
2788 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2789 see L<Time::Local> and L<Date::Parse> for conversion functions.
2793 sub total_owed_date_pkgnum {
2794 my( $self, $time, $pkgnum ) = @_;
2797 foreach my $cust_bill (
2798 grep { $_->_date <= $time }
2799 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2801 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2803 sprintf( "%.2f", $total_bill );
2809 Returns the total amount of all payments.
2816 $total += $_->paid foreach $self->cust_pay;
2817 sprintf( "%.2f", $total );
2820 =item total_unapplied_credits
2822 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2823 customer. See L<FS::cust_credit/credited>.
2825 =item total_credited
2827 Old name for total_unapplied_credits. Don't use.
2831 sub total_credited {
2832 #carp "total_credited deprecated, use total_unapplied_credits";
2833 shift->total_unapplied_credits(@_);
2836 sub total_unapplied_credits {
2839 my $custnum = $self->custnum;
2841 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2844 SELECT SUM($unapplied_sql) FROM cust_credit
2845 WHERE custnum = $custnum
2848 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2852 =item total_unapplied_credits_pkgnum PKGNUM
2854 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2855 customer. See L<FS::cust_credit/credited>.
2859 sub total_unapplied_credits_pkgnum {
2860 my( $self, $pkgnum ) = @_;
2861 my $total_credit = 0;
2862 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2863 sprintf( "%.2f", $total_credit );
2867 =item total_unapplied_payments
2869 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2870 See L<FS::cust_pay/unapplied>.
2874 sub total_unapplied_payments {
2877 my $custnum = $self->custnum;
2879 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2882 SELECT SUM($unapplied_sql) FROM cust_pay
2883 WHERE custnum = $custnum
2886 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2890 =item total_unapplied_payments_pkgnum PKGNUM
2892 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2893 specific package when using experimental package balances. See
2894 L<FS::cust_pay/unapplied>.
2898 sub total_unapplied_payments_pkgnum {
2899 my( $self, $pkgnum ) = @_;
2900 my $total_unapplied = 0;
2901 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2902 sprintf( "%.2f", $total_unapplied );
2906 =item total_unapplied_refunds
2908 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2909 customer. See L<FS::cust_refund/unapplied>.
2913 sub total_unapplied_refunds {
2915 my $custnum = $self->custnum;
2917 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2920 SELECT SUM($unapplied_sql) FROM cust_refund
2921 WHERE custnum = $custnum
2924 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2930 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2931 total_unapplied_credits minus total_unapplied_payments).
2937 $self->balance_date_range;
2940 =item balance_date TIME
2942 Returns the balance for this customer, only considering invoices with date
2943 earlier than TIME (total_owed_date minus total_credited minus
2944 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2945 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2952 $self->balance_date_range(shift);
2955 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2957 Returns the balance for this customer, optionally considering invoices with
2958 date earlier than START_TIME, and not later than END_TIME
2959 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2961 Times are specified as SQL fragments or numeric
2962 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2963 L<Date::Parse> for conversion functions. The empty string can be passed
2964 to disable that time constraint completely.
2966 Accepts the same options as L</balance_date_sql>:
2970 =item unapplied_date
2972 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)
2976 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2977 time will be ignored. Note that START_TIME and END_TIME only limit the date
2978 range for invoices and I<unapplied> payments, credits, and refunds.
2984 sub balance_date_range {
2986 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2987 ') FROM cust_main WHERE custnum='. $self->custnum;
2988 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2991 =item balance_pkgnum PKGNUM
2993 Returns the balance for this customer's specific package when using
2994 experimental package balances (total_owed plus total_unrefunded, minus
2995 total_unapplied_credits minus total_unapplied_payments)
2999 sub balance_pkgnum {
3000 my( $self, $pkgnum ) = @_;
3003 $self->total_owed_pkgnum($pkgnum)
3004 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
3005 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
3006 - $self->total_unapplied_credits_pkgnum($pkgnum)
3007 - $self->total_unapplied_payments_pkgnum($pkgnum)
3013 Returns a hash of useful information for making a payment.
3023 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
3024 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
3025 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
3029 For credit card transactions:
3041 For electronic check transactions:
3056 $return{balance} = $self->balance;
3058 $return{payname} = $self->payname
3059 || ( $self->first. ' '. $self->get('last') );
3061 $return{$_} = $self->bill_location->$_
3062 for qw(address1 address2 city state zip);
3064 $return{payby} = $self->payby;
3065 $return{stateid_state} = $self->stateid_state;
3067 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
3068 $return{card_type} = cardtype($self->payinfo);
3069 $return{payinfo} = $self->paymask;
3071 @return{'month', 'year'} = $self->paydate_monthyear;
3075 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
3076 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
3077 $return{payinfo1} = $payinfo1;
3078 $return{payinfo2} = $payinfo2;
3079 $return{paytype} = $self->paytype;
3080 $return{paystate} = $self->paystate;
3084 #doubleclick protection
3086 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3094 Returns the next payment expiration date for this customer. If they have no
3095 payment methods that will expire, returns 0.
3101 # filter out the ones that individually return 0, but then return 0 if
3102 # there are no results
3103 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
3104 min( @epochs ) || 0;
3107 =item paydate_epoch_sql
3109 Returns an SQL expression to get the next payment expiration date for a
3110 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
3111 dates, so that it's safe to test for "will it expire before date X" for any
3116 sub paydate_epoch_sql {
3118 my $paydate = FS::cust_payby->paydate_epoch_sql;
3119 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
3123 my( $self, $taxname ) = @_;
3125 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3126 'taxname' => $taxname,
3131 =item cust_main_exemption
3133 =item invoicing_list
3135 Returns a list of email addresses (with svcnum entries expanded), and the word
3136 'POST' if the customer receives postal invoices.
3140 sub invoicing_list {
3141 my( $self, $arrayref ) = @_;
3144 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
3147 my @emails = $self->invoicing_list_emailonly;
3148 push @emails, 'POST' if $self->get('postal_invoice');
3153 =item check_invoicing_list ARRAYREF
3155 Checks these arguements as valid input for the invoicing_list method. If there
3156 is an error, returns the error, otherwise returns false.
3160 sub check_invoicing_list {
3161 my( $self, $arrayref ) = @_;
3163 foreach my $address ( @$arrayref ) {
3165 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3166 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3169 my $cust_main_invoice = new FS::cust_main_invoice ( {
3170 'custnum' => $self->custnum,
3173 my $error = $self->custnum
3174 ? $cust_main_invoice->check
3175 : $cust_main_invoice->checkdest
3177 return $error if $error;
3181 return "Email address required"
3182 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3183 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3190 Returns the email addresses of all accounts provisioned for this customer.
3197 foreach my $cust_pkg ( $self->all_pkgs ) {
3198 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3200 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3201 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3203 $list{$_}=1 foreach map { $_->email } @svc_acct;
3208 =item invoicing_list_addpost
3210 Adds postal invoicing to this customer. If this customer is already configured
3211 to receive postal invoices, does nothing.
3215 sub invoicing_list_addpost {
3217 if ( $self->get('postal_invoice') eq '' ) {
3218 $self->set('postal_invoice', 'Y');
3219 my $error = $self->replace;
3220 warn $error if $error; # should fail harder, but this is traditional
3224 =item invoicing_list_emailonly
3226 Returns the list of email invoice recipients (invoicing_list without non-email
3227 destinations such as POST and FAX).
3231 sub invoicing_list_emailonly {
3233 warn "$me invoicing_list_emailonly called"
3235 return () if !$self->custnum; # not yet inserted
3236 return map { $_->emailaddress }
3238 table => 'cust_contact',
3239 select => 'emailaddress',
3240 addl_from => ' JOIN contact USING (contactnum) '.
3241 ' JOIN contact_email USING (contactnum)',
3242 hashref => { 'custnum' => $self->custnum, },
3243 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
3247 =item invoicing_list_emailonly_scalar
3249 Returns the list of email invoice recipients (invoicing_list without non-email
3250 destinations such as POST and FAX) as a comma-separated scalar.
3254 sub invoicing_list_emailonly_scalar {
3256 warn "$me invoicing_list_emailonly_scalar called"
3258 join(', ', $self->invoicing_list_emailonly);
3261 =item contact_list [ CLASSNUM, DEST_FLAG... ]
3263 Returns a list of contacts (L<FS::contact> objects) for the customer.
3265 If no arguments are given, returns all contacts for the customer.
3267 Arguments may contain classnums. When classnums are specified, only
3268 contacts with a matching cust_contact.classnum are returned. When a
3269 classnum of 0 is given, contacts with a null classnum are also included.
3271 Arguments may also contain the dest flag names 'invoice' or 'message'.
3272 If given, contacts who's invoice_dest and/or message_dest flags are
3273 not set to 'Y' will be excluded.
3281 select => join(', ',(
3283 'cust_contact.invoice_dest',
3284 'cust_contact.message_dest',
3286 addl_from => ' JOIN cust_contact USING (contactnum)',
3287 extra_sql => ' WHERE cust_contact.custnum = '.$self->custnum,
3291 # Calling methods were relying on this method to use invoice_dest to
3292 # block e-mail messages. Depending on parameters, this may or may not
3293 # have actually happened.
3295 # The bug could cause this SQL to be used to filter e-mail addresses:
3298 # cust_contact.classnums IN (1,2,3)
3299 # OR cust_contact.invoice_dest = 'Y'
3302 # improperly including everybody with the opt-in flag AND everybody
3303 # in the contact classes
3305 # Possibility to introduce new bugs:
3306 # If callers of this method called it incorrectly, and didn't notice
3307 # because it seemed to send the e-mails they wanted.
3312 # cust_contact.classnum IN (1,2,3)
3314 # cust_contact.classnum IS NULL
3317 # cust_contact.invoice_dest = 'Y'
3319 # cust_contact.message_dest = 'Y'
3327 if ($_ eq 'invoice' || $_ eq 'message') {
3328 push @and_dest, " cust_contact.${_}_dest = 'Y' ";
3329 } elsif ($_ eq '0') {
3330 push @or_classnum, ' cust_contact.classnum IS NULL ';
3331 } elsif ( /^\d+$/ ) {
3332 push @classnums, $_;
3334 croak "bad classnum argument '$_'";
3338 push @or_classnum, 'cust_contact.classnum IN ('.join(',',@classnums).')'
3341 if (@or_classnum || @and_dest) { # catch, no arguments given
3342 $search->{extra_sql} .= ' AND ( ';
3345 $search->{extra_sql} .= ' ( ';
3346 $search->{extra_sql} .= join ' OR ', map {" $_ "} @or_classnum;
3347 $search->{extra_sql} .= ' ) ';
3348 $search->{extra_sql} .= ' AND ( ' if @and_dest;
3352 $search->{extra_sql} .= join ' OR ', map {" $_ "} @and_dest;
3353 $search->{extra_sql} .= ' ) ' if @or_classnum;
3356 $search->{extra_sql} .= ' ) ';
3358 warn "\$extra_sql: $search->{extra_sql} \n" if $DEBUG;
3364 =item contact_list_email [ CLASSNUM, ... ]
3366 Same as L</contact_list>, but returns email destinations instead of contact
3371 sub contact_list_email {
3373 my @contacts = $self->contact_list(@_);
3375 foreach my $contact (@contacts) {
3376 foreach my $contact_email ($contact->contact_email) {
3377 push @emails, Email::Address->new( $contact->firstlast,
3378 $contact_email->emailaddress
3385 =item contact_list_name_phones
3387 Returns a list of contact phone numbers.
3388 { phonetypenum => '1', phonenum => 'xxxxxxxxxx', first => 'firstname', last => 'lastname', countrycode => '1' }
3392 sub contact_list_name_phones {
3394 my $phone_type = shift;
3396 warn "$me contact_list_phones" if $DEBUG;
3398 return () if !$self->custnum; # not yet inserted
3401 table => 'cust_contact',
3402 select => 'phonetypenum, phonenum, first, last, countrycode',
3403 addl_from => ' JOIN contact USING (contactnum) '.
3404 ' JOIN contact_phone USING (contactnum)',
3405 hashref => { 'custnum' => $self->custnum, 'phonetypenum' => $phone_type, },
3406 order_by => 'ORDER BY custcontactnum DESC',
3411 =item referral_custnum_cust_main
3413 Returns the customer who referred this customer (or the empty string, if
3414 this customer was not referred).
3416 Note the difference with referral_cust_main method: This method,
3417 referral_custnum_cust_main returns the single customer (if any) who referred
3418 this customer, while referral_cust_main returns an array of customers referred
3423 sub referral_custnum_cust_main {
3425 return '' unless $self->referral_custnum;
3426 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3429 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3431 Returns an array of customers referred by this customer (referral_custnum set
3432 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3433 customers referred by customers referred by this customer and so on, inclusive.
3434 The default behavior is DEPTH 1 (no recursion).
3436 Note the difference with referral_custnum_cust_main method: This method,
3437 referral_cust_main, returns an array of customers referred BY this customer,
3438 while referral_custnum_cust_main returns the single customer (if any) who
3439 referred this customer.
3443 sub referral_cust_main {
3445 my $depth = @_ ? shift : 1;
3446 my $exclude = @_ ? shift : {};
3449 map { $exclude->{$_->custnum}++; $_; }
3450 grep { ! $exclude->{ $_->custnum } }
3451 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3455 map { $_->referral_cust_main($depth-1, $exclude) }
3462 =item referral_cust_main_ncancelled
3464 Same as referral_cust_main, except only returns customers with uncancelled
3469 sub referral_cust_main_ncancelled {
3471 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3474 =item referral_cust_pkg [ DEPTH ]
3476 Like referral_cust_main, except returns a flat list of all unsuspended (and
3477 uncancelled) packages for each customer. The number of items in this list may
3478 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3482 sub referral_cust_pkg {
3484 my $depth = @_ ? shift : 1;
3486 map { $_->unsuspended_pkgs }
3487 grep { $_->unsuspended_pkgs }
3488 $self->referral_cust_main($depth);
3491 =item referring_cust_main
3493 Returns the single cust_main record for the customer who referred this customer
3494 (referral_custnum), or false.
3498 sub referring_cust_main {
3500 return '' unless $self->referral_custnum;
3501 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3504 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3506 Applies a credit to this customer. If there is an error, returns the error,
3507 otherwise returns false.
3509 REASON can be a text string, an FS::reason object, or a scalar reference to
3510 a reasonnum. If a text string, it will be automatically inserted as a new
3511 reason, and a 'reason_type' option must be passed to indicate the
3512 FS::reason_type for the new reason.
3514 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3515 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3516 I<commission_pkgnum>.
3518 Any other options are passed to FS::cust_credit::insert.
3523 my( $self, $amount, $reason, %options ) = @_;
3525 my $cust_credit = new FS::cust_credit {
3526 'custnum' => $self->custnum,
3527 'amount' => $amount,
3530 if ( ref($reason) ) {
3532 if ( ref($reason) eq 'SCALAR' ) {
3533 $cust_credit->reasonnum( $$reason );
3535 $cust_credit->reasonnum( $reason->reasonnum );
3539 $cust_credit->set('reason', $reason)
3542 $cust_credit->$_( delete $options{$_} )
3543 foreach grep exists($options{$_}),
3544 qw( addlinfo eventnum ),
3545 map "commission_$_", qw( agentnum salesnum pkgnum );
3547 $cust_credit->insert(%options);
3551 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3553 Creates a one-time charge for this customer. If there is an error, returns
3554 the error, otherwise returns false.
3556 New-style, with a hashref of options:
3558 my $error = $cust_main->charge(
3562 'start_date' => str2time('7/4/2009'),
3563 'pkg' => 'Description',
3564 'comment' => 'Comment',
3565 'additional' => [], #extra invoice detail
3566 'classnum' => 1, #pkg_class
3568 'setuptax' => '', # or 'Y' for tax exempt
3570 'locationnum'=> 1234, # optional
3573 'taxclass' => 'Tax class',
3576 'taxproduct' => 2, #part_pkg_taxproduct
3577 'override' => {}, #XXX describe
3579 #will be filled in with the new object
3580 'cust_pkg_ref' => \$cust_pkg,
3582 #generate an invoice immediately
3584 'invoice_terms' => '', #with these terms
3590 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3594 #super false laziness w/quotation::charge
3597 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3598 my ( $pkg, $comment, $additional );
3599 my ( $setuptax, $taxclass ); #internal taxes
3600 my ( $taxproduct, $override ); #vendor (CCH) taxes
3602 my $separate_bill = '';
3603 my $cust_pkg_ref = '';
3604 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3606 my ( $discountnum, $discountnum_amount, $discountnum_percent ) = ( '','','' );
3607 if ( ref( $_[0] ) ) {
3608 $amount = $_[0]->{amount};
3609 $setup_cost = $_[0]->{setup_cost};
3610 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3611 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3612 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3613 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3614 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3615 : '$'. sprintf("%.2f",$amount);
3616 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3617 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3618 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3619 $additional = $_[0]->{additional} || [];
3620 $taxproduct = $_[0]->{taxproductnum};
3621 $override = { '' => $_[0]->{tax_override} };
3622 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3623 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3624 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3625 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3626 $separate_bill = $_[0]->{separate_bill} || '';
3627 $discountnum = $_[0]->{setup_discountnum};
3628 $discountnum_amount = $_[0]->{setup_discountnum_amount};
3629 $discountnum_percent = $_[0]->{setup_discountnum_percent};
3635 $pkg = @_ ? shift : 'One-time charge';
3636 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3638 $taxclass = @_ ? shift : '';
3642 local $SIG{HUP} = 'IGNORE';
3643 local $SIG{INT} = 'IGNORE';
3644 local $SIG{QUIT} = 'IGNORE';
3645 local $SIG{TERM} = 'IGNORE';
3646 local $SIG{TSTP} = 'IGNORE';
3647 local $SIG{PIPE} = 'IGNORE';
3649 my $oldAutoCommit = $FS::UID::AutoCommit;
3650 local $FS::UID::AutoCommit = 0;
3653 my $part_pkg = new FS::part_pkg ( {
3655 'comment' => $comment,
3659 'classnum' => ( $classnum ? $classnum : '' ),
3660 'setuptax' => $setuptax,
3661 'taxclass' => $taxclass,
3662 'taxproductnum' => $taxproduct,
3663 'setup_cost' => $setup_cost,
3666 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3667 ( 0 .. @$additional - 1 )
3669 'additional_count' => scalar(@$additional),
3670 'setup_fee' => $amount,
3673 my $error = $part_pkg->insert( options => \%options,
3674 tax_overrides => $override,
3677 $dbh->rollback if $oldAutoCommit;
3681 my $pkgpart = $part_pkg->pkgpart;
3682 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3683 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3684 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3685 $error = $type_pkgs->insert;
3687 $dbh->rollback if $oldAutoCommit;
3692 my $cust_pkg = new FS::cust_pkg ( {
3693 'custnum' => $self->custnum,
3694 'pkgpart' => $pkgpart,
3695 'quantity' => $quantity,
3696 'start_date' => $start_date,
3697 'no_auto' => $no_auto,
3698 'separate_bill' => $separate_bill,
3699 'locationnum' => $locationnum,
3700 'setup_discountnum' => $discountnum,
3701 'setup_discountnum_amount' => $discountnum_amount,
3702 'setup_discountnum_percent' => $discountnum_percent,
3705 $error = $cust_pkg->insert;
3707 $dbh->rollback if $oldAutoCommit;
3709 } elsif ( $cust_pkg_ref ) {
3710 ${$cust_pkg_ref} = $cust_pkg;
3714 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3715 'pkg_list' => [ $cust_pkg ],
3718 $dbh->rollback if $oldAutoCommit;
3723 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3728 #=item charge_postal_fee
3730 #Applies a one time charge this customer. If there is an error,
3731 #returns the error, returns the cust_pkg charge object or false
3732 #if there was no charge.
3736 # This should be a customer event. For that to work requires that bill
3737 # also be a customer event.
3739 sub charge_postal_fee {
3742 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3743 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3745 my $cust_pkg = new FS::cust_pkg ( {
3746 'custnum' => $self->custnum,
3747 'pkgpart' => $pkgpart,
3751 my $error = $cust_pkg->insert;
3752 $error ? $error : $cust_pkg;
3755 =item num_cust_attachment_deleted
3757 Returns the number of deleted attachments for this customer (see
3758 L<FS::num_cust_attachment>).
3762 sub num_cust_attachments_deleted {
3765 " SELECT COUNT(*) FROM cust_attachment ".
3766 " WHERE custnum = ? AND disabled IS NOT NULL AND disabled > 0",
3773 Returns the most recent invnum (invoice number) for this customer.
3780 " SELECT MAX(invnum) FROM cust_bill WHERE custnum = ?",
3785 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3787 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3789 Optionally, a list or hashref of additional arguments to the qsearch call can
3796 my $opt = ref($_[0]) ? shift : { @_ };
3798 #return $self->num_cust_bill unless wantarray || keys %$opt;
3800 $opt->{'table'} = 'cust_bill';
3801 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3802 $opt->{'hashref'}{'custnum'} = $self->custnum;
3803 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3805 map { $_ } #behavior of sort undefined in scalar context
3806 sort { $a->_date <=> $b->_date }
3810 =item open_cust_bill
3812 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3817 sub open_cust_bill {
3821 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3827 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3829 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3833 sub legacy_cust_bill {
3836 #return $self->num_legacy_cust_bill unless wantarray;
3838 map { $_ } #behavior of sort undefined in scalar context
3839 sort { $a->_date <=> $b->_date }
3840 qsearch({ 'table' => 'legacy_cust_bill',
3841 'hashref' => { 'custnum' => $self->custnum, },
3842 'order_by' => 'ORDER BY _date ASC',
3846 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3848 Returns all the statements (see L<FS::cust_statement>) for this customer.
3850 Optionally, a list or hashref of additional arguments to the qsearch call can
3855 =item cust_bill_void
3857 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3861 sub cust_bill_void {
3864 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3865 sort { $a->_date <=> $b->_date }
3866 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3869 sub cust_statement {
3871 my $opt = ref($_[0]) ? shift : { @_ };
3873 #return $self->num_cust_statement unless wantarray || keys %$opt;
3875 $opt->{'table'} = 'cust_statement';
3876 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3877 $opt->{'hashref'}{'custnum'} = $self->custnum;
3878 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3880 map { $_ } #behavior of sort undefined in scalar context
3881 sort { $a->_date <=> $b->_date }
3885 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3887 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3889 Optionally, a list or hashref of additional arguments to the qsearch call can
3890 be passed following the SVCDB.
3897 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3898 warn "$me svc_x requires a svcdb";
3901 my $opt = ref($_[0]) ? shift : { @_ };
3903 $opt->{'table'} = $svcdb;
3904 $opt->{'addl_from'} =
3905 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3906 ($opt->{'addl_from'} || '');
3908 my $custnum = $self->custnum;
3909 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3910 my $where = "cust_pkg.custnum = $custnum";
3912 my $extra_sql = $opt->{'extra_sql'} || '';
3913 if ( keys %{ $opt->{'hashref'} } ) {
3914 $extra_sql = " AND $where $extra_sql";
3917 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3918 $extra_sql = "WHERE $where AND $1";
3921 $extra_sql = "WHERE $where $extra_sql";
3924 $opt->{'extra_sql'} = $extra_sql;
3929 # required for use as an eventtable;
3932 $self->svc_x('svc_acct', @_);
3937 Returns all the credits (see L<FS::cust_credit>) for this customer.
3944 #return $self->num_cust_credit unless wantarray;
3946 map { $_ } #behavior of sort undefined in scalar context
3947 sort { $a->_date <=> $b->_date }
3948 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3951 =item cust_credit_pkgnum
3953 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3954 package when using experimental package balances.
3958 sub cust_credit_pkgnum {
3959 my( $self, $pkgnum ) = @_;
3960 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3961 sort { $a->_date <=> $b->_date }
3962 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3963 'pkgnum' => $pkgnum,
3968 =item cust_credit_void
3970 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3974 sub cust_credit_void {
3977 sort { $a->_date <=> $b->_date }
3978 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3983 Returns all the payments (see L<FS::cust_pay>) for this customer.
3989 my $opt = ref($_[0]) ? shift : { @_ };
3991 return $self->num_cust_pay unless wantarray || keys %$opt;
3993 $opt->{'table'} = 'cust_pay';
3994 $opt->{'hashref'}{'custnum'} = $self->custnum;
3996 map { $_ } #behavior of sort undefined in scalar context
3997 sort { $a->_date <=> $b->_date }
4004 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
4005 called automatically when the cust_pay method is used in a scalar context.
4011 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
4012 my $sth = dbh->prepare($sql) or die dbh->errstr;
4013 $sth->execute($self->custnum) or die $sth->errstr;
4014 $sth->fetchrow_arrayref->[0];
4017 =item unapplied_cust_pay
4019 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
4023 sub unapplied_cust_pay {
4027 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
4033 =item cust_pay_pkgnum
4035 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
4036 package when using experimental package balances.
4040 sub cust_pay_pkgnum {
4041 my( $self, $pkgnum ) = @_;
4042 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
4043 sort { $a->_date <=> $b->_date }
4044 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
4045 'pkgnum' => $pkgnum,
4052 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4058 map { $_ } #return $self->num_cust_pay_void unless wantarray;
4059 sort { $a->_date <=> $b->_date }
4060 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4063 =item cust_pay_pending
4065 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
4066 (without status "done").
4070 sub cust_pay_pending {
4072 return $self->num_cust_pay_pending unless wantarray;
4073 sort { $a->_date <=> $b->_date }
4074 qsearch( 'cust_pay_pending', {
4075 'custnum' => $self->custnum,
4076 'status' => { op=>'!=', value=>'done' },
4081 =item cust_pay_pending_attempt
4083 Returns all payment attempts / declined payments for this customer, as pending
4084 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
4085 a corresponding payment (see L<FS::cust_pay>).
4089 sub cust_pay_pending_attempt {
4091 return $self->num_cust_pay_pending_attempt unless wantarray;
4092 sort { $a->_date <=> $b->_date }
4093 qsearch( 'cust_pay_pending', {
4094 'custnum' => $self->custnum,
4101 =item num_cust_pay_pending
4103 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
4104 customer (without status "done"). Also called automatically when the
4105 cust_pay_pending method is used in a scalar context.
4109 sub num_cust_pay_pending {
4112 " SELECT COUNT(*) FROM cust_pay_pending ".
4113 " WHERE custnum = ? AND status != 'done' ",
4118 =item num_cust_pay_pending_attempt
4120 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
4121 customer, with status "done" but without a corresp. Also called automatically when the
4122 cust_pay_pending method is used in a scalar context.
4126 sub num_cust_pay_pending_attempt {
4129 " SELECT COUNT(*) FROM cust_pay_pending ".
4130 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
4137 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4143 map { $_ } #return $self->num_cust_refund unless wantarray;
4144 sort { $a->_date <=> $b->_date }
4145 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4148 =item display_custnum
4150 Returns the displayed customer number for this customer: agent_custid if
4151 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
4155 sub display_custnum {
4158 return $self->agent_custid
4159 if $default_agent_custid && $self->agent_custid;
4161 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
4165 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
4166 } elsif ( $custnum_display_length ) {
4167 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
4169 return $self->custnum;
4175 Returns a name string for this customer, either "Company (Last, First)" or
4182 my $name = $self->contact;
4183 $name = $self->company. " ($name)" if $self->company;
4187 =item batch_payment_payname
4189 Returns a name string for this customer, either "cust_batch_payment->payname" or "First Last" or "Company,
4190 based on if a company name exists and is the account being used a business account.
4194 sub batch_payment_payname {
4196 my $cust_pay_batch = shift;
4199 if ($cust_pay_batch->{Hash}->{payby} eq "CARD") { $name = $cust_pay_batch->payname; }
4200 else { $name = $self->first .' '. $self->last; }
4202 $name = $self->company
4203 if (($cust_pay_batch->{Hash}->{paytype} eq "Business checking" || $cust_pay_batch->{Hash}->{paytype} eq "Business savings") && $self->company);
4208 =item service_contact
4210 Returns the L<FS::contact> object for this customer that has the 'Service'
4211 contact class, or undef if there is no such contact. Deprecated; don't use
4216 sub service_contact {
4218 if ( !exists($self->{service_contact}) ) {
4219 my $classnum = $self->scalar_sql(
4220 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4221 ) || 0; #if it's zero, qsearchs will return nothing
4222 my $cust_contact = qsearchs('cust_contact', {
4223 'classnum' => $classnum,
4224 'custnum' => $self->custnum,
4226 $self->{service_contact} = $cust_contact->contact if $cust_contact;
4228 $self->{service_contact};
4233 Returns a name string for this (service/shipping) contact, either
4234 "Company (Last, First)" or "Last, First".
4241 my $name = $self->ship_contact;
4242 $name = $self->company. " ($name)" if $self->company;
4248 Returns a name string for this customer, either "Company" or "First Last".
4254 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4257 =item ship_name_short
4259 Returns a name string for this (service/shipping) contact, either "Company"
4264 sub ship_name_short {
4266 $self->service_contact
4267 ? $self->ship_contact_firstlast
4273 Returns this customer's full (billing) contact name only, "Last, First"
4279 $self->get('last'). ', '. $self->first;
4284 Returns this customer's full (shipping) contact name only, "Last, First"
4290 my $contact = $self->service_contact || $self;
4291 $contact->get('last') . ', ' . $contact->get('first');
4294 =item contact_firstlast
4296 Returns this customers full (billing) contact name only, "First Last".
4300 sub contact_firstlast {
4302 $self->first. ' '. $self->get('last');
4305 =item ship_contact_firstlast
4307 Returns this customer's full (shipping) contact name only, "First Last".
4311 sub ship_contact_firstlast {
4313 my $contact = $self->service_contact || $self;
4314 $contact->get('first') . ' '. $contact->get('last');
4317 sub bill_country_full {
4319 $self->bill_location->country_full;
4322 sub ship_country_full {
4324 $self->ship_location->country_full;
4327 =item county_state_county [ PREFIX ]
4329 Returns a string consisting of just the county, state and country.
4333 sub county_state_country {
4336 if ( @_ && $_[0] && $self->has_ship_address ) {
4337 $locationnum = $self->ship_locationnum;
4339 $locationnum = $self->bill_locationnum;
4341 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4342 $cust_location->county_state_country;
4345 =item geocode DATA_VENDOR
4347 Returns a value for the customer location as encoded by DATA_VENDOR.
4348 Currently this only makes sense for "CCH" as DATA_VENDOR.
4356 Returns a status string for this customer, currently:
4362 No packages have ever been ordered. Displayed as "No packages".
4366 Recurring packages all are new (not yet billed).
4370 One or more recurring packages is active.
4374 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
4378 All non-cancelled recurring packages are suspended.
4382 All recurring packages are cancelled.
4386 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4387 cust_main-status_module configuration option.
4391 sub status { shift->cust_status(@_); }
4395 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4396 for my $status ( FS::cust_main->statuses() ) {
4397 my $method = $status.'_sql';
4398 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4399 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4400 $sth->execute( ($self->custnum) x $numnum )
4401 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4402 if ( $sth->fetchrow_arrayref->[0] ) {
4403 $self->hashref->{cust_status} = $status;
4409 =item is_status_delay_cancel
4411 Returns true if customer status is 'suspended'
4412 and all suspended cust_pkg return true for
4413 cust_pkg->is_status_delay_cancel.
4415 This is not a real status, this only meant for hacking display
4416 values, because otherwise treating the customer as suspended is
4417 really the whole point of the delay_cancel option.
4421 sub is_status_delay_cancel {
4423 return 0 unless $self->status eq 'suspended';
4424 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4425 return 0 unless $cust_pkg->is_status_delay_cancel;
4430 =item ucfirst_cust_status
4432 =item ucfirst_status
4434 Deprecated, use the cust_status_label method instead.
4436 Returns the status with the first character capitalized.
4440 sub ucfirst_status {
4441 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4442 local($ucfirst_nowarn) = 1;
4443 shift->ucfirst_cust_status(@_);
4446 sub ucfirst_cust_status {
4447 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4449 ucfirst($self->cust_status);
4452 =item cust_status_label
4456 Returns the display label for this status.
4460 sub status_label { shift->cust_status_label(@_); }
4462 sub cust_status_label {
4464 __PACKAGE__->statuslabels->{$self->cust_status};
4469 Returns a hex triplet color string for this customer's status.
4473 sub statuscolor { shift->cust_statuscolor(@_); }
4475 sub cust_statuscolor {
4477 __PACKAGE__->statuscolors->{$self->cust_status};
4480 =item tickets [ STATUS ]
4482 Returns an array of hashes representing the customer's RT tickets.
4484 An optional status (or arrayref or hashref of statuses) may be specified.
4490 my $status = ( @_ && $_[0] ) ? shift : '';
4492 my $num = $conf->config('cust_main-max_tickets') || 10;
4495 if ( $conf->config('ticket_system') ) {
4496 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4498 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4507 foreach my $priority (
4508 $conf->config('ticket_system-custom_priority_field-values'), ''
4510 last if scalar(@tickets) >= $num;
4512 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4513 $num - scalar(@tickets),
4524 =item appointments [ STATUS ]
4526 Returns an array of hashes representing the customer's RT tickets which
4533 my $status = ( @_ && $_[0] ) ? shift : '';
4535 return () unless $conf->config('ticket_system');
4537 my $queueid = $conf->config('ticket_system-appointment-queueid');
4539 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4548 # Return services representing svc_accts in customer support packages
4549 sub support_services {
4551 my %packages = map { $_ => 1 } $conf->config('support_packages');
4553 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4554 grep { $_->part_svc->svcdb eq 'svc_acct' }
4555 map { $_->cust_svc }
4556 grep { exists $packages{ $_->pkgpart } }
4557 $self->ncancelled_pkgs;
4561 # Return a list of latitude/longitude for one of the services (if any)
4562 sub service_coordinates {
4566 grep { $_->latitude && $_->longitude }
4568 map { $_->cust_svc }
4569 $self->ncancelled_pkgs;
4571 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4576 Returns a masked version of the named field
4581 my ($self,$field) = @_;
4585 'x'x(length($self->getfield($field))-4).
4586 substr($self->getfield($field), (length($self->getfield($field))-4));
4590 =item payment_history
4592 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4593 cust_credit and cust_refund objects. Each hashref has the following fields:
4595 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4597 I<date> - value of _date field, unix timestamp
4599 I<date_pretty> - user-friendly date
4601 I<description> - user-friendly description of item
4603 I<amount> - impact of item on user's balance
4604 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4605 Not to be confused with the native 'amount' field in cust_credit, see below.
4607 I<amount_pretty> - includes money char
4609 I<balance> - customer balance, chronologically as of this item
4611 I<balance_pretty> - includes money char
4613 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4615 I<paid> - amount paid for cust_pay records, undef for other types
4617 I<credit> - amount credited for cust_credit records, undef for other types.
4618 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4620 I<refund> - amount refunded for cust_refund records, undef for other types
4622 The four table-specific keys always have positive values, whether they reflect charges or payments.
4624 The following options may be passed to this method:
4626 I<line_items> - if true, returns charges ('Line item') rather than invoices
4628 I<start_date> - unix timestamp, only include records on or after.
4629 If specified, an item of type 'Previous' will also be included.
4630 It does not have table-specific fields.
4632 I<end_date> - unix timestamp, only include records before
4634 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4636 I<conf> - optional already-loaded FS::Conf object.
4640 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4641 # and also for sending customer statements, which should both be kept customer-friendly.
4642 # If you add anything that shouldn't be passed on through the API or exposed
4643 # to customers, add a new option to include it, don't include it by default
4644 sub payment_history {
4646 my $opt = ref($_[0]) ? $_[0] : { @_ };
4648 my $conf = $$opt{'conf'} || new FS::Conf;
4649 my $money_char = $conf->config("money_char") || '$',
4651 #first load entire history,
4652 #need previous to calculate previous balance
4653 #loading after end_date shouldn't hurt too much?
4655 if ( $$opt{'line_items'} ) {
4657 foreach my $cust_bill ( $self->cust_bill ) {
4660 'type' => 'Line item',
4661 'description' => $_->desc( $self->locale ).
4662 ( $_->sdate && $_->edate
4663 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4664 ' To '. time2str('%d-%b-%Y', $_->edate)
4667 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4668 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4669 'date' => $cust_bill->_date,
4670 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4672 foreach $cust_bill->cust_bill_pkg;
4679 'type' => 'Invoice',
4680 'description' => 'Invoice #'. $_->display_invnum,
4681 'amount' => sprintf('%.2f', $_->charged ),
4682 'charged' => sprintf('%.2f', $_->charged ),
4683 'date' => $_->_date,
4684 'date_pretty' => $self->time2str_local('short', $_->_date ),
4686 foreach $self->cust_bill;
4691 'type' => 'Payment',
4692 'description' => 'Payment', #XXX type
4693 'amount' => sprintf('%.2f', 0 - $_->paid ),
4694 'paid' => sprintf('%.2f', $_->paid ),
4695 'date' => $_->_date,
4696 'date_pretty' => $self->time2str_local('short', $_->_date ),
4698 foreach $self->cust_pay;
4702 'description' => 'Credit', #more info?
4703 'amount' => sprintf('%.2f', 0 -$_->amount ),
4704 'credit' => sprintf('%.2f', $_->amount ),
4705 'date' => $_->_date,
4706 'date_pretty' => $self->time2str_local('short', $_->_date ),
4708 foreach $self->cust_credit;
4712 'description' => 'Refund', #more info? type, like payment?
4713 'amount' => $_->refund,
4714 'refund' => $_->refund,
4715 'date' => $_->_date,
4716 'date_pretty' => $self->time2str_local('short', $_->_date ),
4718 foreach $self->cust_refund;
4720 #put it all in chronological order
4721 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4723 #calculate balance, filter items outside date range
4727 foreach my $item (@history) {
4728 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4729 $balance += $$item{'amount'};
4730 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4731 $previous += $$item{'amount'};
4734 $$item{'balance'} = sprintf("%.2f",$balance);
4735 foreach my $key ( qw(amount balance) ) {
4736 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4741 # start with previous balance, if there was one
4744 'type' => 'Previous',
4745 'description' => 'Previous balance',
4746 'amount' => sprintf("%.2f",$previous),
4747 'balance' => sprintf("%.2f",$previous),
4748 'date' => $$opt{'start_date'},
4749 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4751 #false laziness with above
4752 foreach my $key ( qw(amount balance) ) {
4753 $$item{$key.'_pretty'} = $$item{$key};
4754 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4756 unshift(@out,$item);
4759 @out = reverse @history if $$opt{'reverse_sort'};
4764 =item save_cust_payby
4766 Saves a new cust_payby for this customer, replacing an existing entry only
4767 in select circumstances. Does not validate input.
4769 If auto is specified, marks this as the customer's primary method, or the
4770 specified weight. Existing payment methods have their weight incremented as
4773 If bill_location is specified with auto, also sets location in cust_main.
4775 Will not insert complete duplicates of existing records, or records in which the
4776 only difference from an existing record is to turn off automatic payment (will
4777 return without error.) Will replace existing records in which the only difference
4778 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4779 Fields marked as preserved are optional, and existing values will not be overwritten with
4780 blanks when replacing.
4782 Accepts the following named parameters:
4792 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4796 optional, set higher than 1 for secondary, etc.
4804 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4812 optional, will be preserved when replacing
4820 CARD only, required, FS::cust_location object
4822 =item paystart_month
4824 CARD only, optional, will be preserved when replacing
4828 CARD only, optional, will be preserved when replacing
4832 CARD only, optional, will be preserved when replacing
4836 CARD only, only used if conf cvv-save is set appropriately
4846 =item saved_cust_payby
4848 scalar reference, for returning saved object
4854 #The code for this option is in place, but it's not currently used
4858 # existing cust_payby object to be replaced (must match custnum)
4860 # stateid/stateid_state/ss are not currently supported in cust_payby,
4861 # might not even work properly in 4.x, but will need to work here if ever added
4863 sub save_cust_payby {
4867 my $old = $opt{'replace'};
4868 my $new = new FS::cust_payby { $old ? $old->hash : () };
4869 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4870 $new->set( 'custnum' => $self->custnum );
4872 my $payby = $opt{'payment_payby'};
4873 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4875 # don't allow turning off auto when replacing
4876 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4878 my @check_existing; # payby relevant to this payment_payby
4880 # set payby based on auto
4881 if ( $payby eq 'CARD' ) {
4882 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4883 @check_existing = qw( CARD DCRD );
4884 } elsif ( $payby eq 'CHEK' ) {
4885 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4886 @check_existing = qw( CHEK DCHK );
4889 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4892 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4893 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4894 $new->set( 'payname' => $opt{'payname'} );
4895 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4897 my $conf = new FS::Conf;
4899 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4900 if ( $payby eq 'CARD' &&
4901 ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4902 || $conf->exists('business-onlinepayment-verification')
4905 $new->set( 'paycvv' => $opt{'paycvv'} );
4907 $new->set( 'paycvv' => '');
4910 local $SIG{HUP} = 'IGNORE';
4911 local $SIG{INT} = 'IGNORE';
4912 local $SIG{QUIT} = 'IGNORE';
4913 local $SIG{TERM} = 'IGNORE';
4914 local $SIG{TSTP} = 'IGNORE';
4915 local $SIG{PIPE} = 'IGNORE';
4917 my $oldAutoCommit = $FS::UID::AutoCommit;
4918 local $FS::UID::AutoCommit = 0;
4921 # set fields specific to payment_payby
4922 if ( $payby eq 'CARD' ) {
4923 if ($opt{'bill_location'}) {
4924 $opt{'bill_location'}->set('custnum' => $self->custnum);
4925 my $error = $opt{'bill_location'}->find_or_insert;
4927 $dbh->rollback if $oldAutoCommit;
4930 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4932 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4933 $new->set( $field => $opt{$field} );
4936 foreach my $field ( qw(paytype paystate) ) {
4937 $new->set( $field => $opt{$field} );
4941 # other cust_payby to compare this to
4942 my @existing = $self->cust_payby(@check_existing);
4944 # fields that can overwrite blanks with values, but not values with blanks
4945 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4947 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4949 # generally, we don't want to overwrite existing cust_payby with this,
4950 # but we can replace if we're only marking it auto or adding a preserved field
4951 # and we can avoid saving a total duplicate or merely turning off auto
4953 foreach my $cust_payby (@existing) {
4954 # check fields that absolutely should not change
4955 foreach my $field ($new->fields) {
4956 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4957 next if grep(/^$field$/, @preserve );
4958 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4959 # check if paymask exists, if so stop and don't save, no need for a duplicate.
4960 return '' if $new->get('paymask') eq $cust_payby->get('paymask');
4962 # now check fields that can replace if one value is blank
4964 foreach my $field (@preserve) {
4966 ( $new->get($field) and !$cust_payby->get($field) ) or
4967 ( $cust_payby->get($field) and !$new->get($field) )
4969 # prevention of overwriting values with blanks happens farther below
4971 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4975 unless ( $replace ) {
4976 # nearly identical, now check weight
4977 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4978 # ignore identical cust_payby, and ignore attempts to turn off auto
4979 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4980 $skip_cust_payby = 1;
4983 # otherwise, only change is to mark this as primary
4985 # if we got this far, we're definitely replacing
4992 $new->set( 'custpaybynum' => $old->custpaybynum );
4993 # don't turn off automatic payment (but allow it to be turned on)
4994 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4996 $new->set( 'payby' => $old->payby );
4997 $new->set( 'weight' => 1 );
4999 # make sure we're not overwriting values with blanks
5000 foreach my $field (@preserve) {
5001 if ( $old->get($field) and !$new->get($field) ) {
5002 $new->set( $field => $old->get($field) );
5007 # only overwrite cust_main bill_location if auto
5008 if ($opt{'auto'} && $opt{'bill_location'}) {
5009 $self->set('bill_location' => $opt{'bill_location'});
5010 my $error = $self->replace;
5012 $dbh->rollback if $oldAutoCommit;
5017 # done with everything except reweighting and saving cust_payby
5018 # still need to commit changes to cust_main and cust_location
5019 if ($skip_cust_payby) {
5020 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5024 # re-weight existing primary cust_pay for this payby
5026 foreach my $cust_payby (@existing) {
5027 # relies on cust_payby return order
5028 last unless $cust_payby->payby !~ /^D/;
5029 last if $cust_payby->weight > 1;
5030 next if $new->custpaybynum eq $cust_payby->custpaybynum;
5031 next if $cust_payby->weight < ($opt{'weight'} || 1);
5032 $cust_payby->weight( $cust_payby->weight + 1 );
5033 my $error = $cust_payby->replace;
5035 $dbh->rollback if $oldAutoCommit;
5036 return "Error reweighting cust_payby: $error";
5041 # finally, save cust_payby
5042 my $error = $old ? $new->replace($old) : $new->insert;
5044 $dbh->rollback if $oldAutoCommit;
5048 ${$opt{'saved_cust_payby'}} = $new
5049 if $opt{'saved_cust_payby'};
5051 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5056 =item remove_cvv_from_cust_payby PAYINFO
5058 Removes paycvv from associated cust_payby with matching PAYINFO.
5062 sub remove_cvv_from_cust_payby {
5063 my ($self,$payinfo) = @_;
5065 my $oldAutoCommit = $FS::UID::AutoCommit;
5066 local $FS::UID::AutoCommit = 0;
5069 foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
5070 next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
5071 $cust_payby->paycvv('');
5072 my $error = $cust_payby->replace;
5074 $dbh->rollback if $oldAutoCommit;
5079 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5085 =head1 CLASS METHODS
5091 Class method that returns the list of possible status strings for customers
5092 (see L<the status method|/status>). For example:
5094 @statuses = FS::cust_main->statuses();
5100 keys %{ $self->statuscolors };
5103 =item cust_status_sql
5105 Returns an SQL fragment to determine the status of a cust_main record, as a
5110 sub cust_status_sql {
5112 for my $status ( FS::cust_main->statuses() ) {
5113 my $method = $status.'_sql';
5114 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
5123 Returns an SQL expression identifying prospective cust_main records (customers
5124 with no packages ever ordered)
5128 use vars qw($select_count_pkgs);
5129 $select_count_pkgs =
5130 "SELECT COUNT(*) FROM cust_pkg
5131 WHERE cust_pkg.custnum = cust_main.custnum";
5133 sub select_count_pkgs_sql {
5138 " 0 = ( $select_count_pkgs ) ";
5143 Returns an SQL expression identifying ordered cust_main records (customers with
5144 no active packages, but recurring packages not yet setup or one time charges
5150 FS::cust_main->none_active_sql.
5151 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
5156 Returns an SQL expression identifying active cust_main records (customers with
5157 active recurring packages).
5162 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
5165 =item none_active_sql
5167 Returns an SQL expression identifying cust_main records with no active
5168 recurring packages. This includes customers of status prospect, ordered,
5169 inactive, and suspended.
5173 sub none_active_sql {
5174 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
5179 Returns an SQL expression identifying inactive cust_main records (customers with
5180 no active recurring packages, but otherwise unsuspended/uncancelled).
5185 FS::cust_main->none_active_sql.
5186 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
5192 Returns an SQL expression identifying suspended cust_main records.
5197 sub suspended_sql { susp_sql(@_); }
5199 FS::cust_main->none_active_sql.
5200 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
5206 Returns an SQL expression identifying cancelled cust_main records.
5210 sub cancel_sql { shift->cancelled_sql(@_); }
5213 =item uncancelled_sql
5215 Returns an SQL expression identifying un-cancelled cust_main records.
5219 sub uncancelled_sql { uncancel_sql(@_); }
5222 "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
5227 Returns an SQL fragment to retreive the balance.
5232 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5233 WHERE cust_bill.custnum = cust_main.custnum )
5234 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5235 WHERE cust_pay.custnum = cust_main.custnum )
5236 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5237 WHERE cust_credit.custnum = cust_main.custnum )
5238 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5239 WHERE cust_refund.custnum = cust_main.custnum )
5242 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
5244 Returns an SQL fragment to retreive the balance for this customer, optionally
5245 considering invoices with date earlier than START_TIME, and not
5246 later than END_TIME (total_owed_date minus total_unapplied_credits minus
5247 total_unapplied_payments).
5249 Times are specified as SQL fragments or numeric
5250 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5251 L<Date::Parse> for conversion functions. The empty string can be passed
5252 to disable that time constraint completely.
5254 Available options are:
5258 =item unapplied_date
5260 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)
5265 set to true to remove all customer comparison clauses, for totals
5270 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5275 JOIN clause (typically used with the total option)
5279 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
5280 time will be ignored. Note that START_TIME and END_TIME only limit the date
5281 range for invoices and I<unapplied> payments, credits, and refunds.
5287 sub balance_date_sql {
5288 my( $class, $start, $end, %opt ) = @_;
5290 my $cutoff = $opt{'cutoff'};
5292 my $owed = FS::cust_bill->owed_sql($cutoff);
5293 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
5294 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
5295 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5297 my $j = $opt{'join'} || '';
5299 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5300 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5301 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5302 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5304 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5305 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5306 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5307 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5312 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
5314 Returns an SQL fragment to retreive the total unapplied payments for this
5315 customer, only considering payments with date earlier than START_TIME, and
5316 optionally not later than END_TIME.
5318 Times are specified as SQL fragments or numeric
5319 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5320 L<Date::Parse> for conversion functions. The empty string can be passed
5321 to disable that time constraint completely.
5323 Available options are:
5327 sub unapplied_payments_date_sql {
5328 my( $class, $start, $end, %opt ) = @_;
5330 my $cutoff = $opt{'cutoff'};
5332 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5334 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
5335 'unapplied_date'=>1 );
5337 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
5340 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5342 Helper method for balance_date_sql; name (and usage) subject to change
5343 (suggestions welcome).
5345 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5346 cust_refund, cust_credit or cust_pay).
5348 If TABLE is "cust_bill" or the unapplied_date option is true, only
5349 considers records with date earlier than START_TIME, and optionally not
5350 later than END_TIME .
5354 sub _money_table_where {
5355 my( $class, $table, $start, $end, %opt ) = @_;
5358 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5359 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5360 push @where, "$table._date <= $start" if defined($start) && length($start);
5361 push @where, "$table._date > $end" if defined($end) && length($end);
5363 push @where, @{$opt{'where'}} if $opt{'where'};
5364 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5370 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
5371 use FS::cust_main::Search;
5374 FS::cust_main::Search->search(@_);
5383 #=item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5385 #Deprecated. Use event notification and message templates
5386 #(L<FS::msg_template>) instead.
5388 #Sends a templated email notification to the customer (see L<Text::Template>).
5390 #OPTIONS is a hash and may include
5392 #I<from> - the email sender (default is invoice_from)
5394 #I<to> - comma-separated scalar or arrayref of recipients
5395 # (default is invoicing_list)
5397 #I<subject> - The subject line of the sent email notification
5398 # (default is "Notice from company_name")
5400 #I<extra_fields> - a hashref of name/value pairs which will be substituted
5403 #The following variables are vavailable in the template.
5405 #I<$first> - the customer first name
5406 #I<$last> - the customer last name
5407 #I<$company> - the customer company
5408 #I<$payby> - a description of the method of payment for the customer
5409 # # would be nice to use FS::payby::shortname
5410 #I<$payinfo> - the account information used to collect for this customer
5411 #I<$expdate> - the expiration of the customer payment in seconds from epoch
5416 # my ($self, $template, %options) = @_;
5418 # return unless $conf->exists($template);
5420 # my $from = $conf->invoice_from_full($self->agentnum)
5421 # if $conf->exists('invoice_from', $self->agentnum);
5422 # $from = $options{from} if exists($options{from});
5424 # my $to = join(',', $self->invoicing_list_emailonly);
5425 # $to = $options{to} if exists($options{to});
5427 # my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
5428 # if $conf->exists('company_name', $self->agentnum);
5429 # $subject = $options{subject} if exists($options{subject});
5431 # my $notify_template = new Text::Template (TYPE => 'ARRAY',
5432 # SOURCE => [ map "$_\n",
5433 # $conf->config($template)]
5435 # or die "can't create new Text::Template object: Text::Template::ERROR";
5436 # $notify_template->compile()
5437 # or die "can't compile template: Text::Template::ERROR";
5439 # $FS::notify_template::_template::company_name =
5440 # $conf->config('company_name', $self->agentnum);
5441 # $FS::notify_template::_template::company_address =
5442 # join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
5444 # my $paydate = $self->paydate || '2037-12-31';
5445 # $FS::notify_template::_template::first = $self->first;
5446 # $FS::notify_template::_template::last = $self->last;
5447 # $FS::notify_template::_template::company = $self->company;
5448 # $FS::notify_template::_template::payinfo = $self->mask_payinfo;
5449 # my $payby = $self->payby;
5450 # my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5451 # my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5453 # #credit cards expire at the end of the month/year of their exp date
5454 # if ($payby eq 'CARD' || $payby eq 'DCRD') {
5455 # $FS::notify_template::_template::payby = 'credit card';
5456 # ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5457 # $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5459 # }elsif ($payby eq 'COMP') {
5460 # $FS::notify_template::_template::payby = 'complimentary account';
5462 # $FS::notify_template::_template::payby = 'current method';
5464 # $FS::notify_template::_template::expdate = $expire_time;
5466 # for (keys %{$options{extra_fields}}){
5468 # ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5471 # send_email(from => $from,
5473 # subject => $subject,
5474 # body => $notify_template->fill_in( PACKAGE =>
5475 # 'FS::notify_template::_template' ),
5480 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5482 Generates a templated notification to the customer (see L<Text::Template>).
5484 OPTIONS is a hash and may include
5486 I<extra_fields> - a hashref of name/value pairs which will be substituted
5487 into the template. These values may override values mentioned below
5488 and those from the customer record.
5490 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5492 The following variables are available in the template instead of or in addition
5493 to the fields of the customer record.
5495 I<$payby> - a description of the method of payment for the customer
5496 # would be nice to use FS::payby::shortname
5497 I<$payinfo> - the masked account information used to collect for this customer
5498 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5499 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5503 # a lot like cust_bill::print_latex
5504 sub generate_letter {
5505 my ($self, $template, %options) = @_;
5507 warn "Template $template does not exist" && return
5508 unless $conf->exists($template) || $options{'template_text'};
5510 my $template_source = $options{'template_text'}
5511 ? [ $options{'template_text'} ]
5512 : [ map "$_\n", $conf->config($template) ];
5514 my $letter_template = new Text::Template
5516 SOURCE => $template_source,
5517 DELIMITERS => [ '[@--', '--@]' ],
5519 or die "can't create new Text::Template object: Text::Template::ERROR";
5521 $letter_template->compile()
5522 or die "can't compile template: Text::Template::ERROR";
5524 my %letter_data = map { $_ => $self->$_ } $self->fields;
5525 $letter_data{payinfo} = $self->mask_payinfo;
5527 #my $paydate = $self->paydate || '2037-12-31';
5528 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
5530 my $payby = $self->payby;
5531 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5532 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5534 #credit cards expire at the end of the month/year of their exp date
5535 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5536 $letter_data{payby} = 'credit card';
5537 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5538 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5540 }elsif ($payby eq 'COMP') {
5541 $letter_data{payby} = 'complimentary account';
5543 $letter_data{payby} = 'current method';
5545 $letter_data{expdate} = $expire_time;
5547 for (keys %{$options{extra_fields}}){
5548 $letter_data{$_} = $options{extra_fields}->{$_};
5551 unless(exists($letter_data{returnaddress})){
5552 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5553 $self->agent_template)
5555 if ( length($retadd) ) {
5556 $letter_data{returnaddress} = $retadd;
5557 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5558 $letter_data{returnaddress} =
5559 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5563 ( $conf->config('company_name', $self->agentnum),
5564 $conf->config('company_address', $self->agentnum),
5568 $letter_data{returnaddress} = '~';
5572 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5574 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5576 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5578 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5582 ) or die "can't open temp file: $!\n";
5583 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5584 or die "can't write temp file: $!\n";
5586 $letter_data{'logo_file'} = $lh->filename;
5588 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5592 ) or die "can't open temp file: $!\n";
5594 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5596 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5597 return ($1, $letter_data{'logo_file'});
5601 =item print_ps TEMPLATE
5603 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5609 my($file, $lfile) = $self->generate_letter(@_);
5610 my $ps = FS::Misc::generate_ps($file);
5611 unlink($file.'.tex');
5617 =item print TEMPLATE
5619 Prints the filled in template.
5621 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5625 sub queueable_print {
5628 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5629 or die "invalid customer number: " . $opt{custnum};
5631 #do not backport this change to 3.x
5632 # my $error = $self->print( { 'template' => $opt{template} } );
5633 my $error = $self->print( $opt{'template'} );
5634 die $error if $error;
5638 my ($self, $template) = (shift, shift);
5640 [ $self->print_ps($template) ],
5641 'agentnum' => $self->agentnum,
5645 #these three subs should just go away once agent stuff is all config overrides
5647 sub agent_template {
5649 $self->_agent_plandata('agent_templatename');
5652 sub agent_invoice_from {
5654 $self->_agent_plandata('agent_invoice_from');
5657 sub _agent_plandata {
5658 my( $self, $option ) = @_;
5660 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5661 #agent-specific Conf
5663 use FS::part_event::Condition;
5665 my $agentnum = $self->agentnum;
5667 my $regexp = regexp_sql();
5669 my $part_event_option =
5671 'select' => 'part_event_option.*',
5672 'table' => 'part_event_option',
5674 LEFT JOIN part_event USING ( eventpart )
5675 LEFT JOIN part_event_option AS peo_agentnum
5676 ON ( part_event.eventpart = peo_agentnum.eventpart
5677 AND peo_agentnum.optionname = 'agentnum'
5678 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5680 LEFT JOIN part_event_condition
5681 ON ( part_event.eventpart = part_event_condition.eventpart
5682 AND part_event_condition.conditionname = 'cust_bill_age'
5684 LEFT JOIN part_event_condition_option
5685 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5686 AND part_event_condition_option.optionname = 'age'
5689 #'hashref' => { 'optionname' => $option },
5690 #'hashref' => { 'part_event_option.optionname' => $option },
5692 " WHERE part_event_option.optionname = ". dbh->quote($option).
5693 " AND action = 'cust_bill_send_agent' ".
5694 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5695 " AND peo_agentnum.optionname = 'agentnum' ".
5696 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5698 CASE WHEN part_event_condition_option.optionname IS NULL
5700 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5702 , part_event.weight".
5706 unless ( $part_event_option ) {
5707 return $self->agent->invoice_template || ''
5708 if $option eq 'agent_templatename';
5712 $part_event_option->optionvalue;
5716 sub process_o2m_qsearch {
5719 return qsearch($table, @_) unless $table eq 'contact';
5721 my $hashref = shift;
5722 my %hash = %$hashref;
5723 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5724 or die 'guru meditation #4343';
5726 qsearch({ 'table' => 'contact',
5727 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5728 'hashref' => \%hash,
5729 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5730 " cust_contact.custnum = $custnum "
5734 sub process_o2m_qsearchs {
5737 return qsearchs($table, @_) unless $table eq 'contact';
5739 my $hashref = shift;
5740 my %hash = %$hashref;
5741 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5742 or die 'guru meditation #2121';
5744 qsearchs({ 'table' => 'contact',
5745 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5746 'hashref' => \%hash,
5747 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5748 " cust_contact.custnum = $custnum "
5752 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5754 Subroutine (not a method), designed to be called from the queue.
5756 Takes a list of options and values.
5758 Pulls up the customer record via the custnum option and calls bill_and_collect.
5763 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5765 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5766 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5768 #without this errors don't get rolled back
5769 $args{'fatal'} = 1; # runs from job queue, will be caught
5771 $cust_main->bill_and_collect( %args );
5774 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5776 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5777 C<collect> part. This is used in batch tax calculation, where invoice
5778 generation and collection events have to be completely separated.
5782 sub queued_collect {
5784 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5786 $cust_main->collect(%args);
5789 sub process_bill_and_collect {
5792 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5793 or die "custnum '$param->{custnum}' not found!\n";
5794 $param->{'job'} = $job;
5795 $param->{'fatal'} = 1; # runs from job queue, will be caught
5796 $param->{'retry'} = 1;
5799 eval { $cust_main->bill_and_collect( %$param) };
5801 die $@ =~ /cancel_pkgs cannot be run inside a transaction/
5802 ? "Bill Now unavailable for customer with pending package expiration\n"
5807 =item pending_invoice_count
5809 Return number of cust_bill with pending=Y for this customer
5813 sub pending_invoice_count {
5814 FS::cust_bill->count( 'custnum = '.shift->custnum."AND pending = 'Y'" );
5817 =item cust_locations_missing_district
5819 Always returns empty list, unless tax_district_method eq 'wa_sales'
5821 Return cust_location rows for this customer, associated with active
5822 customer packages, where tax district column is empty. Presense of
5823 these rows should block billing, because invoice would be generated
5824 with incorrect taxes
5828 sub cust_locations_missing_district {
5831 my $tax_district_method = FS::Conf->new->config('tax_district_method');
5834 unless $tax_district_method
5835 && $tax_district_method eq 'wa_sales';
5838 table => 'cust_location',
5839 select => 'cust_location.*',
5841 LEFT JOIN cust_main USING (custnum)
5842 LEFT JOIN cust_pkg ON cust_location.locationnum = cust_pkg.locationnum
5844 extra_sql => sprintf(q{
5845 WHERE cust_location.state = 'WA'
5846 AND cust_location.custnum = %s
5848 cust_location.district IS NULL
5849 or cust_location.district = ''
5851 AND cust_pkg.pkgnum IS NOT NULL
5853 cust_pkg.cancel > %s
5854 OR cust_pkg.cancel IS NULL
5857 $self->custnum, time()
5862 #starting to take quite a while for big dbs
5863 # (JRNL: journaled so it only happens once per database)
5864 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5865 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5866 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5867 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5868 # JRNL leading/trailing spaces in first, last, company
5869 # JRNL migrate to cust_payby
5870 # - otaker upgrade? journal and call it good? (double check to make sure
5871 # we're not still setting otaker here)
5873 #only going to get worse with new location stuff...
5875 sub _upgrade_data { #class method
5876 my ($class, %opts) = @_;
5879 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5882 #this seems to be the only expensive one.. why does it take so long?
5883 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5885 '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';
5886 FS::upgrade_journal->set_done('cust_main__signupdate');
5889 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5891 # fix yyyy-m-dd formatted paydates
5892 if ( driver_name =~ /^mysql/i ) {
5894 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5895 } else { # the SQL standard
5897 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5899 FS::upgrade_journal->set_done('cust_main__paydate');
5902 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5904 push @statements, #fix the weird BILL with a cc# in payinfo problem
5906 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5908 FS::upgrade_journal->set_done('cust_main__payinfo');
5913 foreach my $sql ( @statements ) {
5914 my $sth = dbh->prepare($sql) or die dbh->errstr;
5915 $sth->execute or die $sth->errstr;
5916 #warn ( (time - $t). " seconds\n" );
5920 local($ignore_expired_card) = 1;
5921 local($ignore_banned_card) = 1;
5922 local($skip_fuzzyfiles) = 1;
5923 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5925 unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5927 #we don't want to decrypt them, just stuff them as-is into cust_payby
5928 local(@encrypted_fields) = ();
5930 local($FS::cust_payby::ignore_expired_card) = 1;
5931 local($FS::cust_payby::ignore_banned_card) = 1;
5932 local($FS::cust_payby::ignore_cardtype) = 1;
5934 my @payfields = qw( payby payinfo paycvv paymask
5935 paydate paystart_month paystart_year payissue
5936 payname paystate paytype payip
5939 my $search = new FS::Cursor {
5940 'table' => 'cust_main',
5941 'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5944 while (my $cust_main = $search->fetch) {
5946 unless ( $cust_main->payby =~ /^(BILL|COMP)$/ ) {
5948 my $cust_payby = new FS::cust_payby {
5949 'custnum' => $cust_main->custnum,
5951 map { $_ => $cust_main->$_(); } @payfields
5954 my $error = $cust_payby->insert;
5955 die $error if $error;
5959 # at the time we do this, also migrate paytype into cust_pay_batch
5960 # so that batches that are open before the migration can still be
5962 if ( $cust_main->get('paytype') ) {
5963 my @cust_pay_batch = qsearch('cust_pay_batch', {
5964 'custnum' => $cust_main->custnum,
5968 foreach my $cust_pay_batch (@cust_pay_batch) {
5969 $cust_pay_batch->set('paytype', $cust_main->get('paytype'));
5970 my $error = $cust_pay_batch->replace;
5971 die "$error (setting cust_pay_batch.paytype)" if $error;
5975 $cust_main->complimentary('Y') if $cust_main->payby eq 'COMP';
5977 $cust_main->invoice_attn( $cust_main->payname )
5978 if $cust_main->payby eq 'BILL' && $cust_main->payname;
5979 $cust_main->po_number( $cust_main->payinfo )
5980 if $cust_main->payby eq 'BILL' && $cust_main->payinfo;
5982 $cust_main->setfield($_, '') foreach @payfields;
5983 my $error = $cust_main->replace;
5984 die "Error upgradging payment information for custnum ".
5985 $cust_main->custnum. ": $error"
5990 FS::upgrade_journal->set_done('cust_main__cust_payby');
5993 FS::cust_main::Location->_upgrade_data(%opts);
5995 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5997 foreach my $cust_main ( qsearch({
5998 'table' => 'cust_main',
6000 'extra_sql' => 'WHERE '.
6002 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
6003 qw( first last company )
6006 my $error = $cust_main->replace;
6007 die $error if $error;
6010 FS::upgrade_journal->set_done('cust_main__trimspaces');
6014 $class->_upgrade_otaker(%opts);
6016 # turn on encryption as part of regular upgrade, so all new records are immediately encrypted
6017 # existing records will be encrypted in queueable_upgrade (below)
6018 unless ($conf->exists('encryptionpublickey') || $conf->exists('encryptionprivatekey')) {
6019 eval "use FS::Setup";
6021 FS::Setup::enable_encryption();
6026 sub queueable_upgrade {
6029 ### encryption gets turned on in _upgrade_data, above
6031 eval "use FS::upgrade_journal";
6034 # prior to 2013 (commit f16665c9) payinfo was stored in history if not encrypted,
6035 # clear that out before encrypting/tokenizing anything else
6036 if (!FS::upgrade_journal->is_done('clear_payinfo_history')) {
6037 foreach my $table ('cust_payby','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
6038 my $sql = 'UPDATE h_'.$table.' SET payinfo = NULL WHERE payinfo IS NOT NULL';
6039 my $sth = dbh->prepare($sql) or die dbh->errstr;
6040 $sth->execute or die $sth->errstr;
6042 FS::upgrade_journal->set_done('clear_payinfo_history');
6045 # fix Tokenized paycardtype and encrypt old records
6046 if ( ! FS::upgrade_journal->is_done('paycardtype_Tokenized')
6047 || ! FS::upgrade_journal->is_done('encryption_check')
6051 # allow replacement of closed cust_pay/cust_refund records
6052 local $FS::payinfo_Mixin::allow_closed_replace = 1;
6054 # because it looks like nothing's changing
6055 local $FS::Record::no_update_diff = 1;
6057 # commit everything immediately
6058 local $FS::UID::AutoCommit = 1;
6060 # encrypt what's there
6061 foreach my $table ('cust_payby','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
6062 my $tclass = 'FS::'.$table;
6065 while (my $recnum = _upgrade_next_recnum(dbh,$table,\$lastrecnum,\@recnums)) {
6066 my $record = $tclass->by_key($recnum);
6067 next unless $record; # small chance it's been deleted, that's ok
6068 next unless grep { $record->payby eq $_ } @FS::Record::encrypt_payby;
6069 # window for possible conflict is practically nonexistant,
6070 # but just in case...
6071 $record = $record->select_for_update;
6072 if (!$record->custnum && $table eq 'cust_pay_pending') {
6073 $record->set('custnum_pending',1);
6075 $record->paycardtype('') if $record->paycardtype eq 'Tokenized';
6077 local($ignore_expired_card) = 1;
6078 local($ignore_banned_card) = 1;
6079 local($skip_fuzzyfiles) = 1;
6080 local($import) = 1;#prevent automatic geocoding (need its own variable?)
6082 my $error = $record->replace;
6083 die "Error replacing $table ".$record->get($record->primary_key).": $error" if $error;
6087 FS::upgrade_journal->set_done('paycardtype_Tokenized');
6088 FS::upgrade_journal->set_done('encryption_check') if $conf->exists('encryption');
6091 # now that everything's encrypted, tokenize...
6092 FS::cust_main::Billing_Realtime::token_check(@_);
6095 # not entirely false laziness w/ Billing_Realtime::_token_check_next_recnum
6096 # cust_payby might get deleted while this runs
6098 sub _upgrade_next_recnum {
6099 my ($dbh,$table,$lastrecnum,$recnums) = @_;
6100 my $recnum = shift @$recnums;
6101 return $recnum if $recnum;
6102 my $tclass = 'FS::'.$table;
6103 my $paycardtypecheck = ($table ne 'cust_pay_pending') ? q( OR paycardtype = 'Tokenized') : '';
6104 my $sql = 'SELECT '.$tclass->primary_key.
6106 ' WHERE '.$tclass->primary_key.' > '.$$lastrecnum.
6107 " AND payby IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
6108 " AND ( length(payinfo) < 80$paycardtypecheck ) ".
6109 ' ORDER BY '.$tclass->primary_key.' LIMIT 500';
6110 my $sth = $dbh->prepare($sql) or die $dbh->errstr;
6111 $sth->execute() or die $sth->errstr;
6113 while (my $rec = $sth->fetchrow_hashref) {
6114 push @$recnums, $rec->{$tclass->primary_key};
6117 $$lastrecnum = $$recnums[-1];
6118 return shift @$recnums;
6127 The delete method should possibly take an FS::cust_main object reference
6128 instead of a scalar customer number.
6130 Bill and collect options should probably be passed as references instead of a
6133 There should probably be a configuration file with a list of allowed credit
6136 No multiple currency support (probably a larger project than just this module).
6138 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
6140 Birthdates rely on negative epoch values.
6142 The payby for card/check batches is broken. With mixed batching, bad
6145 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
6149 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
6150 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
6151 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.