package FS::part_pkg::flat;
+use base qw( FS::part_pkg::prorate_Mixin
+ FS::part_pkg::discount_Mixin
+ FS::part_pkg
+ );
use strict;
-use vars qw( @ISA %info
- %usage_fields %usage_recharge_fields
- @usage_fieldorder @usage_recharge_fieldorder
- );
+use vars qw( %info %usage_recharge_fields @usage_recharge_fieldorder );
use Tie::IxHash;
-use List::Util qw(min); # max);
-#use FS::Record qw(qsearch);
+use List::Util qw( min );
use FS::UI::bytecount;
use FS::Conf;
-use FS::part_pkg;
-use FS::cust_bill_pkg_discount;
-
-@ISA = qw(FS::part_pkg FS::part_pkg::prorate_Mixin);
tie my %temporalities, 'Tie::IxHash',
'upcoming' => "Upcoming (future)",
'preceding' => "Preceding (past)",
;
-%usage_fields = (
-
- 'seconds' => { 'name' => 'Time limit for this package',
- 'default' => '',
- 'check' => sub { shift =~ /^\d*$/ },
- },
- 'upbytes' => { 'name' => 'Upload limit for this package',
- 'default' => '',
- 'check' => sub { shift =~ /^\d*$/ },
- 'format' => \&FS::UI::bytecount::display_bytecount,
- 'parse' => \&FS::UI::bytecount::parse_bytecount,
- },
- 'downbytes' => { 'name' => 'Download limit for this package',
- 'default' => '',
- 'check' => sub { shift =~ /^\d*$/ },
- 'format' => \&FS::UI::bytecount::display_bytecount,
- 'parse' => \&FS::UI::bytecount::parse_bytecount,
- },
- 'totalbytes' => { 'name' => 'Transfer limit for this package',
- 'default' => '',
- 'check' => sub { shift =~ /^\d*$/ },
- 'format' => \&FS::UI::bytecount::display_bytecount,
- 'parse' => \&FS::UI::bytecount::parse_bytecount,
- },
-);
-
-%usage_recharge_fields = (
-
- 'recharge_amount' => { 'name' => 'Cost of recharge for this package',
- 'default' => '',
- 'check' => sub { shift =~ /^\d*(\.\d{2})?$/ },
- },
- 'recharge_seconds' => { 'name' => 'Recharge time for this package',
- 'default' => '',
- 'check' => sub { shift =~ /^\d*$/ },
- },
- 'recharge_upbytes' => { 'name' => 'Recharge upload for this package',
- 'default' => '',
- 'check' => sub { shift =~ /^\d*$/ },
- 'format' => \&FS::UI::bytecount::display_bytecount,
- 'parse' => \&FS::UI::bytecount::parse_bytecount,
- },
- 'recharge_downbytes' => { 'name' => 'Recharge download for this package',
- 'default' => '',
- 'check' => sub { shift =~ /^\d*$/ },
- 'format' => \&FS::UI::bytecount::display_bytecount,
- 'parse' => \&FS::UI::bytecount::parse_bytecount,
- },
- 'recharge_totalbytes' => { 'name' => 'Recharge transfer for this package',
- 'default' => '',
- 'check' => sub { shift =~ /^\d*$/ },
- 'format' => \&FS::UI::bytecount::display_bytecount,
- 'parse' => \&FS::UI::bytecount::parse_bytecount,
- },
- 'usage_rollover' => { 'name' => 'Allow usage from previous period to roll '.
- ' over into current period',
- 'type' => 'checkbox',
- },
- 'recharge_reset' => { 'name' => 'Reset usage to these values on manual '.
- 'package recharge',
- 'type' => 'checkbox',
- },
-);
-
-@usage_fieldorder = qw( seconds upbytes downbytes totalbytes );
-@usage_recharge_fieldorder = qw(
- recharge_amount recharge_seconds recharge_upbytes
- recharge_downbytes recharge_totalbytes
- usage_rollover recharge_reset
+tie my %contract_years, 'Tie::IxHash', (
+ '' => '(none)',
+ map { $_*12 => $_ } (1..5),
);
%info = (
'name' => 'Flat rate (anniversary billing)',
'shortname' => 'Anniversary',
+ 'inherit_fields' => [ 'prorate_Mixin', 'usage_Mixin', 'global_Mixin' ],
'fields' => {
- 'setup_fee' => { 'name' => 'Setup fee for this package',
- 'default' => 0,
- },
- 'recur_fee' => { 'name' => 'Recurring fee for this package',
- 'default' => 0,
- },
-
#false laziness w/voip_cdr.pm
'recur_temporality' => { 'name' => 'Charge recurring fee for period',
'type' => 'select',
'select_options' => \%temporalities,
},
- 'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
- ' of service at cancellation',
- 'type' => 'checkbox',
- },
#used in cust_pkg.pm so could add to any price plan
'expire_months' => { 'name' => 'Auto-add an expiration date this number of months out',
},
+ 'adjourn_months'=> { 'name' => 'Auto-add a suspension date this number of months out',
+ },
+ 'contract_end_months'=> {
+ 'name' => 'Auto-add a contract end date this number of years out',
+ 'type' => 'select',
+ 'select_options' => \%contract_years,
+ },
#used in cust_pkg.pm so could add to any price plan where it made sense
'start_1st' => { 'name' => 'Auto-add a start date to the 1st, ignoring the current month.',
'type' => 'checkbox',
'with the customer\'s other packages',
'type' => 'checkbox',
},
-
- %usage_fields,
- %usage_recharge_fields,
+ 'prorate_defer_bill' => {
+ 'name' => 'When synchronizing, defer the bill until '.
+ 'the customer\'s next bill date',
+ 'type' => 'checkbox',
+ },
+ 'prorate_round_day' => {
+ 'name' => 'When synchronizing, round the prorated '.
+ 'period to the nearest full day',
+ 'type' => 'checkbox',
+ },
+ 'add_full_period' => { 'disabled' => 1 }, # doesn't make sense with sync?
+
+ 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
+ 'type' => 'checkbox',
+ },
+ 'unsuspend_adjust_bill' =>
+ { 'name' => 'Adjust next bill date forward when '.
+ 'unsuspending',
+ 'type' => 'checkbox',
+ },
'externalid' => { 'name' => 'Optional External ID',
'default' => '',
},
},
- 'fieldorder' => [ qw( setup_fee recur_fee
- recur_temporality unused_credit
- expire_months start_1st sync_bill_date
- ),
- @usage_fieldorder, @usage_recharge_fieldorder,
- qw( externalid ),
+ 'fieldorder' => [ qw( recur_temporality
+ expire_months adjourn_months
+ contract_end_months
+ start_1st
+ sync_bill_date prorate_defer_bill prorate_round_day
+ suspend_bill unsuspend_adjust_bill
+ externalid ),
],
'weight' => 10,
);
+sub price_info {
+ my $self = shift;
+ my $conf = new FS::Conf;
+ my $money_char = $conf->config('money_char') || '$';
+ my $setup = $self->option('setup_fee') || 0;
+ my $recur = $self->option('recur_fee', 1) || 0;
+ my $str = '';
+ $str = $money_char . $setup . ' one-time' if $setup;
+ $str .= ', ' if ($setup && $recur);
+ $str .= $money_char . $recur . ' recurring ' if $recur;
+ $str;
+}
+
sub calc_setup {
- my($self, $cust_pkg, $sdate, $details ) = @_;
+ my($self, $cust_pkg, $sdate, $details, $param ) = @_;
+
+ return 0 if $self->prorate_setup($cust_pkg, $sdate);
my $i = 0;
my $count = $self->option( 'additional_count', 'quiet' ) || 0;
my $quantity = $cust_pkg->quantity || 1;
- sprintf("%.2f", $quantity * $self->unit_setup($cust_pkg, $sdate, $details) );
+ my $charge = $quantity * $self->unit_setup($cust_pkg, $sdate, $details);
+
+ my $discount = 0;
+ if ( $charge > 0 ) {
+ $param->{'setup_charge'} = $charge;
+ $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
+ delete $param->{'setup_charge'};
+ }
+
+ sprintf('%.2f', $charge - $discount);
}
sub unit_setup {
my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
return 0
- if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
+ if $self->recur_temporality eq 'preceding' && $last_bill == 0;
- if( $self->option('sync_bill_date') ) {
- return $self->calc_prorate(@_);
+ my $charge = $self->base_recur($cust_pkg, $sdate);
+ if ( my $cutoff_day = $self->cutoff_day($cust_pkg) ) {
+ $charge = $self->calc_prorate(@_, $cutoff_day);
}
- else {
- my $charge = $self->base_recur($cust_pkg);
- my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
-
- return sprintf('%.2f', $charge - $discount);
+ elsif ( $param->{freq_override} ) {
+ # XXX not sure if this should be mutually exclusive with sync_bill_date.
+ # Given the very specific problem that freq_override is meant to 'solve',
+ # it probably should.
+ $charge *= $param->{freq_override} if $param->{freq_override};
}
-}
-sub calc_discount {
- my($self, $cust_pkg, $sdate, $details, $param ) = @_;
+ my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
+ return sprintf('%.2f', $charge - $discount);
+}
- my $br = $self->base_recur($cust_pkg);
-
- my $tot_discount = 0;
- #UI enforces just 1 for now, will need ordering when they can be stacked
- my @cust_pkg_discount = $cust_pkg->cust_pkg_discount_active;
- foreach my $cust_pkg_discount ( @cust_pkg_discount ) {
- my $discount = $cust_pkg_discount->discount;
- #UI enforces one or the other (for now? probably for good)
- my $amount = 0;
- $amount += $discount->amount
- if $cust_pkg->pkgpart == $param->{real_pkgpart};
- $amount += sprintf('%.2f', $discount->percent * $br / 100 );
-
- my $chg_months = $param->{'months'} || $cust_pkg->part_pkg->freq;
-
- my $months = $discount->months
- ? min( $chg_months,
- $discount->months - $cust_pkg_discount->months_used )
- : $chg_months;
-
- my $error = $cust_pkg_discount->increment_months_used($months);
- die "error discounting: $error" if $error;
-
- $amount *= $months;
- $amount = sprintf('%.2f', $amount);
-
- next unless $amount > 0;
-
- #record details in cust_bill_pkg_discount
- my $cust_bill_pkg_discount = new FS::cust_bill_pkg_discount {
- 'pkgdiscountnum' => $cust_pkg_discount->pkgdiscountnum,
- 'amount' => $amount,
- 'months' => $months,
- };
- push @{ $param->{'discounts'} }, $cust_bill_pkg_discount;
-
- #add details on discount to invoice
- my $conf = new FS::Conf;
- my $money_char = $conf->config('money_char') || '$';
- $months = sprintf('%.2f', $months) if $months =~ /\./;
-
- my $d = 'Includes ';
- $d .= $discount->name. ' ' if $discount->name;
- $d .= 'discount of '. $discount->description_short;
- $d .= " for $months month". ( $months!=1 ? 's' : '' );
- $d .= ": $money_char$amount" if $months != 1 || $discount->percent;
- push @$details, $d;
-
- $tot_discount += $amount;
+sub cutoff_day {
+ my $self = shift;
+ my $cust_pkg = shift;
+ if ( $self->option('sync_bill_date',1) ) {
+ my $next_bill = $cust_pkg->cust_main->next_bill_date;
+ if ( defined($next_bill) ) {
+ return (localtime($next_bill))[3];
+ }
}
-
- sprintf('%.2f', $tot_discount);
+ return 0;
}
sub base_recur {
- my($self, $cust_pkg) = @_;
+ my($self, $cust_pkg, $sdate) = @_;
$self->option('recur_fee', 1) || 0;
}
my $next_bill = $cust_pkg->getfield('bill') || 0;
- #my $last_bill = $cust_pkg->last_bill || 0;
- my $last_bill = $cust_pkg->get('last_bill') || 0; #->last_bill falls back to setup
-
- return 0 if ! $self->base_recur($cust_pkg)
- || ! $self->option('unused_credit', 1)
- || ! $last_bill
+ return 0 if ! $self->base_recur($cust_pkg, \$time)
|| ! $next_bill
|| $next_bill < $time;
my $freq_sec = $1 * $sec{$2||'m'};
return 0 unless $freq_sec;
- sprintf("%.2f", $self->base_recur($cust_pkg) * ( $next_bill - $time ) / $freq_sec );
+ sprintf("%.2f", $self->base_recur($cust_pkg, \$time) * ( $next_bill - $time ) / $freq_sec );
}
sub is_prepaid { 0; } #no, we're postpaid
-#XXX discounts only on recurring fees for now (no setup/one-time or usage)
-sub can_discount {
+sub can_start_date { ! shift->option('start_1st', 1) }
+
+sub can_discount { 1; }
+
+sub recur_temporality {
my $self = shift;
- $self->freq =~ /^\d+$/ && $self->freq > 0;
+ $self->option('recur_temporality', 1);
}
sub usage_valuehash {
projects / freeside.git / blobdiff