use strict;
use vars qw( %info );
-use Time::Local qw( timelocal );
+use Time::Local qw( timelocal timelocal_nocheck );
+use Date::Format qw( time2str );
%info = (
'disabled' => 1,
'billing day',
'type' => 'checkbox',
},
+ 'prorate_verbose' => {
+ 'name' => 'Show prorate details on the invoice',
+ 'type' => 'checkbox',
+ },
},
- 'fieldorder' => [ qw(prorate_defer_bill prorate_round_day add_full_period) ],
+ 'fieldorder' => [ qw(prorate_defer_bill prorate_round_day
+ add_full_period prorate_verbose) ],
);
sub fieldorder {
instead of using the exact time.
- prorate_defer_bill: Don't bill the prorate interval until the prorate
day arrives.
+- prorate_verbose: Generate details to explain the prorate calculations.
=cut
die "no cutoff_day" unless $cutoff_day;
die "can't prorate non-monthly package\n" if $self->freq =~ /\D/;
+ my $money_char = FS::Conf->new->config('money_char') || '$';
+
my $charge = $self->base_recur($cust_pkg, $sdate) || 0;
- my $mnow = $$sdate;
-
- # if this is the first bill but the bill date has been set
- # (by prorate_defer_bill), calculate from the setup date,
- # and append the setup fee to @$details.
- if ( $self->option('prorate_defer_bill',1)
- and ! $cust_pkg->getfield('last_bill')
- and $cust_pkg->setup ) {
- #warn "[calc_prorate] #".$cust_pkg->pkgnum.": running deferred setup\n";
- $param->{'setup_fee'} = $self->calc_setup($cust_pkg, $$sdate, $details);
- $mnow = $cust_pkg->setup;
- }
+ my $add_period = $self->option('add_full_period',1);
+
+ my $mnow = $$sdate;
+
+ # if this is the first bill but the bill date has been set
+ # (by prorate_defer_bill), calculate from the setup date,
+ # append the setup fee to @$details, and make sure to bill for
+ # a full period after the bill date.
+ if ( $self->option('prorate_defer_bill',1)
+ && ! $cust_pkg->getfield('last_bill')
+ && $cust_pkg->setup
+ )
+ {
+ #warn "[calc_prorate] #".$cust_pkg->pkgnum.": running deferred setup\n";
+ $param->{'setup_fee'} = $self->calc_setup($cust_pkg, $$sdate, $details);
+ $mnow = $cust_pkg->setup;
+ $add_period = 1;
+ }
- my ($mend, $mstart);
- ($mnow, $mend, $mstart) = $self->_endpoints($mnow, $cutoff_day);
+ my ($mend, $mstart);
+ ($mnow, $mend, $mstart) = $self->_endpoints($mnow, $cutoff_day);
- # next bill date will be figured as $$sdate + one period
- $$sdate = $mstart;
+ # next bill date will be figured as $$sdate + one period
+ $$sdate = $mstart;
- my $permonth = $charge / $self->freq;
- my $months = ( ( $self->freq - 1 ) + ($mend-$mnow) / ($mend-$mstart) );
+ my $permonth = $charge / $self->freq;
+ my $months = ( ( $self->freq - 1 ) + ($mend-$mnow) / ($mend-$mstart) );
- # add a full period if currently billing for a partial period
- # or periods up to freq_override if billing for an override interval
- if ( ($param->{'freq_override'} || 0) > 1 ) {
- $months += $param->{'freq_override'} - 1;
- }
- elsif ( ( $self->option('add_full_period',1)
- or $self->option('prorate_defer_bill',1) )
- and $months < $self->freq ) {
- $months += $self->freq;
- $$sdate = $self->add_freq($mstart);
+ if ( $self->option('prorate_verbose',1)
+ and $months > 0 and $months < $self->freq ) {
+ push @$details,
+ 'Prorated (' . time2str('%b %d', $mnow) .
+ ' - ' . time2str('%b %d', $mend) . '): ' . $money_char .
+ sprintf('%.2f', $permonth * $months + 0.00000001 );
+ }
+
+ # add a full period if currently billing for a partial period
+ # or periods up to freq_override if billing for an override interval
+ if ( ($param->{'freq_override'} || 0) > 1 ) {
+ $months += $param->{'freq_override'} - 1;
+ }
+ elsif ( $add_period && $months < $self->freq) {
+
+ if ( $self->option('prorate_verbose',1) ) {
+ # calculate the prorated and add'l period charges
+ push @$details,
+ 'First full month: ' . $money_char .
+ sprintf('%.2f', $permonth);
}
- $param->{'months'} = $months;
- $charge = sprintf('%.2f', $permonth * $months);
+ $months += $self->freq;
+ $$sdate = $self->add_freq($mstart);
+ }
+
+ $param->{'months'} = $months;
+ #so 1.005 rounds to 1.01
+ $charge = sprintf('%.2f', $permonth * $months + 0.00000001 );
return $charge;
}
}
my $mend;
my $mstart;
- # if cutoff day > 28, force it to the 1st of next month
- if ( $cutoff_day > 28 ) {
- $cutoff_day = 1;
- # and if we are currently after the 28th, roll the current day
- # forward to that day
- if ( $mday > 28 ) {
- $mday = 1;
- #set $mnow = $mend so the amount billed will be zero
- $mnow = timelocal(0,0,0,1,$mon == 11 ? 0 : $mon + 1,$year+($mon==11));
- }
- }
if ( $mday >= $cutoff_day ) {
$mend =
- timelocal(0,0,0,$cutoff_day,$mon == 11 ? 0 : $mon + 1,$year+($mon==11));
+ timelocal_nocheck(0,0,0,$cutoff_day,$mon == 11 ? 0 : $mon + 1,$year+($mon==11));
$mstart =
- timelocal(0,0,0,$cutoff_day,$mon,$year);
+ timelocal_nocheck(0,0,0,$cutoff_day,$mon,$year);
}
else {
$mend =
- timelocal(0,0,0,$cutoff_day,$mon,$year);
+ timelocal_nocheck(0,0,0,$cutoff_day,$mon,$year);
$mstart =
- timelocal(0,0,0,$cutoff_day,$mon == 0 ? 11 : $mon - 1,$year-($mon==0));
+ timelocal_nocheck(0,0,0,$cutoff_day,$mon == 0 ? 11 : $mon - 1,$year-($mon==0));
}
return ($mnow, $mend, $mstart);
}