4 use vars qw( @ISA $conf $Debug $import );
10 use Business::CreditCard;
11 use FS::UID qw( getotaker dbh );
12 use FS::Record qw( qsearchs qsearch dbdef );
15 use FS::cust_bill_pkg;
18 use FS::part_referral;
19 use FS::cust_main_county;
21 use FS::cust_main_invoice;
22 use FS::cust_credit_bill;
23 use FS::cust_bill_pay;
24 use FS::prepay_credit;
27 use FS::part_bill_event;
28 use FS::cust_bill_event;
30 @ISA = qw( FS::Record );
37 #ask FS::UID to run this stuff for us later
38 $FS::UID::callback{'FS::cust_main'} = sub {
40 #yes, need it for stuff below (prolly should be cached)
45 my ( $hashref, $cache ) = @_;
46 if ( exists $hashref->{'pkgnum'} ) {
47 # #@{ $self->{'_pkgnum'} } = ();
48 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
49 $self->{'_pkgnum'} = $subcache;
50 #push @{ $self->{'_pkgnum'} },
51 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
57 FS::cust_main - Object methods for cust_main records
63 $record = new FS::cust_main \%hash;
64 $record = new FS::cust_main { 'column' => 'value' };
66 $error = $record->insert;
68 $error = $new_record->replace($old_record);
70 $error = $record->delete;
72 $error = $record->check;
74 @cust_pkg = $record->all_pkgs;
76 @cust_pkg = $record->ncancelled_pkgs;
78 @cust_pkg = $record->suspended_pkgs;
80 $error = $record->bill;
81 $error = $record->bill %options;
82 $error = $record->bill 'time' => $time;
84 $error = $record->collect;
85 $error = $record->collect %options;
86 $error = $record->collect 'invoice_time' => $time,
87 'batch_card' => 'yes',
88 'report_badcard' => 'yes',
93 An FS::cust_main object represents a customer. FS::cust_main inherits from
94 FS::Record. The following fields are currently supported:
98 =item custnum - primary key (assigned automatically for new customers)
100 =item agentnum - agent (see L<FS::agent>)
102 =item refnum - Advertising source (see L<FS::part_referral>)
108 =item ss - social security number (optional)
110 =item company - (optional)
114 =item address2 - (optional)
118 =item county - (optional, see L<FS::cust_main_county>)
120 =item state - (see L<FS::cust_main_county>)
124 =item country - (see L<FS::cust_main_county>)
126 =item daytime - phone (optional)
128 =item night - phone (optional)
130 =item fax - phone (optional)
132 =item ship_first - name
134 =item ship_last - name
136 =item ship_company - (optional)
140 =item ship_address2 - (optional)
144 =item ship_county - (optional, see L<FS::cust_main_county>)
146 =item ship_state - (see L<FS::cust_main_county>)
150 =item ship_country - (see L<FS::cust_main_county>)
152 =item ship_daytime - phone (optional)
154 =item ship_night - phone (optional)
156 =item ship_fax - phone (optional)
158 =item payby - `CARD' (credit cards), `BILL' (billing), `COMP' (free), or `PREPAY' (special billing type: applies a credit - see L<FS::prepay_credit> and sets billing type to BILL)
160 =item payinfo - card number, P.O., comp issuer (4-8 lowercase alphanumerics; think username) or prepayment identifier (see L<FS::prepay_credit>)
162 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
164 =item payname - name on card or billing name
166 =item tax - tax exempt, empty or `Y'
168 =item otaker - order taker (assigned automatically, see L<FS::UID>)
170 =item comments - comments (optional)
180 Creates a new customer. To add the customer to the database, see L<"insert">.
182 Note that this stores the hash reference, not a distinct copy of the hash it
183 points to. You can ask the object for a copy with the I<hash> method.
187 sub table { 'cust_main'; }
189 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] ]
191 Adds this customer to the database. If there is an error, returns the error,
192 otherwise returns false.
194 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
195 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
196 are inserted atomicly, or the transaction is rolled back. Passing an empty
197 hash reference is equivalent to not supplying this parameter. There should be
198 a better explanation of this, but until then, here's an example:
201 tie %hash, 'Tie::RefHash'; #this part is important
203 $cust_pkg => [ $svc_acct ],
206 $cust_main->insert( \%hash );
208 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
209 be set as the invoicing list (see L<"invoicing_list">). Errors return as
210 expected and rollback the entire transaction; it is not necessary to call
211 check_invoicing_list first. The invoicing_list is set after the records in the
212 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
213 invoicing_list destination to the newly-created svc_acct. Here's an example:
215 $cust_main->insert( {}, [ $email, 'POST' ] );
223 local $SIG{HUP} = 'IGNORE';
224 local $SIG{INT} = 'IGNORE';
225 local $SIG{QUIT} = 'IGNORE';
226 local $SIG{TERM} = 'IGNORE';
227 local $SIG{TSTP} = 'IGNORE';
228 local $SIG{PIPE} = 'IGNORE';
230 my $oldAutoCommit = $FS::UID::AutoCommit;
231 local $FS::UID::AutoCommit = 0;
236 if ( $self->payby eq 'PREPAY' ) {
237 $self->payby('BILL');
238 my $prepay_credit = qsearchs(
240 { 'identifier' => $self->payinfo },
244 warn "WARNING: can't find pre-found prepay_credit: ". $self->payinfo
245 unless $prepay_credit;
246 $amount = $prepay_credit->amount;
247 $seconds = $prepay_credit->seconds;
248 my $error = $prepay_credit->delete;
250 $dbh->rollback if $oldAutoCommit;
251 return "removing prepay_credit (transaction rolled back): $error";
255 my $error = $self->SUPER::insert;
257 $dbh->rollback if $oldAutoCommit;
258 return "inserting cust_main record (transaction rolled back): $error";
261 if ( @param ) { # CUST_PKG_HASHREF
262 my $cust_pkgs = shift @param;
263 foreach my $cust_pkg ( keys %$cust_pkgs ) {
264 $cust_pkg->custnum( $self->custnum );
265 $error = $cust_pkg->insert;
267 $dbh->rollback if $oldAutoCommit;
268 return "inserting cust_pkg (transaction rolled back): $error";
270 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
271 $svc_something->pkgnum( $cust_pkg->pkgnum );
272 if ( $seconds && $svc_something->isa('FS::svc_acct') ) {
273 $svc_something->seconds( $svc_something->seconds + $seconds );
276 $error = $svc_something->insert;
278 $dbh->rollback if $oldAutoCommit;
279 return "inserting svc_ (transaction rolled back): $error";
286 $dbh->rollback if $oldAutoCommit;
287 return "No svc_acct record to apply pre-paid time";
290 if ( @param ) { # INVOICING_LIST_ARYREF
291 my $invoicing_list = shift @param;
292 $error = $self->check_invoicing_list( $invoicing_list );
294 $dbh->rollback if $oldAutoCommit;
295 return "checking invoicing_list (transaction rolled back): $error";
297 $self->invoicing_list( $invoicing_list );
301 my $cust_credit = new FS::cust_credit {
302 'custnum' => $self->custnum,
305 $error = $cust_credit->insert;
307 $dbh->rollback if $oldAutoCommit;
308 return "inserting credit (transaction rolled back): $error";
312 #false laziness with sub replace
313 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
314 $error = $queue->insert($self->getfield('last'), $self->company);
316 $dbh->rollback if $oldAutoCommit;
317 return "queueing job (transaction rolled back): $error";
320 if ( defined $self->dbdef_table->column('ship_last') && $self->ship_last ) {
321 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
322 $error = $queue->insert($self->getfield('last'), $self->company);
324 $dbh->rollback if $oldAutoCommit;
325 return "queueing job (transaction rolled back): $error";
330 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
335 =item delete NEW_CUSTNUM
337 This deletes the customer. If there is an error, returns the error, otherwise
340 This will completely remove all traces of the customer record. This is not
341 what you want when a customer cancels service; for that, cancel all of the
342 customer's packages (see L<FS::cust_pkg/cancel>).
344 If the customer has any uncancelled packages, you need to pass a new (valid)
345 customer number for those packages to be transferred to. Cancelled packages
346 will be deleted. Did I mention that this is NOT what you want when a customer
347 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
349 You can't delete a customer with invoices (see L<FS::cust_bill>),
350 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
351 refunds (see L<FS::cust_refund>).
358 local $SIG{HUP} = 'IGNORE';
359 local $SIG{INT} = 'IGNORE';
360 local $SIG{QUIT} = 'IGNORE';
361 local $SIG{TERM} = 'IGNORE';
362 local $SIG{TSTP} = 'IGNORE';
363 local $SIG{PIPE} = 'IGNORE';
365 my $oldAutoCommit = $FS::UID::AutoCommit;
366 local $FS::UID::AutoCommit = 0;
369 if ( qsearch( 'cust_bill', { 'custnum' => $self->custnum } ) ) {
370 $dbh->rollback if $oldAutoCommit;
371 return "Can't delete a customer with invoices";
373 if ( qsearch( 'cust_credit', { 'custnum' => $self->custnum } ) ) {
374 $dbh->rollback if $oldAutoCommit;
375 return "Can't delete a customer with credits";
377 if ( qsearch( 'cust_pay', { 'custnum' => $self->custnum } ) ) {
378 $dbh->rollback if $oldAutoCommit;
379 return "Can't delete a customer with payments";
381 if ( qsearch( 'cust_refund', { 'custnum' => $self->custnum } ) ) {
382 $dbh->rollback if $oldAutoCommit;
383 return "Can't delete a customer with refunds";
386 my @cust_pkg = $self->ncancelled_pkgs;
388 my $new_custnum = shift;
389 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
390 $dbh->rollback if $oldAutoCommit;
391 return "Invalid new customer number: $new_custnum";
393 foreach my $cust_pkg ( @cust_pkg ) {
394 my %hash = $cust_pkg->hash;
395 $hash{'custnum'} = $new_custnum;
396 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
397 my $error = $new_cust_pkg->replace($cust_pkg);
399 $dbh->rollback if $oldAutoCommit;
404 my @cancelled_cust_pkg = $self->all_pkgs;
405 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
406 my $error = $cust_pkg->delete;
408 $dbh->rollback if $oldAutoCommit;
413 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
414 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
416 my $error = $cust_main_invoice->delete;
418 $dbh->rollback if $oldAutoCommit;
423 my $error = $self->SUPER::delete;
425 $dbh->rollback if $oldAutoCommit;
429 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
434 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
436 Replaces the OLD_RECORD with this one in the database. If there is an error,
437 returns the error, otherwise returns false.
439 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
440 be set as the invoicing list (see L<"invoicing_list">). Errors return as
441 expected and rollback the entire transaction; it is not necessary to call
442 check_invoicing_list first. Here's an example:
444 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
453 local $SIG{HUP} = 'IGNORE';
454 local $SIG{INT} = 'IGNORE';
455 local $SIG{QUIT} = 'IGNORE';
456 local $SIG{TERM} = 'IGNORE';
457 local $SIG{TSTP} = 'IGNORE';
458 local $SIG{PIPE} = 'IGNORE';
460 my $oldAutoCommit = $FS::UID::AutoCommit;
461 local $FS::UID::AutoCommit = 0;
464 my $error = $self->SUPER::replace($old);
467 $dbh->rollback if $oldAutoCommit;
471 if ( @param ) { # INVOICING_LIST_ARYREF
472 my $invoicing_list = shift @param;
473 $error = $self->check_invoicing_list( $invoicing_list );
475 $dbh->rollback if $oldAutoCommit;
478 $self->invoicing_list( $invoicing_list );
481 #false laziness with sub insert
482 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
483 $error = $queue->insert($self->getfield('last'), $self->company);
485 $dbh->rollback if $oldAutoCommit;
486 return "queueing job (transaction rolled back): $error";
489 if ( defined $self->dbdef_table->column('ship_last') && $self->ship_last ) {
490 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
491 $error = $queue->insert($self->getfield('last'), $self->company);
493 $dbh->rollback if $oldAutoCommit;
494 return "queueing job (transaction rolled back): $error";
499 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
506 Checks all fields to make sure this is a valid customer record. If there is
507 an error, returns the error, otherwise returns false. Called by the insert
515 #warn "BEFORE: \n". $self->_dump;
518 $self->ut_numbern('custnum')
519 || $self->ut_number('agentnum')
520 || $self->ut_number('refnum')
521 || $self->ut_name('last')
522 || $self->ut_name('first')
523 || $self->ut_textn('company')
524 || $self->ut_text('address1')
525 || $self->ut_textn('address2')
526 || $self->ut_text('city')
527 || $self->ut_textn('county')
528 || $self->ut_textn('state')
529 || $self->ut_country('country')
530 || $self->ut_anything('comments')
531 || $self->ut_numbern('referral_custnum')
533 #barf. need message catalogs. i18n. etc.
534 $error .= "Please select a advertising source."
535 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
536 return $error if $error;
538 return "Unknown agent"
539 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
541 return "Unknown refnum"
542 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
544 return "Unknown referring custnum ". $self->referral_custnum
545 unless ! $self->referral_custnum
546 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
548 if ( $self->ss eq '' ) {
553 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
554 or return "Illegal social security number: ". $self->ss;
555 $self->ss("$1-$2-$3");
559 # bad idea to disable, causes billing to fail because of no tax rates later
560 # unless ( $import ) {
561 unless ( qsearchs('cust_main_county', {
562 'country' => $self->country,
565 return "Unknown state/county/country: ".
566 $self->state. "/". $self->county. "/". $self->country
567 unless qsearchs('cust_main_county',{
568 'state' => $self->state,
569 'county' => $self->county,
570 'country' => $self->country,
576 $self->ut_phonen('daytime', $self->country)
577 || $self->ut_phonen('night', $self->country)
578 || $self->ut_phonen('fax', $self->country)
579 || $self->ut_zip('zip', $self->country)
581 return $error if $error;
584 last first company address1 address2 city county state zip
585 country daytime night fax
588 if ( defined $self->dbdef_table->column('ship_last') ) {
589 if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
591 && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
595 $self->ut_name('ship_last')
596 || $self->ut_name('ship_first')
597 || $self->ut_textn('ship_company')
598 || $self->ut_text('ship_address1')
599 || $self->ut_textn('ship_address2')
600 || $self->ut_text('ship_city')
601 || $self->ut_textn('ship_county')
602 || $self->ut_textn('ship_state')
603 || $self->ut_country('ship_country')
605 return $error if $error;
607 #false laziness with above
608 unless ( qsearchs('cust_main_county', {
609 'country' => $self->ship_country,
612 return "Unknown ship_state/ship_county/ship_country: ".
613 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
614 unless qsearchs('cust_main_county',{
615 'state' => $self->ship_state,
616 'county' => $self->ship_county,
617 'country' => $self->ship_country,
623 $self->ut_phonen('ship_daytime', $self->ship_country)
624 || $self->ut_phonen('ship_night', $self->ship_country)
625 || $self->ut_phonen('ship_fax', $self->ship_country)
626 || $self->ut_zip('ship_zip', $self->ship_country)
628 return $error if $error;
630 } else { # ship_ info eq billing info, so don't store dup info in database
631 $self->setfield("ship_$_", '')
632 foreach qw( last first company address1 address2 city county state zip
633 country daytime night fax );
637 $self->payby =~ /^(CARD|BILL|COMP|PREPAY)$/
638 or return "Illegal payby: ". $self->payby;
641 if ( $self->payby eq 'CARD' ) {
643 my $payinfo = $self->payinfo;
645 $payinfo =~ /^(\d{13,16})$/
646 or return "Illegal credit card number: ". $self->payinfo;
648 $self->payinfo($payinfo);
650 or return "Illegal credit card number: ". $self->payinfo;
651 return "Unknown card type" if cardtype($self->payinfo) eq "Unknown";
653 } elsif ( $self->payby eq 'BILL' ) {
655 $error = $self->ut_textn('payinfo');
656 return "Illegal P.O. number: ". $self->payinfo if $error;
658 } elsif ( $self->payby eq 'COMP' ) {
660 $error = $self->ut_textn('payinfo');
661 return "Illegal comp account issuer: ". $self->payinfo if $error;
663 } elsif ( $self->payby eq 'PREPAY' ) {
665 my $payinfo = $self->payinfo;
666 $payinfo =~ s/\W//g; #anything else would just confuse things
667 $self->payinfo($payinfo);
668 $error = $self->ut_alpha('payinfo');
669 return "Illegal prepayment identifier: ". $self->payinfo if $error;
670 return "Unknown prepayment identifier"
671 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
675 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
676 return "Expriation date required"
677 unless $self->payby eq 'BILL' || $self->payby eq 'PREPAY';
680 $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/
681 or return "Illegal expiration date: ". $self->paydate;
682 if ( length($2) == 4 ) {
683 $self->paydate("$2-$1-01");
685 $self->paydate("20$2-$1-01");
689 if ( $self->payname eq '' ) {
690 $self->payname( $self->first. " ". $self->getfield('last') );
692 $self->payname =~ /^([\w \,\.\-\']+)$/
693 or return "Illegal billing name: ". $self->payname;
697 $self->tax =~ /^(Y?)$/ or return "Illegal tax: ". $self->tax;
700 $self->otaker(getotaker);
702 #warn "AFTER: \n". $self->_dump;
709 Returns all packages (see L<FS::cust_pkg>) for this customer.
715 if ( $self->{'_pkgnum'} ) {
716 values %{ $self->{'_pkgnum'}->cache };
718 qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
722 =item ncancelled_pkgs
724 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
728 sub ncancelled_pkgs {
730 if ( $self->{'_pkgnum'} ) {
731 grep { ! $_->getfield('cancel') } values %{ $self->{'_pkgnum'}->cache };
733 @{ [ # force list context
734 qsearch( 'cust_pkg', {
735 'custnum' => $self->custnum,
738 qsearch( 'cust_pkg', {
739 'custnum' => $self->custnum,
748 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
754 grep { $_->susp } $self->ncancelled_pkgs;
757 =item unflagged_suspended_pkgs
759 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
760 customer (thouse packages without the `manual_flag' set).
764 sub unflagged_suspended_pkgs {
766 return $self->suspended_pkgs
767 unless dbdef->table('cust_pkg')->column('manual_flag');
768 grep { ! $_->manual_flag } $self->suspended_pkgs;
771 =item unsuspended_pkgs
773 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
778 sub unsuspended_pkgs {
780 grep { ! $_->susp } $self->ncancelled_pkgs;
785 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
786 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
787 on success or a list of errors.
793 grep { $_->unsuspend } $self->suspended_pkgs;
798 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
799 Always returns a list: an empty list on success or a list of errors.
805 grep { $_->suspend } $self->unsuspended_pkgs;
810 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
811 Always returns a list: an empty list on success or a list of errors.
817 grep { $_->cancel } $self->ncancelled_pkgs;
822 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
823 conjunction with the collect method.
825 Options are passed as name-value pairs.
827 The only currently available option is `time', which bills the customer as if
828 it were that time. It is specified as a UNIX timestamp; see
829 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
830 functions. For example:
834 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
836 If there is an error, returns the error, otherwise returns false.
841 my( $self, %options ) = @_;
842 my $time = $options{'time'} || time;
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 # find the packages which are due for billing, find out how much they are
859 # & generate invoice database.
861 my( $total_setup, $total_recur ) = ( 0, 0 );
862 my( $taxable_setup, $taxable_recur ) = ( 0, 0 );
863 my @cust_bill_pkg = ();
865 foreach my $cust_pkg (
866 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
869 #NO!! next if $cust_pkg->cancel;
870 next if $cust_pkg->getfield('cancel');
872 #? to avoid use of uninitialized value errors... ?
873 $cust_pkg->setfield('bill', '')
874 unless defined($cust_pkg->bill);
876 my $part_pkg = qsearchs( 'part_pkg', { 'pkgpart' => $cust_pkg->pkgpart } );
878 #so we don't modify cust_pkg record unnecessarily
879 my $cust_pkg_mod_flag = 0;
880 my %hash = $cust_pkg->hash;
881 my $old_cust_pkg = new FS::cust_pkg \%hash;
885 unless ( $cust_pkg->setup ) {
886 my $setup_prog = $part_pkg->getfield('setup');
887 $setup_prog =~ /^(.*)$/ or do {
888 $dbh->rollback if $oldAutoCommit;
889 return "Illegal setup for pkgpart ". $part_pkg->pkgpart.
895 ##$cpt->permit(); #what is necessary?
896 #$cpt->share(qw( $cust_pkg )); #can $cpt now use $cust_pkg methods?
897 #$setup = $cpt->reval($setup_prog);
898 $setup = eval $setup_prog;
899 unless ( defined($setup) ) {
900 $dbh->rollback if $oldAutoCommit;
901 return "Error eval-ing part_pkg->setup pkgpart ". $part_pkg->pkgpart.
902 "(expression $setup_prog): $@";
904 $cust_pkg->setfield('setup',$time);
905 $cust_pkg_mod_flag=1;
911 if ( $part_pkg->getfield('freq') > 0 &&
912 ! $cust_pkg->getfield('susp') &&
913 ( $cust_pkg->getfield('bill') || 0 ) < $time
915 my $recur_prog = $part_pkg->getfield('recur');
916 $recur_prog =~ /^(.*)$/ or do {
917 $dbh->rollback if $oldAutoCommit;
918 return "Illegal recur for pkgpart ". $part_pkg->pkgpart.
923 # shared with $recur_prog
924 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
927 ##$cpt->permit(); #what is necessary?
928 #$cpt->share(qw( $cust_pkg )); #can $cpt now use $cust_pkg methods?
929 #$recur = $cpt->reval($recur_prog);
930 $recur = eval $recur_prog;
931 unless ( defined($recur) ) {
932 $dbh->rollback if $oldAutoCommit;
933 return "Error eval-ing part_pkg->recur pkgpart ". $part_pkg->pkgpart.
934 "(expression $recur_prog): $@";
936 #change this bit to use Date::Manip? CAREFUL with timezones (see
937 # mailing list archive)
938 my ($sec,$min,$hour,$mday,$mon,$year) =
939 (localtime($sdate) )[0,1,2,3,4,5];
941 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
942 # only for figuring next bill date, nothing else, so, reset $sdate again
944 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
946 $mon += $part_pkg->getfield('freq');
947 until ( $mon < 12 ) { $mon -= 12; $year++; }
948 $cust_pkg->setfield('bill',
949 timelocal($sec,$min,$hour,$mday,$mon,$year));
950 $cust_pkg_mod_flag = 1;
953 warn "\$setup is undefined" unless defined($setup);
954 warn "\$recur is undefined" unless defined($recur);
955 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
957 if ( $cust_pkg_mod_flag ) {
958 $error=$cust_pkg->replace($old_cust_pkg);
959 if ( $error ) { #just in case
960 $dbh->rollback if $oldAutoCommit;
961 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
963 $setup = sprintf( "%.2f", $setup );
964 $recur = sprintf( "%.2f", $recur );
966 $dbh->rollback if $oldAutoCommit;
967 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
970 $dbh->rollback if $oldAutoCommit;
971 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
973 if ( $setup > 0 || $recur > 0 ) {
974 my $cust_bill_pkg = new FS::cust_bill_pkg ({
975 'pkgnum' => $cust_pkg->pkgnum,
979 'edate' => $cust_pkg->bill,
981 push @cust_bill_pkg, $cust_bill_pkg;
982 $total_setup += $setup;
983 $total_recur += $recur;
984 $taxable_setup += $setup
985 unless $part_pkg->dbdef_table->column('setuptax')
986 && $part_pkg->setuptax =~ /^Y$/i;
987 $taxable_recur += $recur
988 unless $part_pkg->dbdef_table->column('recurtax')
989 && $part_pkg->recurtax =~ /^Y$/i;
995 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
996 my $taxable_charged = sprintf( "%.2f", $taxable_setup + $taxable_recur );
998 unless ( @cust_bill_pkg ) {
999 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1003 unless ( $self->tax =~ /Y/i
1004 || $self->payby eq 'COMP'
1005 || $taxable_charged == 0 ) {
1006 my $cust_main_county = qsearchs('cust_main_county',{
1007 'state' => $self->state,
1008 'county' => $self->county,
1009 'country' => $self->country,
1010 } ) or die "fatal: can't find tax rate for state/county/country ".
1011 $self->state. "/". $self->county. "/". $self->country. "\n";
1012 my $tax = sprintf( "%.2f",
1013 $taxable_charged * ( $cust_main_county->getfield('tax') / 100 )
1017 $charged = sprintf( "%.2f", $charged+$tax );
1019 my $cust_bill_pkg = new FS::cust_bill_pkg ({
1026 push @cust_bill_pkg, $cust_bill_pkg;
1030 my $cust_bill = new FS::cust_bill ( {
1031 'custnum' => $self->custnum,
1033 'charged' => $charged,
1035 $error = $cust_bill->insert;
1037 $dbh->rollback if $oldAutoCommit;
1038 return "can't create invoice for customer #". $self->custnum. ": $error";
1041 my $invnum = $cust_bill->invnum;
1043 foreach $cust_bill_pkg ( @cust_bill_pkg ) {
1045 $cust_bill_pkg->invnum($invnum);
1046 $error = $cust_bill_pkg->insert;
1048 $dbh->rollback if $oldAutoCommit;
1049 return "can't create invoice line item for customer #". $self->custnum.
1054 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1058 =item collect OPTIONS
1060 (Attempt to) collect money for this customer's outstanding invoices (see
1061 L<FS::cust_bill>). Usually used after the bill method.
1063 Depending on the value of `payby', this may print an invoice (`BILL'), charge
1064 a credit card (`CARD'), or just add any necessary (pseudo-)payment (`COMP').
1066 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
1067 and the invoice events web interface.
1069 If there is an error, returns the error, otherwise returns false.
1071 Options are passed as name-value pairs.
1073 Currently available options are:
1075 invoice_time - Use this time when deciding when to print invoices and
1076 late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse>
1077 for conversion functions.
1079 batch_card - This option is deprecated. See the invoice events web interface
1080 to control whether cards are batched or run against a realtime gateway.
1082 report_badcard - This option is deprecated.
1084 force_print - This option is deprecated; see the invoice events web interface.
1089 my( $self, %options ) = @_;
1090 my $invoice_time = $options{'invoice_time'} || time;
1093 local $SIG{HUP} = 'IGNORE';
1094 local $SIG{INT} = 'IGNORE';
1095 local $SIG{QUIT} = 'IGNORE';
1096 local $SIG{TERM} = 'IGNORE';
1097 local $SIG{TSTP} = 'IGNORE';
1098 local $SIG{PIPE} = 'IGNORE';
1100 my $oldAutoCommit = $FS::UID::AutoCommit;
1101 local $FS::UID::AutoCommit = 0;
1104 my $balance = $self->balance;
1105 warn "collect customer". $self->custnum. ": balance $balance" if $Debug;
1106 unless ( $balance > 0 ) { #redundant?????
1107 $dbh->rollback if $oldAutoCommit; #hmm
1111 foreach my $cust_bill (
1112 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
1115 #this has to be before next's
1116 my $amount = sprintf( "%.2f", $balance < $cust_bill->owed
1120 $balance = sprintf( "%.2f", $balance - $amount );
1122 next unless $cust_bill->owed > 0;
1124 # don't try to charge for the same invoice if it's already in a batch
1125 #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
1127 warn "invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ", amount $amount, balance $balance)" if $Debug;
1129 next unless $amount > 0;
1131 foreach my $part_bill_event (
1132 sort { $a->seconds <=> $b->seconds
1133 || $a->weight <=> $b->weight
1134 || $a->eventpart <=> $b->eventpart }
1135 grep { $_->seconds <= ( $invoice_time - $cust_bill->_date )
1136 && ! qsearchs( 'cust_bill_event', {
1137 'invnum' => $cust_bill->invnum,
1138 'eventpart' => $_->eventpart,
1142 qsearch('part_bill_event', { 'payby' => $self->payby,
1143 'disabled' => '', } )
1145 warn "calling invoice event (". $part_bill_event->eventcode. ")\n"
1147 my $cust_main = $self; #for callback
1148 my $error = eval $part_bill_event->eventcode;
1151 my $statustext = '';
1155 } elsif ( $error ) {
1157 $statustext = $error;
1162 #add cust_bill_event
1163 my $cust_bill_event = new FS::cust_bill_event {
1164 'invnum' => $cust_bill->invnum,
1165 'eventpart' => $part_bill_event->eventpart,
1166 '_date' => $invoice_time,
1167 'status' => $status,
1168 'statustext' => $statustext,
1170 $error = $cust_bill_event->insert;
1172 #$dbh->rollback if $oldAutoCommit;
1173 #return "error: $error";
1175 # gah, even with transactions.
1176 $dbh->commit if $oldAutoCommit; #well.
1177 my $e = 'WARNING: Event run but database not updated - '.
1178 'error inserting cust_bill_event, invnum #'. $cust_bill->invnum.
1179 ', eventpart '. $part_bill_event->eventpart.
1190 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1197 Returns the total owed for this customer on all invoices
1198 (see L<FS::cust_bill/owed>).
1204 $self->total_owed_date(2145859200); #12/31/2037
1207 =item total_owed_date TIME
1209 Returns the total owed for this customer on all invoices with date earlier than
1210 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
1211 see L<Time::Local> and L<Date::Parse> for conversion functions.
1215 sub total_owed_date {
1219 foreach my $cust_bill (
1220 grep { $_->_date <= $time }
1221 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
1223 $total_bill += $cust_bill->owed;
1225 sprintf( "%.2f", $total_bill );
1230 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1231 to outstanding invoice balances in chronological order and returns the value
1232 of any remaining unapplied credits available for refund
1233 (see L<FS::cust_refund>).
1240 return 0 unless $self->total_credited;
1242 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1243 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1245 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
1246 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
1250 foreach my $cust_bill ( @invoices ) {
1253 if ( !defined($credit) || $credit->credited == 0) {
1254 $credit = pop @credits or last;
1257 if ($cust_bill->owed >= $credit->credited) {
1258 $amount=$credit->credited;
1260 $amount=$cust_bill->owed;
1263 my $cust_credit_bill = new FS::cust_credit_bill ( {
1264 'crednum' => $credit->crednum,
1265 'invnum' => $cust_bill->invnum,
1266 'amount' => $amount,
1268 my $error = $cust_credit_bill->insert;
1269 die $error if $error;
1271 redo if ($cust_bill->owed > 0);
1275 return $self->total_credited;
1278 =item apply_payments
1280 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
1281 to outstanding invoice balances in chronological order.
1283 #and returns the value of any remaining unapplied payments.
1287 sub apply_payments {
1292 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
1293 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
1295 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
1296 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
1300 foreach my $cust_bill ( @invoices ) {
1303 if ( !defined($payment) || $payment->unapplied == 0 ) {
1304 $payment = pop @payments or last;
1307 if ( $cust_bill->owed >= $payment->unapplied ) {
1308 $amount = $payment->unapplied;
1310 $amount = $cust_bill->owed;
1313 my $cust_bill_pay = new FS::cust_bill_pay ( {
1314 'paynum' => $payment->paynum,
1315 'invnum' => $cust_bill->invnum,
1316 'amount' => $amount,
1318 my $error = $cust_bill_pay->insert;
1319 die $error if $error;
1321 redo if ( $cust_bill->owed > 0);
1325 return $self->total_unapplied_payments;
1328 =item total_credited
1330 Returns the total outstanding credit (see L<FS::cust_credit>) for this
1331 customer. See L<FS::cust_credit/credited>.
1335 sub total_credited {
1337 my $total_credit = 0;
1338 foreach my $cust_credit ( qsearch('cust_credit', {
1339 'custnum' => $self->custnum,
1341 $total_credit += $cust_credit->credited;
1343 sprintf( "%.2f", $total_credit );
1346 =item total_unapplied_payments
1348 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
1349 See L<FS::cust_pay/unapplied>.
1353 sub total_unapplied_payments {
1355 my $total_unapplied = 0;
1356 foreach my $cust_pay ( qsearch('cust_pay', {
1357 'custnum' => $self->custnum,
1359 $total_unapplied += $cust_pay->unapplied;
1361 sprintf( "%.2f", $total_unapplied );
1366 Returns the balance for this customer (total_owed minus total_credited
1367 minus total_unapplied_payments).
1374 $self->total_owed - $self->total_credited - $self->total_unapplied_payments
1378 =item balance_date TIME
1380 Returns the balance for this customer, only considering invoices with date
1381 earlier than TIME (total_owed_date minus total_credited minus
1382 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
1383 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
1392 $self->total_owed_date($time)
1393 - $self->total_credited
1394 - $self->total_unapplied_payments
1398 =item invoicing_list [ ARRAYREF ]
1400 If an arguement is given, sets these email addresses as invoice recipients
1401 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
1402 (except as warnings), so use check_invoicing_list first.
1404 Returns a list of email addresses (with svcnum entries expanded).
1406 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
1407 check it without disturbing anything by passing nothing.
1409 This interface may change in the future.
1413 sub invoicing_list {
1414 my( $self, $arrayref ) = @_;
1416 my @cust_main_invoice;
1417 if ( $self->custnum ) {
1418 @cust_main_invoice =
1419 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1421 @cust_main_invoice = ();
1423 foreach my $cust_main_invoice ( @cust_main_invoice ) {
1424 #warn $cust_main_invoice->destnum;
1425 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
1426 #warn $cust_main_invoice->destnum;
1427 my $error = $cust_main_invoice->delete;
1428 warn $error if $error;
1431 if ( $self->custnum ) {
1432 @cust_main_invoice =
1433 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1435 @cust_main_invoice = ();
1437 my %seen = map { $_->address => 1 } @cust_main_invoice;
1438 foreach my $address ( @{$arrayref} ) {
1439 #unless ( grep { $address eq $_->address } @cust_main_invoice ) {
1440 next if exists $seen{$address} && $seen{$address};
1441 $seen{$address} = 1;
1442 my $cust_main_invoice = new FS::cust_main_invoice ( {
1443 'custnum' => $self->custnum,
1446 my $error = $cust_main_invoice->insert;
1447 warn $error if $error;
1450 if ( $self->custnum ) {
1452 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1458 =item check_invoicing_list ARRAYREF
1460 Checks these arguements as valid input for the invoicing_list method. If there
1461 is an error, returns the error, otherwise returns false.
1465 sub check_invoicing_list {
1466 my( $self, $arrayref ) = @_;
1467 foreach my $address ( @{$arrayref} ) {
1468 my $cust_main_invoice = new FS::cust_main_invoice ( {
1469 'custnum' => $self->custnum,
1472 my $error = $self->custnum
1473 ? $cust_main_invoice->check
1474 : $cust_main_invoice->checkdest
1476 return $error if $error;
1481 =item default_invoicing_list
1483 Sets the invoicing list to all accounts associated with this customer.
1487 sub default_invoicing_list {
1490 foreach my $cust_pkg ( $self->all_pkgs ) {
1491 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
1493 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
1494 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
1496 push @list, map { $_->email } @svc_acct;
1498 $self->invoicing_list(\@list);
1501 =item invoicing_list_addpost
1503 Adds postal invoicing to this customer. If this customer is already configured
1504 to receive postal invoices, does nothing.
1508 sub invoicing_list_addpost {
1510 return if grep { $_ eq 'POST' } $self->invoicing_list;
1511 my @invoicing_list = $self->invoicing_list;
1512 push @invoicing_list, 'POST';
1513 $self->invoicing_list(\@invoicing_list);
1516 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
1518 Returns an array of customers referred by this customer (referral_custnum set
1519 to this custnum). If DEPTH is given, recurses up to the given depth, returning
1520 customers referred by customers referred by this customer and so on, inclusive.
1521 The default behavior is DEPTH 1 (no recursion).
1525 sub referral_cust_main {
1527 my $depth = @_ ? shift : 1;
1528 my $exclude = @_ ? shift : {};
1531 map { $exclude->{$_->custnum}++; $_; }
1532 grep { ! $exclude->{ $_->custnum } }
1533 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
1537 map { $_->referral_cust_main($depth-1, $exclude) }
1544 =item referral_cust_main_ncancelled
1546 Same as referral_cust_main, except only returns customers with uncancelled
1551 sub referral_cust_main_ncancelled {
1553 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
1556 =item referral_cust_pkg [ DEPTH ]
1558 Like referral_cust_main, except returns a flat list of all unsuspended (and
1559 uncancelled) packages for each customer. The number of items in this list may
1560 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
1564 sub referral_cust_pkg {
1566 my $depth = @_ ? shift : 1;
1568 map { $_->unsuspended_pkgs }
1569 grep { $_->unsuspended_pkgs }
1570 $self->referral_cust_main($depth);
1573 =item credit AMOUNT, REASON
1575 Applies a credit to this customer. If there is an error, returns the error,
1576 otherwise returns false.
1581 my( $self, $amount, $reason ) = @_;
1582 my $cust_credit = new FS::cust_credit {
1583 'custnum' => $self->custnum,
1584 'amount' => $amount,
1585 'reason' => $reason,
1587 $cust_credit->insert;
1590 =item charge AMOUNT PKG COMMENT
1592 Creates a one-time charge for this customer. If there is an error, returns
1593 the error, otherwise returns false.
1598 my ( $self, $amount, $pkg, $comment ) = @_;
1600 my $part_pkg = new FS::part_pkg ( {
1601 'pkg' => $pkg || 'One-time charge',
1602 'comment' => $comment || '$'. sprintf("%.2f".$amount),
1619 =item check_and_rebuild_fuzzyfiles
1623 sub check_and_rebuild_fuzzyfiles {
1624 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1625 -e "$dir/cust_main.last" && -e "$dir/cust_main.company"
1626 or &rebuild_fuzzyfiles;
1629 =item rebuild_fuzzyfiles
1633 sub rebuild_fuzzyfiles {
1635 use Fcntl qw(:flock);
1637 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1641 open(LASTLOCK,">>$dir/cust_main.last")
1642 or die "can't open $dir/cust_main.last: $!";
1643 flock(LASTLOCK,LOCK_EX)
1644 or die "can't lock $dir/cust_main.last: $!";
1646 my @all_last = map $_->getfield('last'), qsearch('cust_main', {});
1648 grep $_, map $_->getfield('ship_last'), qsearch('cust_main',{})
1649 if defined dbdef->table('cust_main')->column('ship_last');
1651 open (LASTCACHE,">$dir/cust_main.last.tmp")
1652 or die "can't open $dir/cust_main.last.tmp: $!";
1653 print LASTCACHE join("\n", @all_last), "\n";
1654 close LASTCACHE or die "can't close $dir/cust_main.last.tmp: $!";
1656 rename "$dir/cust_main.last.tmp", "$dir/cust_main.last";
1661 open(COMPANYLOCK,">>$dir/cust_main.company")
1662 or die "can't open $dir/cust_main.company: $!";
1663 flock(COMPANYLOCK,LOCK_EX)
1664 or die "can't lock $dir/cust_main.company: $!";
1666 my @all_company = grep $_ ne '', map $_->company, qsearch('cust_main',{});
1668 grep $_ ne '', map $_->ship_company, qsearch('cust_main', {})
1669 if defined dbdef->table('cust_main')->column('ship_last');
1671 open (COMPANYCACHE,">$dir/cust_main.company.tmp")
1672 or die "can't open $dir/cust_main.company.tmp: $!";
1673 print COMPANYCACHE join("\n", @all_company), "\n";
1674 close COMPANYCACHE or die "can't close $dir/cust_main.company.tmp: $!";
1676 rename "$dir/cust_main.company.tmp", "$dir/cust_main.company";
1686 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1687 open(LASTCACHE,"<$dir/cust_main.last")
1688 or die "can't open $dir/cust_main.last: $!";
1689 my @array = map { chomp; $_; } <LASTCACHE>;
1699 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1700 open(COMPANYCACHE,"<$dir/cust_main.company")
1701 or die "can't open $dir/cust_main.last: $!";
1702 my @array = map { chomp; $_; } <COMPANYCACHE>;
1707 =item append_fuzzyfiles LASTNAME COMPANY
1711 sub append_fuzzyfiles {
1712 my( $last, $company ) = @_;
1714 &check_and_rebuild_fuzzyfiles;
1716 use Fcntl qw(:flock);
1718 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1722 open(LAST,">>$dir/cust_main.last")
1723 or die "can't open $dir/cust_main.last: $!";
1725 or die "can't lock $dir/cust_main.last: $!";
1727 print LAST "$last\n";
1730 or die "can't unlock $dir/cust_main.last: $!";
1736 open(COMPANY,">>$dir/cust_main.company")
1737 or die "can't open $dir/cust_main.company: $!";
1738 flock(COMPANY,LOCK_EX)
1739 or die "can't lock $dir/cust_main.company: $!";
1741 print COMPANY "$company\n";
1743 flock(COMPANY,LOCK_UN)
1744 or die "can't unlock $dir/cust_main.company: $!";
1758 The delete method should possibly take an FS::cust_main object reference
1759 instead of a scalar customer number.
1761 Bill and collect options should probably be passed as references instead of a
1764 There should probably be a configuration file with a list of allowed credit
1767 No multiple currency support (probably a larger project than just this module).
1771 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
1772 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
1773 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.