use strict;
use vars qw( %info );
use Time::Local qw( timelocal );
+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 $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,
- # and append the setup fee to @$details.
+ # 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);
my $permonth = $charge / $self->freq;
my $months = ( ( $self->freq - 1 ) + ($mend-$mnow) / ($mend-$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 ( ( $self->option('add_full_period',1)
- || $self->option('prorate_defer_bill',1) # necessary
- )
- && $months < $self->freq
- )
- {
+ }
+ 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);
+ }
+
$months += $self->freq;
$$sdate = $self->add_freq($mstart);
}