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.
2308 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2311 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2313 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2314 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2315 of a list of pkgparts; the hashref has the following keys:
2319 =item pkgparts - listref of pkgparts
2321 =item (other options are passed to the suspend method)
2326 Returns a list: an empty list on success or a list of errors.
2330 sub suspend_if_pkgpart {
2332 my (@pkgparts, %opt);
2333 if (ref($_[0]) eq 'HASH'){
2334 @pkgparts = @{$_[0]{pkgparts}};
2339 grep { $_->suspend(%opt) }
2340 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2341 $self->unsuspended_pkgs;
2344 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2346 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2347 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2348 instead of a list of pkgparts; the hashref has the following keys:
2352 =item pkgparts - listref of pkgparts
2354 =item (other options are passed to the suspend method)
2358 Returns a list: an empty list on success or a list of errors.
2362 sub suspend_unless_pkgpart {
2364 my (@pkgparts, %opt);
2365 if (ref($_[0]) eq 'HASH'){
2366 @pkgparts = @{$_[0]{pkgparts}};
2371 grep { $_->suspend(%opt) }
2372 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2373 $self->unsuspended_pkgs;
2376 =item cancel [ OPTION => VALUE ... ]
2378 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2379 The cancellation time will be now.
2383 Always returns a list: an empty list on success or a list of errors.
2390 warn "$me cancel called on customer ". $self->custnum. " with options ".
2391 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2393 my @pkgs = $self->ncancelled_pkgs;
2395 $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2398 =item cancel_pkgs OPTIONS
2400 Cancels a specified list of packages. OPTIONS can include:
2404 =item cust_pkg - an arrayref of the packages. Required.
2406 =item time - the cancellation time, used to calculate final bills and
2407 unused-time credits if any. Will be passed through to the bill() and
2408 FS::cust_pkg::cancel() methods.
2410 =item quiet - can be set true to supress email cancellation notices.
2412 =item reason - can be set to a cancellation reason (see L<FS::reason>), either a
2413 reasonnum of an existing reason, or passing a hashref will create a new reason.
2414 The hashref should have the following keys:
2415 typenum - Reason type (see L<FS::reason_type>)
2416 reason - Text of the new reason.
2418 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2419 for the individual packages, parallel to the C<cust_pkg> argument. The
2420 reason and reason_otaker arguments will be taken from those objects.
2422 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2424 =item nobill - can be set true to skip billing if it might otherwise be done.
2429 my( $self, %opt ) = @_;
2431 # we're going to cancel services, which is not reversible
2432 # unless exports are suppressed
2433 die "cancel_pkgs cannot be run inside a transaction"
2434 if !$FS::UID::AutoCommit && !$FS::svc_Common::noexport_hack;
2436 my $oldAutoCommit = $FS::UID::AutoCommit;
2437 local $FS::UID::AutoCommit = 0;
2439 savepoint_create('cancel_pkgs');
2441 return ( 'access denied' )
2442 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2444 if ( $opt{'ban'} ) {
2446 foreach my $cust_payby ( $self->cust_payby ) {
2448 #well, if they didn't get decrypted on search, then we don't have to
2449 # try again... queue a job for the server that does have decryption
2450 # capability if we're in a paranoid multi-server implementation?
2451 return ( "Can't (yet) ban encrypted credit cards" )
2452 if $cust_payby->is_encrypted($cust_payby->payinfo);
2454 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2455 my $error = $ban->insert;
2457 savepoint_rollback_and_release('cancel_pkgs');
2458 dbh->rollback if $oldAutoCommit;
2466 my @pkgs = @{ delete $opt{'cust_pkg'} };
2467 my $cancel_time = $opt{'time'} || time;
2469 # bill all packages first, so we don't lose usage, service counts for
2470 # bulk billing, etc.
2471 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2473 my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2475 'time' => $cancel_time );
2477 warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2478 savepoint_rollback_and_release('cancel_pkgs');
2479 dbh->rollback if $oldAutoCommit;
2480 return ( "Error billing during cancellation: $error" );
2483 savepoint_release('cancel_pkgs');
2484 dbh->commit if $oldAutoCommit;
2487 # now cancel all services, the same way we would for individual packages.
2488 # if any of them fail, cancel the rest anyway.
2489 my @cust_svc = map { $_->cust_svc } @pkgs;
2490 my @sorted_cust_svc =
2492 sort { $a->[1] <=> $b->[1] }
2493 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2495 warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2499 foreach my $cust_svc (@sorted_cust_svc) {
2500 my $savepoint = 'cancel_pkgs_'.$i++;
2501 savepoint_create( $savepoint );
2502 my $part_svc = $cust_svc->part_svc;
2503 next if ( defined($part_svc) and $part_svc->preserve );
2504 # immediate cancel, no date option
2505 # transactionize individually
2506 my $error = try { $cust_svc->cancel } catch { $_ };
2508 savepoint_rollback_and_release( $savepoint );
2509 dbh->rollback if $oldAutoCommit;
2510 push @errors, $error;
2512 savepoint_release( $savepoint );
2513 dbh->commit if $oldAutoCommit;
2520 warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2521 $self->custnum. "\n"
2525 if ($opt{'cust_pkg_reason'}) {
2526 @cprs = @{ delete $opt{'cust_pkg_reason'} };
2532 my $savepoint = 'cancel_pkgs_'.$i++;
2533 savepoint_create( $savepoint );
2535 my $cpr = shift @cprs;
2537 $lopt{'reason'} = $cpr->reasonnum;
2538 $lopt{'reason_otaker'} = $cpr->otaker;
2540 warn "no reason found when canceling package ".$_->pkgnum."\n";
2541 # we're not actually required to pass a reason to cust_pkg::cancel,
2542 # but if we're getting to this point, something has gone awry.
2543 $null_reason ||= FS::reason->new_or_existing(
2544 reason => 'unknown reason',
2545 type => 'Cancel Reason',
2548 $lopt{'reason'} = $null_reason->reasonnum;
2549 $lopt{'reason_otaker'} = $FS::CurrentUser::CurrentUser->username;
2552 my $error = $_->cancel(%lopt);
2554 savepoint_rollback_and_release( $savepoint );
2555 dbh->rollback if $oldAutoCommit;
2556 push @errors, 'pkgnum '.$_->pkgnum.': '.$error;
2558 savepoint_release( $savepoint );
2559 dbh->commit if $oldAutoCommit;
2566 sub _banned_pay_hashref {
2577 'payby' => $payby2ban{$self->payby},
2578 'payinfo' => $self->payinfo,
2579 #don't ever *search* on reason! #'reason' =>
2585 Returns all notes (see L<FS::cust_main_note>) for this customer.
2590 my($self,$orderby_classnum) = (shift,shift);
2591 my $orderby = "sticky DESC, _date DESC";
2592 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2593 qsearch( 'cust_main_note',
2594 { 'custnum' => $self->custnum },
2596 "ORDER BY $orderby",
2602 Returns the agent (see L<FS::agent>) for this customer.
2606 Returns the agent name (see L<FS::agent>) for this customer.
2612 $self->agent->agent;
2617 Returns any tags associated with this customer, as FS::cust_tag objects,
2618 or an empty list if there are no tags.
2622 Returns any tags associated with this customer, as FS::part_tag objects,
2623 or an empty list if there are no tags.
2629 map $_->part_tag, $self->cust_tag;
2635 Returns the customer class, as an FS::cust_class object, or the empty string
2636 if there is no customer class.
2640 Returns the customer category name, or the empty string if there is no customer
2647 my $cust_class = $self->cust_class;
2649 ? $cust_class->categoryname
2655 Returns the customer class name, or the empty string if there is no customer
2662 my $cust_class = $self->cust_class;
2664 ? $cust_class->classname
2670 Returns the external tax status, as an FS::tax_status object, or the empty
2671 string if there is no tax status.
2677 if ( $self->taxstatusnum ) {
2678 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2686 Returns the tax status code if there is one.
2692 my $tax_status = $self->tax_status;
2694 ? $tax_status->taxstatus
2698 =item BILLING METHODS
2700 Documentation on billing methods has been moved to
2701 L<FS::cust_main::Billing>.
2703 =item REALTIME BILLING METHODS
2705 Documentation on realtime billing methods has been moved to
2706 L<FS::cust_main::Billing_Realtime>.
2710 Removes the I<paycvv> field from the database directly.
2712 If there is an error, returns the error, otherwise returns false.
2714 DEPRECATED. Use L</remove_cvv_from_cust_payby> instead.
2720 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2721 or return dbh->errstr;
2722 $sth->execute($self->custnum)
2723 or return $sth->errstr;
2730 Returns the total owed for this customer on all invoices
2731 (see L<FS::cust_bill/owed>).
2737 $self->total_owed_date(2145859200); #12/31/2037
2740 =item total_owed_date TIME
2742 Returns the total owed for this customer on all invoices with date earlier than
2743 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2744 see L<Time::Local> and L<Date::Parse> for conversion functions.
2748 sub total_owed_date {
2752 my $custnum = $self->custnum;
2754 my $owed_sql = FS::cust_bill->owed_sql;
2757 SELECT SUM($owed_sql) FROM cust_bill
2758 WHERE custnum = $custnum
2762 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2766 =item total_owed_pkgnum PKGNUM
2768 Returns the total owed on all invoices for this customer's specific package
2769 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2773 sub total_owed_pkgnum {
2774 my( $self, $pkgnum ) = @_;
2775 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2778 =item total_owed_date_pkgnum TIME PKGNUM
2780 Returns the total owed for this customer's specific package when using
2781 experimental package balances on all invoices with date earlier than
2782 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2783 see L<Time::Local> and L<Date::Parse> for conversion functions.
2787 sub total_owed_date_pkgnum {
2788 my( $self, $time, $pkgnum ) = @_;
2791 foreach my $cust_bill (
2792 grep { $_->_date <= $time }
2793 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2795 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2797 sprintf( "%.2f", $total_bill );
2803 Returns the total amount of all payments.
2810 $total += $_->paid foreach $self->cust_pay;
2811 sprintf( "%.2f", $total );
2814 =item total_unapplied_credits
2816 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2817 customer. See L<FS::cust_credit/credited>.
2819 =item total_credited
2821 Old name for total_unapplied_credits. Don't use.
2825 sub total_credited {
2826 #carp "total_credited deprecated, use total_unapplied_credits";
2827 shift->total_unapplied_credits(@_);
2830 sub total_unapplied_credits {
2833 my $custnum = $self->custnum;
2835 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2838 SELECT SUM($unapplied_sql) FROM cust_credit
2839 WHERE custnum = $custnum
2842 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2846 =item total_unapplied_credits_pkgnum PKGNUM
2848 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2849 customer. See L<FS::cust_credit/credited>.
2853 sub total_unapplied_credits_pkgnum {
2854 my( $self, $pkgnum ) = @_;
2855 my $total_credit = 0;
2856 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2857 sprintf( "%.2f", $total_credit );
2861 =item total_unapplied_payments
2863 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2864 See L<FS::cust_pay/unapplied>.
2868 sub total_unapplied_payments {
2871 my $custnum = $self->custnum;
2873 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2876 SELECT SUM($unapplied_sql) FROM cust_pay
2877 WHERE custnum = $custnum
2880 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2884 =item total_unapplied_payments_pkgnum PKGNUM
2886 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2887 specific package when using experimental package balances. See
2888 L<FS::cust_pay/unapplied>.
2892 sub total_unapplied_payments_pkgnum {
2893 my( $self, $pkgnum ) = @_;
2894 my $total_unapplied = 0;
2895 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2896 sprintf( "%.2f", $total_unapplied );
2900 =item total_unapplied_refunds
2902 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2903 customer. See L<FS::cust_refund/unapplied>.
2907 sub total_unapplied_refunds {
2909 my $custnum = $self->custnum;
2911 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2914 SELECT SUM($unapplied_sql) FROM cust_refund
2915 WHERE custnum = $custnum
2918 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2924 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2925 total_unapplied_credits minus total_unapplied_payments).
2931 $self->balance_date_range;
2934 =item balance_date TIME
2936 Returns the balance for this customer, only considering invoices with date
2937 earlier than TIME (total_owed_date minus total_credited minus
2938 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2939 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2946 $self->balance_date_range(shift);
2949 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2951 Returns the balance for this customer, optionally considering invoices with
2952 date earlier than START_TIME, and not later than END_TIME
2953 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2955 Times are specified as SQL fragments or numeric
2956 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2957 L<Date::Parse> for conversion functions. The empty string can be passed
2958 to disable that time constraint completely.
2960 Accepts the same options as L</balance_date_sql>:
2964 =item unapplied_date
2966 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)
2970 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2971 time will be ignored. Note that START_TIME and END_TIME only limit the date
2972 range for invoices and I<unapplied> payments, credits, and refunds.
2978 sub balance_date_range {
2980 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2981 ') FROM cust_main WHERE custnum='. $self->custnum;
2982 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2985 =item balance_pkgnum PKGNUM
2987 Returns the balance for this customer's specific package when using
2988 experimental package balances (total_owed plus total_unrefunded, minus
2989 total_unapplied_credits minus total_unapplied_payments)
2993 sub balance_pkgnum {
2994 my( $self, $pkgnum ) = @_;
2997 $self->total_owed_pkgnum($pkgnum)
2998 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2999 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
3000 - $self->total_unapplied_credits_pkgnum($pkgnum)
3001 - $self->total_unapplied_payments_pkgnum($pkgnum)
3007 Returns a hash of useful information for making a payment.
3017 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
3018 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
3019 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
3023 For credit card transactions:
3035 For electronic check transactions:
3050 $return{balance} = $self->balance;
3052 $return{payname} = $self->payname
3053 || ( $self->first. ' '. $self->get('last') );
3055 $return{$_} = $self->bill_location->$_
3056 for qw(address1 address2 city state zip);
3058 $return{payby} = $self->payby;
3059 $return{stateid_state} = $self->stateid_state;
3061 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
3062 $return{card_type} = cardtype($self->payinfo);
3063 $return{payinfo} = $self->paymask;
3065 @return{'month', 'year'} = $self->paydate_monthyear;
3069 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
3070 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
3071 $return{payinfo1} = $payinfo1;
3072 $return{payinfo2} = $payinfo2;
3073 $return{paytype} = $self->paytype;
3074 $return{paystate} = $self->paystate;
3078 #doubleclick protection
3080 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3088 Returns the next payment expiration date for this customer. If they have no
3089 payment methods that will expire, returns 0.
3095 # filter out the ones that individually return 0, but then return 0 if
3096 # there are no results
3097 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
3098 min( @epochs ) || 0;
3101 =item paydate_epoch_sql
3103 Returns an SQL expression to get the next payment expiration date for a
3104 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
3105 dates, so that it's safe to test for "will it expire before date X" for any
3110 sub paydate_epoch_sql {
3112 my $paydate = FS::cust_payby->paydate_epoch_sql;
3113 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
3117 my( $self, $taxname ) = @_;
3119 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3120 'taxname' => $taxname,
3125 =item cust_main_exemption
3127 =item invoicing_list
3129 Returns a list of email addresses (with svcnum entries expanded), and the word
3130 'POST' if the customer receives postal invoices.
3134 sub invoicing_list {
3135 my( $self, $arrayref ) = @_;
3138 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
3141 my @emails = $self->invoicing_list_emailonly;
3142 push @emails, 'POST' if $self->get('postal_invoice');
3147 =item check_invoicing_list ARRAYREF
3149 Checks these arguements as valid input for the invoicing_list method. If there
3150 is an error, returns the error, otherwise returns false.
3154 sub check_invoicing_list {
3155 my( $self, $arrayref ) = @_;
3157 foreach my $address ( @$arrayref ) {
3159 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3160 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3163 my $cust_main_invoice = new FS::cust_main_invoice ( {
3164 'custnum' => $self->custnum,
3167 my $error = $self->custnum
3168 ? $cust_main_invoice->check
3169 : $cust_main_invoice->checkdest
3171 return $error if $error;
3175 return "Email address required"
3176 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3177 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3184 Returns the email addresses of all accounts provisioned for this customer.
3191 foreach my $cust_pkg ( $self->all_pkgs ) {
3192 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3194 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3195 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3197 $list{$_}=1 foreach map { $_->email } @svc_acct;
3202 =item invoicing_list_addpost
3204 Adds postal invoicing to this customer. If this customer is already configured
3205 to receive postal invoices, does nothing.
3209 sub invoicing_list_addpost {
3211 if ( $self->get('postal_invoice') eq '' ) {
3212 $self->set('postal_invoice', 'Y');
3213 my $error = $self->replace;
3214 warn $error if $error; # should fail harder, but this is traditional
3218 =item invoicing_list_emailonly
3220 Returns the list of email invoice recipients (invoicing_list without non-email
3221 destinations such as POST and FAX).
3225 sub invoicing_list_emailonly {
3227 warn "$me invoicing_list_emailonly called"
3229 return () if !$self->custnum; # not yet inserted
3230 return map { $_->emailaddress }
3232 table => 'cust_contact',
3233 select => 'emailaddress',
3234 addl_from => ' JOIN contact USING (contactnum) '.
3235 ' JOIN contact_email USING (contactnum)',
3236 hashref => { 'custnum' => $self->custnum, },
3237 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
3241 =item invoicing_list_emailonly_scalar
3243 Returns the list of email invoice recipients (invoicing_list without non-email
3244 destinations such as POST and FAX) as a comma-separated scalar.
3248 sub invoicing_list_emailonly_scalar {
3250 warn "$me invoicing_list_emailonly_scalar called"
3252 join(', ', $self->invoicing_list_emailonly);
3255 =item contact_list [ CLASSNUM, DEST_FLAG... ]
3257 Returns a list of contacts (L<FS::contact> objects) for the customer.
3259 If no arguments are given, returns all contacts for the customer.
3261 Arguments may contain classnums. When classnums are specified, only
3262 contacts with a matching cust_contact.classnum are returned. When a
3263 classnum of 0 is given, contacts with a null classnum are also included.
3265 Arguments may also contain the dest flag names 'invoice' or 'message'.
3266 If given, contacts who's invoice_dest and/or message_dest flags are
3267 not set to 'Y' will be excluded.
3275 select => join(', ',(
3277 'cust_contact.invoice_dest',
3278 'cust_contact.message_dest',
3280 addl_from => ' JOIN cust_contact USING (contactnum)',
3281 extra_sql => ' WHERE cust_contact.custnum = '.$self->custnum,
3285 # Calling methods were relying on this method to use invoice_dest to
3286 # block e-mail messages. Depending on parameters, this may or may not
3287 # have actually happened.
3289 # The bug could cause this SQL to be used to filter e-mail addresses:
3292 # cust_contact.classnums IN (1,2,3)
3293 # OR cust_contact.invoice_dest = 'Y'
3296 # improperly including everybody with the opt-in flag AND everybody
3297 # in the contact classes
3299 # Possibility to introduce new bugs:
3300 # If callers of this method called it incorrectly, and didn't notice
3301 # because it seemed to send the e-mails they wanted.
3306 # cust_contact.classnum IN (1,2,3)
3308 # cust_contact.classnum IS NULL
3311 # cust_contact.invoice_dest = 'Y'
3313 # cust_contact.message_dest = 'Y'
3321 if ($_ eq 'invoice' || $_ eq 'message') {
3322 push @and_dest, " cust_contact.${_}_dest = 'Y' ";
3323 } elsif ($_ eq '0') {
3324 push @or_classnum, ' cust_contact.classnum IS NULL ';
3325 } elsif ( /^\d+$/ ) {
3326 push @classnums, $_;
3328 croak "bad classnum argument '$_'";
3332 push @or_classnum, 'cust_contact.classnum IN ('.join(',',@classnums).')'
3335 if (@or_classnum || @and_dest) { # catch, no arguments given
3336 $search->{extra_sql} .= ' AND ( ';
3339 $search->{extra_sql} .= ' ( ';
3340 $search->{extra_sql} .= join ' OR ', map {" $_ "} @or_classnum;
3341 $search->{extra_sql} .= ' ) ';
3342 $search->{extra_sql} .= ' AND ( ' if @and_dest;
3346 $search->{extra_sql} .= join ' OR ', map {" $_ "} @and_dest;
3347 $search->{extra_sql} .= ' ) ' if @or_classnum;
3350 $search->{extra_sql} .= ' ) ';
3352 warn "\$extra_sql: $search->{extra_sql} \n" if $DEBUG;
3358 =item contact_list_email [ CLASSNUM, ... ]
3360 Same as L</contact_list>, but returns email destinations instead of contact
3365 sub contact_list_email {
3367 my @contacts = $self->contact_list(@_);
3369 foreach my $contact (@contacts) {
3370 foreach my $contact_email ($contact->contact_email) {
3371 push @emails, Email::Address->new( $contact->firstlast,
3372 $contact_email->emailaddress
3379 =item referral_custnum_cust_main
3381 Returns the customer who referred this customer (or the empty string, if
3382 this customer was not referred).
3384 Note the difference with referral_cust_main method: This method,
3385 referral_custnum_cust_main returns the single customer (if any) who referred
3386 this customer, while referral_cust_main returns an array of customers referred
3391 sub referral_custnum_cust_main {
3393 return '' unless $self->referral_custnum;
3394 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3397 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3399 Returns an array of customers referred by this customer (referral_custnum set
3400 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3401 customers referred by customers referred by this customer and so on, inclusive.
3402 The default behavior is DEPTH 1 (no recursion).
3404 Note the difference with referral_custnum_cust_main method: This method,
3405 referral_cust_main, returns an array of customers referred BY this customer,
3406 while referral_custnum_cust_main returns the single customer (if any) who
3407 referred this customer.
3411 sub referral_cust_main {
3413 my $depth = @_ ? shift : 1;
3414 my $exclude = @_ ? shift : {};
3417 map { $exclude->{$_->custnum}++; $_; }
3418 grep { ! $exclude->{ $_->custnum } }
3419 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3423 map { $_->referral_cust_main($depth-1, $exclude) }
3430 =item referral_cust_main_ncancelled
3432 Same as referral_cust_main, except only returns customers with uncancelled
3437 sub referral_cust_main_ncancelled {
3439 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3442 =item referral_cust_pkg [ DEPTH ]
3444 Like referral_cust_main, except returns a flat list of all unsuspended (and
3445 uncancelled) packages for each customer. The number of items in this list may
3446 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3450 sub referral_cust_pkg {
3452 my $depth = @_ ? shift : 1;
3454 map { $_->unsuspended_pkgs }
3455 grep { $_->unsuspended_pkgs }
3456 $self->referral_cust_main($depth);
3459 =item referring_cust_main
3461 Returns the single cust_main record for the customer who referred this customer
3462 (referral_custnum), or false.
3466 sub referring_cust_main {
3468 return '' unless $self->referral_custnum;
3469 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3472 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3474 Applies a credit to this customer. If there is an error, returns the error,
3475 otherwise returns false.
3477 REASON can be a text string, an FS::reason object, or a scalar reference to
3478 a reasonnum. If a text string, it will be automatically inserted as a new
3479 reason, and a 'reason_type' option must be passed to indicate the
3480 FS::reason_type for the new reason.
3482 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3483 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3484 I<commission_pkgnum>.
3486 Any other options are passed to FS::cust_credit::insert.
3491 my( $self, $amount, $reason, %options ) = @_;
3493 my $cust_credit = new FS::cust_credit {
3494 'custnum' => $self->custnum,
3495 'amount' => $amount,
3498 if ( ref($reason) ) {
3500 if ( ref($reason) eq 'SCALAR' ) {
3501 $cust_credit->reasonnum( $$reason );
3503 $cust_credit->reasonnum( $reason->reasonnum );
3507 $cust_credit->set('reason', $reason)
3510 $cust_credit->$_( delete $options{$_} )
3511 foreach grep exists($options{$_}),
3512 qw( addlinfo eventnum ),
3513 map "commission_$_", qw( agentnum salesnum pkgnum );
3515 $cust_credit->insert(%options);
3519 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3521 Creates a one-time charge for this customer. If there is an error, returns
3522 the error, otherwise returns false.
3524 New-style, with a hashref of options:
3526 my $error = $cust_main->charge(
3530 'start_date' => str2time('7/4/2009'),
3531 'pkg' => 'Description',
3532 'comment' => 'Comment',
3533 'additional' => [], #extra invoice detail
3534 'classnum' => 1, #pkg_class
3536 'setuptax' => '', # or 'Y' for tax exempt
3538 'locationnum'=> 1234, # optional
3541 'taxclass' => 'Tax class',
3544 'taxproduct' => 2, #part_pkg_taxproduct
3545 'override' => {}, #XXX describe
3547 #will be filled in with the new object
3548 'cust_pkg_ref' => \$cust_pkg,
3550 #generate an invoice immediately
3552 'invoice_terms' => '', #with these terms
3558 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3562 #super false laziness w/quotation::charge
3565 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3566 my ( $pkg, $comment, $additional );
3567 my ( $setuptax, $taxclass ); #internal taxes
3568 my ( $taxproduct, $override ); #vendor (CCH) taxes
3570 my $separate_bill = '';
3571 my $cust_pkg_ref = '';
3572 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3574 my ( $discountnum, $discountnum_amount, $discountnum_percent ) = ( '','','' );
3575 if ( ref( $_[0] ) ) {
3576 $amount = $_[0]->{amount};
3577 $setup_cost = $_[0]->{setup_cost};
3578 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3579 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3580 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3581 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3582 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3583 : '$'. sprintf("%.2f",$amount);
3584 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3585 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3586 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3587 $additional = $_[0]->{additional} || [];
3588 $taxproduct = $_[0]->{taxproductnum};
3589 $override = { '' => $_[0]->{tax_override} };
3590 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3591 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3592 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3593 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3594 $separate_bill = $_[0]->{separate_bill} || '';
3595 $discountnum = $_[0]->{setup_discountnum};
3596 $discountnum_amount = $_[0]->{setup_discountnum_amount};
3597 $discountnum_percent = $_[0]->{setup_discountnum_percent};
3603 $pkg = @_ ? shift : 'One-time charge';
3604 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3606 $taxclass = @_ ? shift : '';
3610 local $SIG{HUP} = 'IGNORE';
3611 local $SIG{INT} = 'IGNORE';
3612 local $SIG{QUIT} = 'IGNORE';
3613 local $SIG{TERM} = 'IGNORE';
3614 local $SIG{TSTP} = 'IGNORE';
3615 local $SIG{PIPE} = 'IGNORE';
3617 my $oldAutoCommit = $FS::UID::AutoCommit;
3618 local $FS::UID::AutoCommit = 0;
3621 my $part_pkg = new FS::part_pkg ( {
3623 'comment' => $comment,
3627 'classnum' => ( $classnum ? $classnum : '' ),
3628 'setuptax' => $setuptax,
3629 'taxclass' => $taxclass,
3630 'taxproductnum' => $taxproduct,
3631 'setup_cost' => $setup_cost,
3634 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3635 ( 0 .. @$additional - 1 )
3637 'additional_count' => scalar(@$additional),
3638 'setup_fee' => $amount,
3641 my $error = $part_pkg->insert( options => \%options,
3642 tax_overrides => $override,
3645 $dbh->rollback if $oldAutoCommit;
3649 my $pkgpart = $part_pkg->pkgpart;
3650 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3651 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3652 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3653 $error = $type_pkgs->insert;
3655 $dbh->rollback if $oldAutoCommit;
3660 my $cust_pkg = new FS::cust_pkg ( {
3661 'custnum' => $self->custnum,
3662 'pkgpart' => $pkgpart,
3663 'quantity' => $quantity,
3664 'start_date' => $start_date,
3665 'no_auto' => $no_auto,
3666 'separate_bill' => $separate_bill,
3667 'locationnum' => $locationnum,
3668 'setup_discountnum' => $discountnum,
3669 'setup_discountnum_amount' => $discountnum_amount,
3670 'setup_discountnum_percent' => $discountnum_percent,
3673 $error = $cust_pkg->insert;
3675 $dbh->rollback if $oldAutoCommit;
3677 } elsif ( $cust_pkg_ref ) {
3678 ${$cust_pkg_ref} = $cust_pkg;
3682 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3683 'pkg_list' => [ $cust_pkg ],
3686 $dbh->rollback if $oldAutoCommit;
3691 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3696 #=item charge_postal_fee
3698 #Applies a one time charge this customer. If there is an error,
3699 #returns the error, returns the cust_pkg charge object or false
3700 #if there was no charge.
3704 # This should be a customer event. For that to work requires that bill
3705 # also be a customer event.
3707 sub charge_postal_fee {
3710 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3711 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3713 my $cust_pkg = new FS::cust_pkg ( {
3714 'custnum' => $self->custnum,
3715 'pkgpart' => $pkgpart,
3719 my $error = $cust_pkg->insert;
3720 $error ? $error : $cust_pkg;
3723 =item num_cust_attachment_deleted
3725 Returns the number of deleted attachments for this customer (see
3726 L<FS::num_cust_attachment>).
3730 sub num_cust_attachments_deleted {
3733 " SELECT COUNT(*) FROM cust_attachment ".
3734 " WHERE custnum = ? AND disabled IS NOT NULL AND disabled > 0",
3741 Returns the most recent invnum (invoice number) for this customer.
3748 " SELECT MAX(invnum) FROM cust_bill WHERE custnum = ?",
3753 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3755 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3757 Optionally, a list or hashref of additional arguments to the qsearch call can
3764 my $opt = ref($_[0]) ? shift : { @_ };
3766 #return $self->num_cust_bill unless wantarray || keys %$opt;
3768 $opt->{'table'} = 'cust_bill';
3769 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3770 $opt->{'hashref'}{'custnum'} = $self->custnum;
3771 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3773 map { $_ } #behavior of sort undefined in scalar context
3774 sort { $a->_date <=> $b->_date }
3778 =item open_cust_bill
3780 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3785 sub open_cust_bill {
3789 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3795 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3797 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3801 sub legacy_cust_bill {
3804 #return $self->num_legacy_cust_bill unless wantarray;
3806 map { $_ } #behavior of sort undefined in scalar context
3807 sort { $a->_date <=> $b->_date }
3808 qsearch({ 'table' => 'legacy_cust_bill',
3809 'hashref' => { 'custnum' => $self->custnum, },
3810 'order_by' => 'ORDER BY _date ASC',
3814 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3816 Returns all the statements (see L<FS::cust_statement>) for this customer.
3818 Optionally, a list or hashref of additional arguments to the qsearch call can
3823 =item cust_bill_void
3825 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3829 sub cust_bill_void {
3832 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3833 sort { $a->_date <=> $b->_date }
3834 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3837 sub cust_statement {
3839 my $opt = ref($_[0]) ? shift : { @_ };
3841 #return $self->num_cust_statement unless wantarray || keys %$opt;
3843 $opt->{'table'} = 'cust_statement';
3844 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3845 $opt->{'hashref'}{'custnum'} = $self->custnum;
3846 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3848 map { $_ } #behavior of sort undefined in scalar context
3849 sort { $a->_date <=> $b->_date }
3853 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3855 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3857 Optionally, a list or hashref of additional arguments to the qsearch call can
3858 be passed following the SVCDB.
3865 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3866 warn "$me svc_x requires a svcdb";
3869 my $opt = ref($_[0]) ? shift : { @_ };
3871 $opt->{'table'} = $svcdb;
3872 $opt->{'addl_from'} =
3873 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3874 ($opt->{'addl_from'} || '');
3876 my $custnum = $self->custnum;
3877 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3878 my $where = "cust_pkg.custnum = $custnum";
3880 my $extra_sql = $opt->{'extra_sql'} || '';
3881 if ( keys %{ $opt->{'hashref'} } ) {
3882 $extra_sql = " AND $where $extra_sql";
3885 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3886 $extra_sql = "WHERE $where AND $1";
3889 $extra_sql = "WHERE $where $extra_sql";
3892 $opt->{'extra_sql'} = $extra_sql;
3897 # required for use as an eventtable;
3900 $self->svc_x('svc_acct', @_);
3905 Returns all the credits (see L<FS::cust_credit>) for this customer.
3912 #return $self->num_cust_credit unless wantarray;
3914 map { $_ } #behavior of sort undefined in scalar context
3915 sort { $a->_date <=> $b->_date }
3916 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3919 =item cust_credit_pkgnum
3921 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3922 package when using experimental package balances.
3926 sub cust_credit_pkgnum {
3927 my( $self, $pkgnum ) = @_;
3928 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3929 sort { $a->_date <=> $b->_date }
3930 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3931 'pkgnum' => $pkgnum,
3936 =item cust_credit_void
3938 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3942 sub cust_credit_void {
3945 sort { $a->_date <=> $b->_date }
3946 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3951 Returns all the payments (see L<FS::cust_pay>) for this customer.
3957 my $opt = ref($_[0]) ? shift : { @_ };
3959 return $self->num_cust_pay unless wantarray || keys %$opt;
3961 $opt->{'table'} = 'cust_pay';
3962 $opt->{'hashref'}{'custnum'} = $self->custnum;
3964 map { $_ } #behavior of sort undefined in scalar context
3965 sort { $a->_date <=> $b->_date }
3972 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3973 called automatically when the cust_pay method is used in a scalar context.
3979 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3980 my $sth = dbh->prepare($sql) or die dbh->errstr;
3981 $sth->execute($self->custnum) or die $sth->errstr;
3982 $sth->fetchrow_arrayref->[0];
3985 =item unapplied_cust_pay
3987 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3991 sub unapplied_cust_pay {
3995 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
4001 =item cust_pay_pkgnum
4003 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
4004 package when using experimental package balances.
4008 sub cust_pay_pkgnum {
4009 my( $self, $pkgnum ) = @_;
4010 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
4011 sort { $a->_date <=> $b->_date }
4012 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
4013 'pkgnum' => $pkgnum,
4020 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4026 map { $_ } #return $self->num_cust_pay_void unless wantarray;
4027 sort { $a->_date <=> $b->_date }
4028 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4031 =item cust_pay_pending
4033 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
4034 (without status "done").
4038 sub cust_pay_pending {
4040 return $self->num_cust_pay_pending unless wantarray;
4041 sort { $a->_date <=> $b->_date }
4042 qsearch( 'cust_pay_pending', {
4043 'custnum' => $self->custnum,
4044 'status' => { op=>'!=', value=>'done' },
4049 =item cust_pay_pending_attempt
4051 Returns all payment attempts / declined payments for this customer, as pending
4052 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
4053 a corresponding payment (see L<FS::cust_pay>).
4057 sub cust_pay_pending_attempt {
4059 return $self->num_cust_pay_pending_attempt unless wantarray;
4060 sort { $a->_date <=> $b->_date }
4061 qsearch( 'cust_pay_pending', {
4062 'custnum' => $self->custnum,
4069 =item num_cust_pay_pending
4071 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
4072 customer (without status "done"). Also called automatically when the
4073 cust_pay_pending method is used in a scalar context.
4077 sub num_cust_pay_pending {
4080 " SELECT COUNT(*) FROM cust_pay_pending ".
4081 " WHERE custnum = ? AND status != 'done' ",
4086 =item num_cust_pay_pending_attempt
4088 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
4089 customer, with status "done" but without a corresp. Also called automatically when the
4090 cust_pay_pending method is used in a scalar context.
4094 sub num_cust_pay_pending_attempt {
4097 " SELECT COUNT(*) FROM cust_pay_pending ".
4098 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
4105 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4111 map { $_ } #return $self->num_cust_refund unless wantarray;
4112 sort { $a->_date <=> $b->_date }
4113 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4116 =item display_custnum
4118 Returns the displayed customer number for this customer: agent_custid if
4119 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
4123 sub display_custnum {
4126 return $self->agent_custid
4127 if $default_agent_custid && $self->agent_custid;
4129 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
4133 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
4134 } elsif ( $custnum_display_length ) {
4135 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
4137 return $self->custnum;
4143 Returns a name string for this customer, either "Company (Last, First)" or
4150 my $name = $self->contact;
4151 $name = $self->company. " ($name)" if $self->company;
4155 =item batch_payment_payname
4157 Returns a name string for this customer, either "cust_batch_payment->payname" or "First Last" or "Company,
4158 based on if a company name exists and is the account being used a business account.
4162 sub batch_payment_payname {
4164 my $cust_pay_batch = shift;
4167 if ($cust_pay_batch->{Hash}->{payby} eq "CARD") { $name = $cust_pay_batch->payname; }
4168 else { $name = $self->first .' '. $self->last; }
4170 $name = $self->company
4171 if (($cust_pay_batch->{Hash}->{paytype} eq "Business checking" || $cust_pay_batch->{Hash}->{paytype} eq "Business savings") && $self->company);
4176 =item service_contact
4178 Returns the L<FS::contact> object for this customer that has the 'Service'
4179 contact class, or undef if there is no such contact. Deprecated; don't use
4184 sub service_contact {
4186 if ( !exists($self->{service_contact}) ) {
4187 my $classnum = $self->scalar_sql(
4188 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4189 ) || 0; #if it's zero, qsearchs will return nothing
4190 my $cust_contact = qsearchs('cust_contact', {
4191 'classnum' => $classnum,
4192 'custnum' => $self->custnum,
4194 $self->{service_contact} = $cust_contact->contact if $cust_contact;
4196 $self->{service_contact};
4201 Returns a name string for this (service/shipping) contact, either
4202 "Company (Last, First)" or "Last, First".
4209 my $name = $self->ship_contact;
4210 $name = $self->company. " ($name)" if $self->company;
4216 Returns a name string for this customer, either "Company" or "First Last".
4222 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4225 =item ship_name_short
4227 Returns a name string for this (service/shipping) contact, either "Company"
4232 sub ship_name_short {
4234 $self->service_contact
4235 ? $self->ship_contact_firstlast
4241 Returns this customer's full (billing) contact name only, "Last, First"
4247 $self->get('last'). ', '. $self->first;
4252 Returns this customer's full (shipping) contact name only, "Last, First"
4258 my $contact = $self->service_contact || $self;
4259 $contact->get('last') . ', ' . $contact->get('first');
4262 =item contact_firstlast
4264 Returns this customers full (billing) contact name only, "First Last".
4268 sub contact_firstlast {
4270 $self->first. ' '. $self->get('last');
4273 =item ship_contact_firstlast
4275 Returns this customer's full (shipping) contact name only, "First Last".
4279 sub ship_contact_firstlast {
4281 my $contact = $self->service_contact || $self;
4282 $contact->get('first') . ' '. $contact->get('last');
4285 sub bill_country_full {
4287 $self->bill_location->country_full;
4290 sub ship_country_full {
4292 $self->ship_location->country_full;
4295 =item county_state_county [ PREFIX ]
4297 Returns a string consisting of just the county, state and country.
4301 sub county_state_country {
4304 if ( @_ && $_[0] && $self->has_ship_address ) {
4305 $locationnum = $self->ship_locationnum;
4307 $locationnum = $self->bill_locationnum;
4309 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4310 $cust_location->county_state_country;
4313 =item geocode DATA_VENDOR
4315 Returns a value for the customer location as encoded by DATA_VENDOR.
4316 Currently this only makes sense for "CCH" as DATA_VENDOR.
4324 Returns a status string for this customer, currently:
4330 No packages have ever been ordered. Displayed as "No packages".
4334 Recurring packages all are new (not yet billed).
4338 One or more recurring packages is active.
4342 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
4346 All non-cancelled recurring packages are suspended.
4350 All recurring packages are cancelled.
4354 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4355 cust_main-status_module configuration option.
4359 sub status { shift->cust_status(@_); }
4363 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4364 for my $status ( FS::cust_main->statuses() ) {
4365 my $method = $status.'_sql';
4366 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4367 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4368 $sth->execute( ($self->custnum) x $numnum )
4369 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4370 if ( $sth->fetchrow_arrayref->[0] ) {
4371 $self->hashref->{cust_status} = $status;
4377 =item is_status_delay_cancel
4379 Returns true if customer status is 'suspended'
4380 and all suspended cust_pkg return true for
4381 cust_pkg->is_status_delay_cancel.
4383 This is not a real status, this only meant for hacking display
4384 values, because otherwise treating the customer as suspended is
4385 really the whole point of the delay_cancel option.
4389 sub is_status_delay_cancel {
4391 return 0 unless $self->status eq 'suspended';
4392 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4393 return 0 unless $cust_pkg->is_status_delay_cancel;
4398 =item ucfirst_cust_status
4400 =item ucfirst_status
4402 Deprecated, use the cust_status_label method instead.
4404 Returns the status with the first character capitalized.
4408 sub ucfirst_status {
4409 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4410 local($ucfirst_nowarn) = 1;
4411 shift->ucfirst_cust_status(@_);
4414 sub ucfirst_cust_status {
4415 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4417 ucfirst($self->cust_status);
4420 =item cust_status_label
4424 Returns the display label for this status.
4428 sub status_label { shift->cust_status_label(@_); }
4430 sub cust_status_label {
4432 __PACKAGE__->statuslabels->{$self->cust_status};
4437 Returns a hex triplet color string for this customer's status.
4441 sub statuscolor { shift->cust_statuscolor(@_); }
4443 sub cust_statuscolor {
4445 __PACKAGE__->statuscolors->{$self->cust_status};
4448 =item tickets [ STATUS ]
4450 Returns an array of hashes representing the customer's RT tickets.
4452 An optional status (or arrayref or hashref of statuses) may be specified.
4458 my $status = ( @_ && $_[0] ) ? shift : '';
4460 my $num = $conf->config('cust_main-max_tickets') || 10;
4463 if ( $conf->config('ticket_system') ) {
4464 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4466 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4475 foreach my $priority (
4476 $conf->config('ticket_system-custom_priority_field-values'), ''
4478 last if scalar(@tickets) >= $num;
4480 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4481 $num - scalar(@tickets),
4492 =item appointments [ STATUS ]
4494 Returns an array of hashes representing the customer's RT tickets which
4501 my $status = ( @_ && $_[0] ) ? shift : '';
4503 return () unless $conf->config('ticket_system');
4505 my $queueid = $conf->config('ticket_system-appointment-queueid');
4507 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4516 # Return services representing svc_accts in customer support packages
4517 sub support_services {
4519 my %packages = map { $_ => 1 } $conf->config('support_packages');
4521 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4522 grep { $_->part_svc->svcdb eq 'svc_acct' }
4523 map { $_->cust_svc }
4524 grep { exists $packages{ $_->pkgpart } }
4525 $self->ncancelled_pkgs;
4529 # Return a list of latitude/longitude for one of the services (if any)
4530 sub service_coordinates {
4534 grep { $_->latitude && $_->longitude }
4536 map { $_->cust_svc }
4537 $self->ncancelled_pkgs;
4539 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4544 Returns a masked version of the named field
4549 my ($self,$field) = @_;
4553 'x'x(length($self->getfield($field))-4).
4554 substr($self->getfield($field), (length($self->getfield($field))-4));
4558 =item payment_history
4560 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4561 cust_credit and cust_refund objects. Each hashref has the following fields:
4563 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4565 I<date> - value of _date field, unix timestamp
4567 I<date_pretty> - user-friendly date
4569 I<description> - user-friendly description of item
4571 I<amount> - impact of item on user's balance
4572 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4573 Not to be confused with the native 'amount' field in cust_credit, see below.
4575 I<amount_pretty> - includes money char
4577 I<balance> - customer balance, chronologically as of this item
4579 I<balance_pretty> - includes money char
4581 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4583 I<paid> - amount paid for cust_pay records, undef for other types
4585 I<credit> - amount credited for cust_credit records, undef for other types.
4586 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4588 I<refund> - amount refunded for cust_refund records, undef for other types
4590 The four table-specific keys always have positive values, whether they reflect charges or payments.
4592 The following options may be passed to this method:
4594 I<line_items> - if true, returns charges ('Line item') rather than invoices
4596 I<start_date> - unix timestamp, only include records on or after.
4597 If specified, an item of type 'Previous' will also be included.
4598 It does not have table-specific fields.
4600 I<end_date> - unix timestamp, only include records before
4602 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4604 I<conf> - optional already-loaded FS::Conf object.
4608 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4609 # and also for sending customer statements, which should both be kept customer-friendly.
4610 # If you add anything that shouldn't be passed on through the API or exposed
4611 # to customers, add a new option to include it, don't include it by default
4612 sub payment_history {
4614 my $opt = ref($_[0]) ? $_[0] : { @_ };
4616 my $conf = $$opt{'conf'} || new FS::Conf;
4617 my $money_char = $conf->config("money_char") || '$',
4619 #first load entire history,
4620 #need previous to calculate previous balance
4621 #loading after end_date shouldn't hurt too much?
4623 if ( $$opt{'line_items'} ) {
4625 foreach my $cust_bill ( $self->cust_bill ) {
4628 'type' => 'Line item',
4629 'description' => $_->desc( $self->locale ).
4630 ( $_->sdate && $_->edate
4631 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4632 ' To '. time2str('%d-%b-%Y', $_->edate)
4635 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4636 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4637 'date' => $cust_bill->_date,
4638 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4640 foreach $cust_bill->cust_bill_pkg;
4647 'type' => 'Invoice',
4648 'description' => 'Invoice #'. $_->display_invnum,
4649 'amount' => sprintf('%.2f', $_->charged ),
4650 'charged' => sprintf('%.2f', $_->charged ),
4651 'date' => $_->_date,
4652 'date_pretty' => $self->time2str_local('short', $_->_date ),
4654 foreach $self->cust_bill;
4659 'type' => 'Payment',
4660 'description' => 'Payment', #XXX type
4661 'amount' => sprintf('%.2f', 0 - $_->paid ),
4662 'paid' => sprintf('%.2f', $_->paid ),
4663 'date' => $_->_date,
4664 'date_pretty' => $self->time2str_local('short', $_->_date ),
4666 foreach $self->cust_pay;
4670 'description' => 'Credit', #more info?
4671 'amount' => sprintf('%.2f', 0 -$_->amount ),
4672 'credit' => sprintf('%.2f', $_->amount ),
4673 'date' => $_->_date,
4674 'date_pretty' => $self->time2str_local('short', $_->_date ),
4676 foreach $self->cust_credit;
4680 'description' => 'Refund', #more info? type, like payment?
4681 'amount' => $_->refund,
4682 'refund' => $_->refund,
4683 'date' => $_->_date,
4684 'date_pretty' => $self->time2str_local('short', $_->_date ),
4686 foreach $self->cust_refund;
4688 #put it all in chronological order
4689 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4691 #calculate balance, filter items outside date range
4695 foreach my $item (@history) {
4696 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4697 $balance += $$item{'amount'};
4698 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4699 $previous += $$item{'amount'};
4702 $$item{'balance'} = sprintf("%.2f",$balance);
4703 foreach my $key ( qw(amount balance) ) {
4704 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4709 # start with previous balance, if there was one
4712 'type' => 'Previous',
4713 'description' => 'Previous balance',
4714 'amount' => sprintf("%.2f",$previous),
4715 'balance' => sprintf("%.2f",$previous),
4716 'date' => $$opt{'start_date'},
4717 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4719 #false laziness with above
4720 foreach my $key ( qw(amount balance) ) {
4721 $$item{$key.'_pretty'} = $$item{$key};
4722 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4724 unshift(@out,$item);
4727 @out = reverse @history if $$opt{'reverse_sort'};
4732 =item save_cust_payby
4734 Saves a new cust_payby for this customer, replacing an existing entry only
4735 in select circumstances. Does not validate input.
4737 If auto is specified, marks this as the customer's primary method, or the
4738 specified weight. Existing payment methods have their weight incremented as
4741 If bill_location is specified with auto, also sets location in cust_main.
4743 Will not insert complete duplicates of existing records, or records in which the
4744 only difference from an existing record is to turn off automatic payment (will
4745 return without error.) Will replace existing records in which the only difference
4746 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4747 Fields marked as preserved are optional, and existing values will not be overwritten with
4748 blanks when replacing.
4750 Accepts the following named parameters:
4760 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4764 optional, set higher than 1 for secondary, etc.
4772 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4780 optional, will be preserved when replacing
4788 CARD only, required, FS::cust_location object
4790 =item paystart_month
4792 CARD only, optional, will be preserved when replacing
4796 CARD only, optional, will be preserved when replacing
4800 CARD only, optional, will be preserved when replacing
4804 CARD only, only used if conf cvv-save is set appropriately
4814 =item saved_cust_payby
4816 scalar reference, for returning saved object
4822 #The code for this option is in place, but it's not currently used
4826 # existing cust_payby object to be replaced (must match custnum)
4828 # stateid/stateid_state/ss are not currently supported in cust_payby,
4829 # might not even work properly in 4.x, but will need to work here if ever added
4831 sub save_cust_payby {
4835 my $old = $opt{'replace'};
4836 my $new = new FS::cust_payby { $old ? $old->hash : () };
4837 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4838 $new->set( 'custnum' => $self->custnum );
4840 my $payby = $opt{'payment_payby'};
4841 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4843 # don't allow turning off auto when replacing
4844 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4846 my @check_existing; # payby relevant to this payment_payby
4848 # set payby based on auto
4849 if ( $payby eq 'CARD' ) {
4850 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4851 @check_existing = qw( CARD DCRD );
4852 } elsif ( $payby eq 'CHEK' ) {
4853 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4854 @check_existing = qw( CHEK DCHK );
4857 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4860 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4861 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4862 $new->set( 'payname' => $opt{'payname'} );
4863 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4865 my $conf = new FS::Conf;
4867 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4868 if ( $payby eq 'CARD' &&
4869 ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4870 || $conf->exists('business-onlinepayment-verification')
4873 $new->set( 'paycvv' => $opt{'paycvv'} );
4875 $new->set( 'paycvv' => '');
4878 local $SIG{HUP} = 'IGNORE';
4879 local $SIG{INT} = 'IGNORE';
4880 local $SIG{QUIT} = 'IGNORE';
4881 local $SIG{TERM} = 'IGNORE';
4882 local $SIG{TSTP} = 'IGNORE';
4883 local $SIG{PIPE} = 'IGNORE';
4885 my $oldAutoCommit = $FS::UID::AutoCommit;
4886 local $FS::UID::AutoCommit = 0;
4889 # set fields specific to payment_payby
4890 if ( $payby eq 'CARD' ) {
4891 if ($opt{'bill_location'}) {
4892 $opt{'bill_location'}->set('custnum' => $self->custnum);
4893 my $error = $opt{'bill_location'}->find_or_insert;
4895 $dbh->rollback if $oldAutoCommit;
4898 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4900 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4901 $new->set( $field => $opt{$field} );
4904 foreach my $field ( qw(paytype paystate) ) {
4905 $new->set( $field => $opt{$field} );
4909 # other cust_payby to compare this to
4910 my @existing = $self->cust_payby(@check_existing);
4912 # fields that can overwrite blanks with values, but not values with blanks
4913 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4915 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4917 # generally, we don't want to overwrite existing cust_payby with this,
4918 # but we can replace if we're only marking it auto or adding a preserved field
4919 # and we can avoid saving a total duplicate or merely turning off auto
4921 foreach my $cust_payby (@existing) {
4922 # check fields that absolutely should not change
4923 foreach my $field ($new->fields) {
4924 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4925 next if grep(/^$field$/, @preserve );
4926 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4927 # check if paymask exists, if so stop and don't save, no need for a duplicate.
4928 return '' if $new->get('paymask') eq $cust_payby->get('paymask');
4930 # now check fields that can replace if one value is blank
4932 foreach my $field (@preserve) {
4934 ( $new->get($field) and !$cust_payby->get($field) ) or
4935 ( $cust_payby->get($field) and !$new->get($field) )
4937 # prevention of overwriting values with blanks happens farther below
4939 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4943 unless ( $replace ) {
4944 # nearly identical, now check weight
4945 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4946 # ignore identical cust_payby, and ignore attempts to turn off auto
4947 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4948 $skip_cust_payby = 1;
4951 # otherwise, only change is to mark this as primary
4953 # if we got this far, we're definitely replacing
4960 $new->set( 'custpaybynum' => $old->custpaybynum );
4961 # don't turn off automatic payment (but allow it to be turned on)
4962 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4964 $new->set( 'payby' => $old->payby );
4965 $new->set( 'weight' => 1 );
4967 # make sure we're not overwriting values with blanks
4968 foreach my $field (@preserve) {
4969 if ( $old->get($field) and !$new->get($field) ) {
4970 $new->set( $field => $old->get($field) );
4975 # only overwrite cust_main bill_location if auto
4976 if ($opt{'auto'} && $opt{'bill_location'}) {
4977 $self->set('bill_location' => $opt{'bill_location'});
4978 my $error = $self->replace;
4980 $dbh->rollback if $oldAutoCommit;
4985 # done with everything except reweighting and saving cust_payby
4986 # still need to commit changes to cust_main and cust_location
4987 if ($skip_cust_payby) {
4988 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4992 # re-weight existing primary cust_pay for this payby
4994 foreach my $cust_payby (@existing) {
4995 # relies on cust_payby return order
4996 last unless $cust_payby->payby !~ /^D/;
4997 last if $cust_payby->weight > 1;
4998 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4999 next if $cust_payby->weight < ($opt{'weight'} || 1);
5000 $cust_payby->weight( $cust_payby->weight + 1 );
5001 my $error = $cust_payby->replace;
5003 $dbh->rollback if $oldAutoCommit;
5004 return "Error reweighting cust_payby: $error";
5009 # finally, save cust_payby
5010 my $error = $old ? $new->replace($old) : $new->insert;
5012 $dbh->rollback if $oldAutoCommit;
5016 ${$opt{'saved_cust_payby'}} = $new
5017 if $opt{'saved_cust_payby'};
5019 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5024 =item remove_cvv_from_cust_payby PAYINFO
5026 Removes paycvv from associated cust_payby with matching PAYINFO.
5030 sub remove_cvv_from_cust_payby {
5031 my ($self,$payinfo) = @_;
5033 my $oldAutoCommit = $FS::UID::AutoCommit;
5034 local $FS::UID::AutoCommit = 0;
5037 foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
5038 next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
5039 $cust_payby->paycvv('');
5040 my $error = $cust_payby->replace;
5042 $dbh->rollback if $oldAutoCommit;
5047 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5053 =head1 CLASS METHODS
5059 Class method that returns the list of possible status strings for customers
5060 (see L<the status method|/status>). For example:
5062 @statuses = FS::cust_main->statuses();
5068 keys %{ $self->statuscolors };
5071 =item cust_status_sql
5073 Returns an SQL fragment to determine the status of a cust_main record, as a
5078 sub cust_status_sql {
5080 for my $status ( FS::cust_main->statuses() ) {
5081 my $method = $status.'_sql';
5082 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
5091 Returns an SQL expression identifying prospective cust_main records (customers
5092 with no packages ever ordered)
5096 use vars qw($select_count_pkgs);
5097 $select_count_pkgs =
5098 "SELECT COUNT(*) FROM cust_pkg
5099 WHERE cust_pkg.custnum = cust_main.custnum";
5101 sub select_count_pkgs_sql {
5106 " 0 = ( $select_count_pkgs ) ";
5111 Returns an SQL expression identifying ordered cust_main records (customers with
5112 no active packages, but recurring packages not yet setup or one time charges
5118 FS::cust_main->none_active_sql.
5119 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
5124 Returns an SQL expression identifying active cust_main records (customers with
5125 active recurring packages).
5130 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
5133 =item none_active_sql
5135 Returns an SQL expression identifying cust_main records with no active
5136 recurring packages. This includes customers of status prospect, ordered,
5137 inactive, and suspended.
5141 sub none_active_sql {
5142 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
5147 Returns an SQL expression identifying inactive cust_main records (customers with
5148 no active recurring packages, but otherwise unsuspended/uncancelled).
5153 FS::cust_main->none_active_sql.
5154 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
5160 Returns an SQL expression identifying suspended cust_main records.
5165 sub suspended_sql { susp_sql(@_); }
5167 FS::cust_main->none_active_sql.
5168 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
5174 Returns an SQL expression identifying cancelled cust_main records.
5178 sub cancel_sql { shift->cancelled_sql(@_); }
5181 =item uncancelled_sql
5183 Returns an SQL expression identifying un-cancelled cust_main records.
5187 sub uncancelled_sql { uncancel_sql(@_); }
5190 "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
5195 Returns an SQL fragment to retreive the balance.
5200 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5201 WHERE cust_bill.custnum = cust_main.custnum )
5202 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5203 WHERE cust_pay.custnum = cust_main.custnum )
5204 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5205 WHERE cust_credit.custnum = cust_main.custnum )
5206 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5207 WHERE cust_refund.custnum = cust_main.custnum )
5210 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
5212 Returns an SQL fragment to retreive the balance for this customer, optionally
5213 considering invoices with date earlier than START_TIME, and not
5214 later than END_TIME (total_owed_date minus total_unapplied_credits minus
5215 total_unapplied_payments).
5217 Times are specified as SQL fragments or numeric
5218 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5219 L<Date::Parse> for conversion functions. The empty string can be passed
5220 to disable that time constraint completely.
5222 Available options are:
5226 =item unapplied_date
5228 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)
5233 set to true to remove all customer comparison clauses, for totals
5238 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5243 JOIN clause (typically used with the total option)
5247 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
5248 time will be ignored. Note that START_TIME and END_TIME only limit the date
5249 range for invoices and I<unapplied> payments, credits, and refunds.
5255 sub balance_date_sql {
5256 my( $class, $start, $end, %opt ) = @_;
5258 my $cutoff = $opt{'cutoff'};
5260 my $owed = FS::cust_bill->owed_sql($cutoff);
5261 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
5262 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
5263 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5265 my $j = $opt{'join'} || '';
5267 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5268 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5269 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5270 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5272 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5273 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5274 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5275 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5280 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
5282 Returns an SQL fragment to retreive the total unapplied payments for this
5283 customer, only considering payments with date earlier than START_TIME, and
5284 optionally not later than END_TIME.
5286 Times are specified as SQL fragments or numeric
5287 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5288 L<Date::Parse> for conversion functions. The empty string can be passed
5289 to disable that time constraint completely.
5291 Available options are:
5295 sub unapplied_payments_date_sql {
5296 my( $class, $start, $end, %opt ) = @_;
5298 my $cutoff = $opt{'cutoff'};
5300 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5302 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
5303 'unapplied_date'=>1 );
5305 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
5308 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5310 Helper method for balance_date_sql; name (and usage) subject to change
5311 (suggestions welcome).
5313 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5314 cust_refund, cust_credit or cust_pay).
5316 If TABLE is "cust_bill" or the unapplied_date option is true, only
5317 considers records with date earlier than START_TIME, and optionally not
5318 later than END_TIME .
5322 sub _money_table_where {
5323 my( $class, $table, $start, $end, %opt ) = @_;
5326 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5327 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5328 push @where, "$table._date <= $start" if defined($start) && length($start);
5329 push @where, "$table._date > $end" if defined($end) && length($end);
5331 push @where, @{$opt{'where'}} if $opt{'where'};
5332 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5338 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
5339 use FS::cust_main::Search;
5342 FS::cust_main::Search->search(@_);
5351 #=item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5353 #Deprecated. Use event notification and message templates
5354 #(L<FS::msg_template>) instead.
5356 #Sends a templated email notification to the customer (see L<Text::Template>).
5358 #OPTIONS is a hash and may include
5360 #I<from> - the email sender (default is invoice_from)
5362 #I<to> - comma-separated scalar or arrayref of recipients
5363 # (default is invoicing_list)
5365 #I<subject> - The subject line of the sent email notification
5366 # (default is "Notice from company_name")
5368 #I<extra_fields> - a hashref of name/value pairs which will be substituted
5371 #The following variables are vavailable in the template.
5373 #I<$first> - the customer first name
5374 #I<$last> - the customer last name
5375 #I<$company> - the customer company
5376 #I<$payby> - a description of the method of payment for the customer
5377 # # would be nice to use FS::payby::shortname
5378 #I<$payinfo> - the account information used to collect for this customer
5379 #I<$expdate> - the expiration of the customer payment in seconds from epoch
5384 # my ($self, $template, %options) = @_;
5386 # return unless $conf->exists($template);
5388 # my $from = $conf->invoice_from_full($self->agentnum)
5389 # if $conf->exists('invoice_from', $self->agentnum);
5390 # $from = $options{from} if exists($options{from});
5392 # my $to = join(',', $self->invoicing_list_emailonly);
5393 # $to = $options{to} if exists($options{to});
5395 # my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
5396 # if $conf->exists('company_name', $self->agentnum);
5397 # $subject = $options{subject} if exists($options{subject});
5399 # my $notify_template = new Text::Template (TYPE => 'ARRAY',
5400 # SOURCE => [ map "$_\n",
5401 # $conf->config($template)]
5403 # or die "can't create new Text::Template object: Text::Template::ERROR";
5404 # $notify_template->compile()
5405 # or die "can't compile template: Text::Template::ERROR";
5407 # $FS::notify_template::_template::company_name =
5408 # $conf->config('company_name', $self->agentnum);
5409 # $FS::notify_template::_template::company_address =
5410 # join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
5412 # my $paydate = $self->paydate || '2037-12-31';
5413 # $FS::notify_template::_template::first = $self->first;
5414 # $FS::notify_template::_template::last = $self->last;
5415 # $FS::notify_template::_template::company = $self->company;
5416 # $FS::notify_template::_template::payinfo = $self->mask_payinfo;
5417 # my $payby = $self->payby;
5418 # my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5419 # my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5421 # #credit cards expire at the end of the month/year of their exp date
5422 # if ($payby eq 'CARD' || $payby eq 'DCRD') {
5423 # $FS::notify_template::_template::payby = 'credit card';
5424 # ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5425 # $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5427 # }elsif ($payby eq 'COMP') {
5428 # $FS::notify_template::_template::payby = 'complimentary account';
5430 # $FS::notify_template::_template::payby = 'current method';
5432 # $FS::notify_template::_template::expdate = $expire_time;
5434 # for (keys %{$options{extra_fields}}){
5436 # ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5439 # send_email(from => $from,
5441 # subject => $subject,
5442 # body => $notify_template->fill_in( PACKAGE =>
5443 # 'FS::notify_template::_template' ),
5448 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5450 Generates a templated notification to the customer (see L<Text::Template>).
5452 OPTIONS is a hash and may include
5454 I<extra_fields> - a hashref of name/value pairs which will be substituted
5455 into the template. These values may override values mentioned below
5456 and those from the customer record.
5458 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5460 The following variables are available in the template instead of or in addition
5461 to the fields of the customer record.
5463 I<$payby> - a description of the method of payment for the customer
5464 # would be nice to use FS::payby::shortname
5465 I<$payinfo> - the masked account information used to collect for this customer
5466 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5467 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5471 # a lot like cust_bill::print_latex
5472 sub generate_letter {
5473 my ($self, $template, %options) = @_;
5475 warn "Template $template does not exist" && return
5476 unless $conf->exists($template) || $options{'template_text'};
5478 my $template_source = $options{'template_text'}
5479 ? [ $options{'template_text'} ]
5480 : [ map "$_\n", $conf->config($template) ];
5482 my $letter_template = new Text::Template
5484 SOURCE => $template_source,
5485 DELIMITERS => [ '[@--', '--@]' ],
5487 or die "can't create new Text::Template object: Text::Template::ERROR";
5489 $letter_template->compile()
5490 or die "can't compile template: Text::Template::ERROR";
5492 my %letter_data = map { $_ => $self->$_ } $self->fields;
5493 $letter_data{payinfo} = $self->mask_payinfo;
5495 #my $paydate = $self->paydate || '2037-12-31';
5496 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
5498 my $payby = $self->payby;
5499 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5500 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5502 #credit cards expire at the end of the month/year of their exp date
5503 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5504 $letter_data{payby} = 'credit card';
5505 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5506 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5508 }elsif ($payby eq 'COMP') {
5509 $letter_data{payby} = 'complimentary account';
5511 $letter_data{payby} = 'current method';
5513 $letter_data{expdate} = $expire_time;
5515 for (keys %{$options{extra_fields}}){
5516 $letter_data{$_} = $options{extra_fields}->{$_};
5519 unless(exists($letter_data{returnaddress})){
5520 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5521 $self->agent_template)
5523 if ( length($retadd) ) {
5524 $letter_data{returnaddress} = $retadd;
5525 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5526 $letter_data{returnaddress} =
5527 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5531 ( $conf->config('company_name', $self->agentnum),
5532 $conf->config('company_address', $self->agentnum),
5536 $letter_data{returnaddress} = '~';
5540 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5542 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5544 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5546 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5550 ) or die "can't open temp file: $!\n";
5551 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5552 or die "can't write temp file: $!\n";
5554 $letter_data{'logo_file'} = $lh->filename;
5556 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5560 ) or die "can't open temp file: $!\n";
5562 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5564 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5565 return ($1, $letter_data{'logo_file'});
5569 =item print_ps TEMPLATE
5571 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5577 my($file, $lfile) = $self->generate_letter(@_);
5578 my $ps = FS::Misc::generate_ps($file);
5579 unlink($file.'.tex');
5585 =item print TEMPLATE
5587 Prints the filled in template.
5589 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5593 sub queueable_print {
5596 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5597 or die "invalid customer number: " . $opt{custnum};
5599 #do not backport this change to 3.x
5600 # my $error = $self->print( { 'template' => $opt{template} } );
5601 my $error = $self->print( $opt{'template'} );
5602 die $error if $error;
5606 my ($self, $template) = (shift, shift);
5608 [ $self->print_ps($template) ],
5609 'agentnum' => $self->agentnum,
5613 #these three subs should just go away once agent stuff is all config overrides
5615 sub agent_template {
5617 $self->_agent_plandata('agent_templatename');
5620 sub agent_invoice_from {
5622 $self->_agent_plandata('agent_invoice_from');
5625 sub _agent_plandata {
5626 my( $self, $option ) = @_;
5628 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5629 #agent-specific Conf
5631 use FS::part_event::Condition;
5633 my $agentnum = $self->agentnum;
5635 my $regexp = regexp_sql();
5637 my $part_event_option =
5639 'select' => 'part_event_option.*',
5640 'table' => 'part_event_option',
5642 LEFT JOIN part_event USING ( eventpart )
5643 LEFT JOIN part_event_option AS peo_agentnum
5644 ON ( part_event.eventpart = peo_agentnum.eventpart
5645 AND peo_agentnum.optionname = 'agentnum'
5646 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5648 LEFT JOIN part_event_condition
5649 ON ( part_event.eventpart = part_event_condition.eventpart
5650 AND part_event_condition.conditionname = 'cust_bill_age'
5652 LEFT JOIN part_event_condition_option
5653 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5654 AND part_event_condition_option.optionname = 'age'
5657 #'hashref' => { 'optionname' => $option },
5658 #'hashref' => { 'part_event_option.optionname' => $option },
5660 " WHERE part_event_option.optionname = ". dbh->quote($option).
5661 " AND action = 'cust_bill_send_agent' ".
5662 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5663 " AND peo_agentnum.optionname = 'agentnum' ".
5664 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5666 CASE WHEN part_event_condition_option.optionname IS NULL
5668 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5670 , part_event.weight".
5674 unless ( $part_event_option ) {
5675 return $self->agent->invoice_template || ''
5676 if $option eq 'agent_templatename';
5680 $part_event_option->optionvalue;
5684 sub process_o2m_qsearch {
5687 return qsearch($table, @_) unless $table eq 'contact';
5689 my $hashref = shift;
5690 my %hash = %$hashref;
5691 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5692 or die 'guru meditation #4343';
5694 qsearch({ 'table' => 'contact',
5695 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5696 'hashref' => \%hash,
5697 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5698 " cust_contact.custnum = $custnum "
5702 sub process_o2m_qsearchs {
5705 return qsearchs($table, @_) unless $table eq 'contact';
5707 my $hashref = shift;
5708 my %hash = %$hashref;
5709 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5710 or die 'guru meditation #2121';
5712 qsearchs({ 'table' => 'contact',
5713 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5714 'hashref' => \%hash,
5715 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5716 " cust_contact.custnum = $custnum "
5720 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5722 Subroutine (not a method), designed to be called from the queue.
5724 Takes a list of options and values.
5726 Pulls up the customer record via the custnum option and calls bill_and_collect.
5731 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5733 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5734 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5736 #without this errors don't get rolled back
5737 $args{'fatal'} = 1; # runs from job queue, will be caught
5739 $cust_main->bill_and_collect( %args );
5742 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5744 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5745 C<collect> part. This is used in batch tax calculation, where invoice
5746 generation and collection events have to be completely separated.
5750 sub queued_collect {
5752 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5754 $cust_main->collect(%args);
5757 sub process_bill_and_collect {
5760 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5761 or die "custnum '$param->{custnum}' not found!\n";
5762 $param->{'job'} = $job;
5763 $param->{'fatal'} = 1; # runs from job queue, will be caught
5764 $param->{'retry'} = 1;
5767 eval { $cust_main->bill_and_collect( %$param) };
5769 die $@ =~ /cancel_pkgs cannot be run inside a transaction/
5770 ? "Bill Now unavailable for customer with pending package expiration\n"
5775 =item pending_invoice_count
5777 Return number of cust_bill with pending=Y for this customer
5781 sub pending_invoice_count {
5782 FS::cust_bill->count( 'custnum = '.shift->custnum."AND pending = 'Y'" );
5785 =item cust_locations_missing_district
5787 Always returns empty list, unless tax_district_method eq 'wa_sales'
5789 Return cust_location rows for this customer, associated with active
5790 customer packages, where tax district column is empty. Presense of
5791 these rows should block billing, because invoice would be generated
5792 with incorrect taxes
5796 sub cust_locations_missing_district {
5799 my $tax_district_method = FS::Conf->new->config('tax_district_method');
5802 unless $tax_district_method
5803 && $tax_district_method eq 'wa_sales';
5806 table => 'cust_location',
5807 select => 'cust_location.*',
5809 LEFT JOIN cust_main USING (custnum)
5810 LEFT JOIN cust_pkg ON cust_location.locationnum = cust_pkg.locationnum
5812 extra_sql => sprintf(q{
5813 WHERE cust_location.state = 'WA'
5814 AND cust_location.custnum = %s
5816 cust_location.district IS NULL
5817 or cust_location.district = ''
5819 AND cust_pkg.pkgnum IS NOT NULL
5821 cust_pkg.cancel > %s
5822 OR cust_pkg.cancel IS NULL
5825 $self->custnum, time()
5830 #starting to take quite a while for big dbs
5831 # (JRNL: journaled so it only happens once per database)
5832 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5833 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5834 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5835 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5836 # JRNL leading/trailing spaces in first, last, company
5837 # JRNL migrate to cust_payby
5838 # - otaker upgrade? journal and call it good? (double check to make sure
5839 # we're not still setting otaker here)
5841 #only going to get worse with new location stuff...
5843 sub _upgrade_data { #class method
5844 my ($class, %opts) = @_;
5847 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5850 #this seems to be the only expensive one.. why does it take so long?
5851 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5853 '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';
5854 FS::upgrade_journal->set_done('cust_main__signupdate');
5857 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5859 # fix yyyy-m-dd formatted paydates
5860 if ( driver_name =~ /^mysql/i ) {
5862 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5863 } else { # the SQL standard
5865 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5867 FS::upgrade_journal->set_done('cust_main__paydate');
5870 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5872 push @statements, #fix the weird BILL with a cc# in payinfo problem
5874 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5876 FS::upgrade_journal->set_done('cust_main__payinfo');
5881 foreach my $sql ( @statements ) {
5882 my $sth = dbh->prepare($sql) or die dbh->errstr;
5883 $sth->execute or die $sth->errstr;
5884 #warn ( (time - $t). " seconds\n" );
5888 local($ignore_expired_card) = 1;
5889 local($ignore_banned_card) = 1;
5890 local($skip_fuzzyfiles) = 1;
5891 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5893 unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5895 #we don't want to decrypt them, just stuff them as-is into cust_payby
5896 local(@encrypted_fields) = ();
5898 local($FS::cust_payby::ignore_expired_card) = 1;
5899 local($FS::cust_payby::ignore_banned_card) = 1;
5900 local($FS::cust_payby::ignore_cardtype) = 1;
5902 my @payfields = qw( payby payinfo paycvv paymask
5903 paydate paystart_month paystart_year payissue
5904 payname paystate paytype payip
5907 my $search = new FS::Cursor {
5908 'table' => 'cust_main',
5909 'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5912 while (my $cust_main = $search->fetch) {
5914 unless ( $cust_main->payby =~ /^(BILL|COMP)$/ ) {
5916 my $cust_payby = new FS::cust_payby {
5917 'custnum' => $cust_main->custnum,
5919 map { $_ => $cust_main->$_(); } @payfields
5922 my $error = $cust_payby->insert;
5923 die $error if $error;
5927 # at the time we do this, also migrate paytype into cust_pay_batch
5928 # so that batches that are open before the migration can still be
5930 if ( $cust_main->get('paytype') ) {
5931 my @cust_pay_batch = qsearch('cust_pay_batch', {
5932 'custnum' => $cust_main->custnum,
5936 foreach my $cust_pay_batch (@cust_pay_batch) {
5937 $cust_pay_batch->set('paytype', $cust_main->get('paytype'));
5938 my $error = $cust_pay_batch->replace;
5939 die "$error (setting cust_pay_batch.paytype)" if $error;
5943 $cust_main->complimentary('Y') if $cust_main->payby eq 'COMP';
5945 $cust_main->invoice_attn( $cust_main->payname )
5946 if $cust_main->payby eq 'BILL' && $cust_main->payname;
5947 $cust_main->po_number( $cust_main->payinfo )
5948 if $cust_main->payby eq 'BILL' && $cust_main->payinfo;
5950 $cust_main->setfield($_, '') foreach @payfields;
5951 my $error = $cust_main->replace;
5952 die "Error upgradging payment information for custnum ".
5953 $cust_main->custnum. ": $error"
5958 FS::upgrade_journal->set_done('cust_main__cust_payby');
5961 FS::cust_main::Location->_upgrade_data(%opts);
5963 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5965 foreach my $cust_main ( qsearch({
5966 'table' => 'cust_main',
5968 'extra_sql' => 'WHERE '.
5970 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5971 qw( first last company )
5974 my $error = $cust_main->replace;
5975 die $error if $error;
5978 FS::upgrade_journal->set_done('cust_main__trimspaces');
5982 $class->_upgrade_otaker(%opts);
5984 # turn on encryption as part of regular upgrade, so all new records are immediately encrypted
5985 # existing records will be encrypted in queueable_upgrade (below)
5986 unless ($conf->exists('encryptionpublickey') || $conf->exists('encryptionprivatekey')) {
5987 eval "use FS::Setup";
5989 FS::Setup::enable_encryption();
5994 sub queueable_upgrade {
5997 ### encryption gets turned on in _upgrade_data, above
5999 eval "use FS::upgrade_journal";
6002 # prior to 2013 (commit f16665c9) payinfo was stored in history if not encrypted,
6003 # clear that out before encrypting/tokenizing anything else
6004 if (!FS::upgrade_journal->is_done('clear_payinfo_history')) {
6005 foreach my $table ('cust_payby','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
6006 my $sql = 'UPDATE h_'.$table.' SET payinfo = NULL WHERE payinfo IS NOT NULL';
6007 my $sth = dbh->prepare($sql) or die dbh->errstr;
6008 $sth->execute or die $sth->errstr;
6010 FS::upgrade_journal->set_done('clear_payinfo_history');
6013 # fix Tokenized paycardtype and encrypt old records
6014 if ( ! FS::upgrade_journal->is_done('paycardtype_Tokenized')
6015 || ! FS::upgrade_journal->is_done('encryption_check')
6019 # allow replacement of closed cust_pay/cust_refund records
6020 local $FS::payinfo_Mixin::allow_closed_replace = 1;
6022 # because it looks like nothing's changing
6023 local $FS::Record::no_update_diff = 1;
6025 # commit everything immediately
6026 local $FS::UID::AutoCommit = 1;
6028 # encrypt what's there
6029 foreach my $table ('cust_payby','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
6030 my $tclass = 'FS::'.$table;
6033 while (my $recnum = _upgrade_next_recnum(dbh,$table,\$lastrecnum,\@recnums)) {
6034 my $record = $tclass->by_key($recnum);
6035 next unless $record; # small chance it's been deleted, that's ok
6036 next unless grep { $record->payby eq $_ } @FS::Record::encrypt_payby;
6037 # window for possible conflict is practically nonexistant,
6038 # but just in case...
6039 $record = $record->select_for_update;
6040 if (!$record->custnum && $table eq 'cust_pay_pending') {
6041 $record->set('custnum_pending',1);
6043 $record->paycardtype('') if $record->paycardtype eq 'Tokenized';
6045 local($ignore_expired_card) = 1;
6046 local($ignore_banned_card) = 1;
6047 local($skip_fuzzyfiles) = 1;
6048 local($import) = 1;#prevent automatic geocoding (need its own variable?)
6050 my $error = $record->replace;
6051 die "Error replacing $table ".$record->get($record->primary_key).": $error" if $error;
6055 FS::upgrade_journal->set_done('paycardtype_Tokenized');
6056 FS::upgrade_journal->set_done('encryption_check') if $conf->exists('encryption');
6059 # now that everything's encrypted, tokenize...
6060 FS::cust_main::Billing_Realtime::token_check(@_);
6063 # not entirely false laziness w/ Billing_Realtime::_token_check_next_recnum
6064 # cust_payby might get deleted while this runs
6066 sub _upgrade_next_recnum {
6067 my ($dbh,$table,$lastrecnum,$recnums) = @_;
6068 my $recnum = shift @$recnums;
6069 return $recnum if $recnum;
6070 my $tclass = 'FS::'.$table;
6071 my $paycardtypecheck = ($table ne 'cust_pay_pending') ? q( OR paycardtype = 'Tokenized') : '';
6072 my $sql = 'SELECT '.$tclass->primary_key.
6074 ' WHERE '.$tclass->primary_key.' > '.$$lastrecnum.
6075 " AND payby IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
6076 " AND ( length(payinfo) < 80$paycardtypecheck ) ".
6077 ' ORDER BY '.$tclass->primary_key.' LIMIT 500';
6078 my $sth = $dbh->prepare($sql) or die $dbh->errstr;
6079 $sth->execute() or die $sth->errstr;
6081 while (my $rec = $sth->fetchrow_hashref) {
6082 push @$recnums, $rec->{$tclass->primary_key};
6085 $$lastrecnum = $$recnums[-1];
6086 return shift @$recnums;
6095 The delete method should possibly take an FS::cust_main object reference
6096 instead of a scalar customer number.
6098 Bill and collect options should probably be passed as references instead of a
6101 There should probably be a configuration file with a list of allowed credit
6104 No multiple currency support (probably a larger project than just this module).
6106 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
6108 Birthdates rely on negative epoch values.
6110 The payby for card/check batches is broken. With mixed batching, bad
6113 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
6117 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
6118 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
6119 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.