X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fcust_pay.pm;h=d98d11ecb38162a4b39c087e261510b630e5f386;hb=573139dbd6c37808697bfa72a3a468bb0980d4dd;hp=53db722ddcb755dae6a7b58878ad3b7349196943;hpb=78fe7364c8d54eb76a908f900326a673d7d1e1fc;p=freeside.git diff --git a/FS/FS/cust_pay.pm b/FS/FS/cust_pay.pm index 53db722dd..d98d11ecb 100644 --- a/FS/FS/cust_pay.pm +++ b/FS/FS/cust_pay.pm @@ -12,6 +12,7 @@ use Text::Template; use FS::UID qw( getotaker ); use FS::Misc qw( send_email ); use FS::Record qw( dbh qsearch qsearchs ); +use FS::CurrentUser; use FS::payby; use FS::cust_main_Mixin; use FS::payinfo_transaction_Mixin; @@ -140,6 +141,10 @@ For backwards-compatibility and convenience, if the additional field invnum is defined, an FS::cust_bill_pay record for the full amount of the payment will be created. In this case, custnum is optional. +If the additional field discount_term is defined then a prepayment discount +is taken for that length of time. It is an error for the customer to owe +after this payment is made. + A hash of optional arguments may be passed. Currently "manual" is supported. If true, a payment receipt is sent instead of a statement when 'payment_receipt_email' configuration option is set. @@ -179,7 +184,75 @@ sub insert { $error = $self->SUPER::insert; if ( $error ) { $dbh->rollback if $oldAutoCommit; - return "error inserting $self: $error"; + return "error inserting cust_pay: $error"; + } + + if ( my $credit_type = $conf->config('prepayment_discounts-credit_type') ) { + if ( my $months = $self->discount_term ) { + # XXX this should be moved out somewhere, but discount_term_values + # doesn't fit right + my ($cust_bill) = ($cust_main->cust_bill)[-1]; # most recent invoice + return "can't accept prepayment for an unbilled customer" if !$cust_bill; + + # %billing_pkgs contains this customer's active monthly packages. + # Recurring fees for those packages will be credited and then rebilled + # for the full discount term. Other packages on the last invoice + # (canceled, non-monthly recurring, or one-time charges) will be + # left as they are. + my %billing_pkgs = map { $_->pkgnum => $_ } + grep { $_->part_pkg->freq eq '1' } + $cust_main->billing_pkgs; + my $credit = 0; # sum of recurring charges from that invoice + my $last_bill_date = 0; # the real bill date + foreach my $item ( $cust_bill->cust_bill_pkg ) { + next if !exists($billing_pkgs{$item->pkgnum}); # skip inactive packages + $credit += $item->recur; + $last_bill_date = $item->cust_pkg->last_bill + if defined($item->cust_pkg) + and $item->cust_pkg->last_bill > $last_bill_date + } + + my $cust_credit = new FS::cust_credit { + 'custnum' => $self->custnum, + 'amount' => sprintf('%.2f', $credit), + 'reason' => 'customer chose to prepay for discount', + }; + $error = $cust_credit->insert('reason_type' => $credit_type); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error inserting prepayment credit: $error"; + } + # don't apply it yet + + # bill for the entire term + $_->bill($_->last_bill) foreach (values %billing_pkgs); + $error = $cust_main->bill( + # no recurring_only, we want unbilled packages with start dates to + # get billed + 'no_usage_reset' => 1, + 'time' => $last_bill_date, # not $cust_bill->_date + 'pkg_list' => [ values %billing_pkgs ], + 'freq_override' => $months, + ); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error inserting cust_pay: $error"; + } + $error = $cust_main->apply_payments_and_credits; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error inserting cust_pay: $error"; + } + my $new_balance = $cust_main->balance; + if ($new_balance > 0) { + $dbh->rollback if $oldAutoCommit; + return "balance after prepay discount attempt: $new_balance"; + } + # user friendly: override the "apply only to this invoice" mode + $self->invnum(''); + + } + } if ( $self->invnum ) { @@ -192,11 +265,11 @@ sub insert { $error = $cust_bill_pay->insert(%options); if ( $error ) { if ( $ignore_noapply ) { - warn "warning: error inserting $cust_bill_pay: $error ". + warn "warning: error inserting cust_bill_pay: $error ". "(ignore_noapply flag set; inserting cust_pay record anyway)\n"; } else { $dbh->rollback if $oldAutoCommit; - return "error inserting $cust_bill_pay: $error"; + return "error inserting cust_bill_pay: $error"; } } } @@ -214,10 +287,41 @@ sub insert { } #eslaf + #bill setup fees for voip_cdr bill_every_call packages + #some false laziness w/search in freeside-cdrd + my $addl_from = + 'LEFT JOIN part_pkg USING ( pkgpart ) '. + "LEFT JOIN part_pkg_option + ON ( cust_pkg.pkgpart = part_pkg_option.pkgpart + AND part_pkg_option.optionname = 'bill_every_call' )"; + + my $extra_sql = " AND plan = 'voip_cdr' AND optionvalue = '1' ". + " AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 ) "; + + my @cust_pkg = qsearch({ + 'table' => 'cust_pkg', + 'addl_from' => $addl_from, + 'hashref' => { 'custnum' => $self->custnum, + 'susp' => '', + 'cancel' => '', + }, + 'extra_sql' => $extra_sql, + }); + + if ( @cust_pkg ) { + warn "voip_cdr bill_every_call packages found; billing customer\n"; + my $bill_error = $self->cust_main->bill_and_collect( 'fatal' => 'return' ); + if ( $bill_error ) { + warn "WARNING: Error billing customer: $bill_error\n"; + } + } + #end of billing setup fees for voip_cdr bill_every_call packages + $dbh->commit or die $dbh->errstr if $oldAutoCommit; #payment receipt - my $trigger = $conf->config('payment_receipt-trigger') || 'cust_pay'; + my $trigger = $conf->config('payment_receipt-trigger', + $self->cust_main->agentnum) || 'cust_pay'; if ( $trigger eq 'cust_pay' ) { my $error = $self->send_receipt( 'manual' => $options{'manual'}, @@ -351,14 +455,17 @@ sub delete { } -=item replace OLD_RECORD +=item replace [ OLD_RECORD ] You can, but probably shouldn't modify payments... +Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not +supplied, replaces this record. If there is an error, returns the error, +otherwise returns false. + =cut sub replace { - #return "Can't modify payment!" my $self = shift; return "Can't modify closed payment" if $self->closed =~ /^Y/i; $self->SUPER::replace(@_); @@ -374,7 +481,7 @@ returns the error, otherwise returns false. Called by the insert method. sub check { my $self = shift; - $self->otaker(getotaker) unless ($self->otaker); + $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum; my $error = $self->ut_numbern('paynum') @@ -387,6 +494,7 @@ sub check { || $self->ut_enum('closed', [ '', 'Y' ]) || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum') || $self->payinfo_check() + || $self->ut_numbern('discount_term') ; return $error if $error; @@ -398,6 +506,9 @@ sub check { $self->_date(time) unless $self->_date; + return "invalid discount_term" + if ($self->discount_term && $self->discount_term < 2); + #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it # # UNIQUE index should catch this too, without race conditions, but this # # should give a better error message the other 99.9% of the time... @@ -446,76 +557,96 @@ sub send_receipt { my $conf = new FS::Conf; - return '' - unless $conf->exists('payment_receipt_email') - && grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list; + return '' unless $conf->exists('payment_receipt', $cust_main->agentnum); + + my @invoicing_list = $cust_main->invoicing_list_emailonly; + return '' unless @invoicing_list; $cust_bill ||= ($cust_main->cust_bill)[-1]; #rather inefficient though? + my $error = ''; + if ( ( exists($opt->{'manual'}) && $opt->{'manual'} ) - || ! $conf->exists('invoice_html_statement') + #|| ! $conf->exists('invoice_html_statement') || ! $cust_bill - ) { - - my $receipt_template = new Text::Template ( - TYPE => 'ARRAY', - SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ], - ) or do { - warn "can't create payment receipt template: $Text::Template::ERROR"; - return ''; - }; + ) + { + my $msgnum = $conf->config('payment_receipt_msgnum', $cust_main->agentnum); + if ( $msgnum ) { + my $msg_template = FS::msg_template->by_key($msgnum); + $error = $msg_template->send( + 'cust_main' => $cust_main, + 'object' => $self, + 'from_config' => 'payment_receipt_from', + ); + + } elsif ( $conf->exists('payment_receipt_email') ) { + + my $receipt_template = new Text::Template ( + TYPE => 'ARRAY', + SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ], + ) or do { + warn "can't create payment receipt template: $Text::Template::ERROR"; + return ''; + }; + + my $payby = $self->payby; + my $payinfo = $self->payinfo; + $payby =~ s/^BILL$/Check/ if $payinfo; + if ( $payby eq 'CARD' || $payby eq 'CHEK' ) { + $payinfo = $self->paymask + } else { + $payinfo = $self->decrypt($payinfo); + } + $payby =~ s/^CHEK$/Electronic check/; + + my %fill_in = ( + 'date' => time2str("%a %B %o, %Y", $self->_date), + 'name' => $cust_main->name, + 'paynum' => $self->paynum, + 'paid' => sprintf("%.2f", $self->paid), + 'payby' => ucfirst(lc($payby)), + 'payinfo' => $payinfo, + 'balance' => $cust_main->balance, + 'company_name' => $conf->config('company_name', $cust_main->agentnum), + ); + + if ( $opt->{'cust_pkg'} ) { + $fill_in{'pkg'} = $opt->{'cust_pkg'}->part_pkg->pkg; + #setup date, other things? + } - my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } - $cust_main->invoicing_list; + $error = send_email( + 'from' => $conf->config('invoice_from', $cust_main->agentnum), + #invoice_from??? well as good as any + 'to' => \@invoicing_list, + 'subject' => 'Payment receipt', + 'body' => [ $receipt_template->fill_in( HASH => \%fill_in ) ], + ); - my $payby = $self->payby; - my $payinfo = $self->payinfo; - $payby =~ s/^BILL$/Check/ if $payinfo; - if ( $payby eq 'CARD' || $payby eq 'CHEK' ) { - $payinfo = $self->paymask } else { - $payinfo = $self->decrypt($payinfo); - } - $payby =~ s/^CHEK$/Electronic check/; - - my %fill_in = ( - 'date' => time2str("%a %B %o, %Y", $self->_date), - 'name' => $cust_main->name, - 'paynum' => $self->paynum, - 'paid' => sprintf("%.2f", $self->paid), - 'payby' => ucfirst(lc($payby)), - 'payinfo' => $payinfo, - 'balance' => $cust_main->balance, - 'company_name' => $conf->config('company_name', $cust_main->agentnum), - ); - if ( $opt->{'cust_pkg'} ) { - $fill_in{'pkg'} = $opt->{'cust_pkg'}->part_pkg->pkg; - #setup date, other things? - } + warn "payment_receipt is on, but no payment_receipt_msgnum\n"; - send_email( - 'from' => $conf->config('invoice_from', $cust_main->agentnum), - #invoice_from??? well as good as any - 'to' => \@invoicing_list, - 'subject' => 'Payment receipt', - 'body' => [ $receipt_template->fill_in( HASH => \%fill_in ) ], - ); + } - } else { + } else { #not manual my $queue = new FS::queue { 'paynum' => $self->paynum, 'job' => 'FS::cust_bill::queueable_email', }; - $queue->insert( - 'invnum' => $cust_bill->invnum, - 'template' => 'statement', + $error = $queue->insert( + 'invnum' => $cust_bill->invnum, + 'template' => 'statement', + 'notice_name' => 'Statement', + 'no_coupon' => 1, ); } - + + warn "send_receipt: $error\n" if $error; } =item cust_bill_pay @@ -728,9 +859,10 @@ sub _upgrade_data { #class method my $h_cust_pay = $cust_pay->h_search('insert'); if ( $h_cust_pay ) { next if $cust_pay->otaker eq $h_cust_pay->history_user; - $cust_pay->otaker($h_cust_pay->history_user); + #$cust_pay->otaker($h_cust_pay->history_user); + $cust_pay->set('otaker', $h_cust_pay->history_user); } else { - $cust_pay->otaker('legacy'); + $cust_pay->set('otaker', 'legacy'); } delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge @@ -756,15 +888,25 @@ sub _upgrade_data { #class method # payinfo N/A upgrade ### + #XXX remove the 'N/A (tokenized)' part (or just this entire thing) + my @na_cust_pay = qsearch( { 'table' => 'cust_pay', - 'hashref' => { 'payinfo' => 'N/A' }, - 'extra_sql' => "AND payby IN ( 'CARD', 'CHEK' )", + 'hashref' => {}, #could be encrypted# { 'payinfo' => 'N/A' }, + 'extra_sql' => "WHERE ( payinfo = 'N/A' OR paymask = 'N/AA' OR paymask = 'N/A (tokenized)' ) AND payby IN ( 'CARD', 'CHEK' )", } ); foreach my $na ( @na_cust_pay ) { + + next unless $na->payinfo eq 'N/A'; + my $cust_pay_pending = qsearchs('cust_pay_pending', { 'paynum' => $na->paynum } ); + unless ( $cust_pay_pending ) { + warn " *** WARNING: not-yet recoverable N/A card for payment ". + $na->paynum. " (no cust_pay_pending)\n"; + next; + } $na->$_($cust_pay_pending->$_) for qw( payinfo paymask ); my $error = $na->replace; if ( $error ) { @@ -779,7 +921,9 @@ sub _upgrade_data { #class method # otaker->usernum upgrade ### + delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge $class->_upgrade_otaker(%opts); + $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it }