kivitendo/SL/Controller/FinancialControllingReport.pm @ 15f58ff3
0c298dbf | Sven Schöling | package SL::Controller::FinancialControllingReport;
|
||
use strict;
|
||||
use parent qw(SL::Controller::Base);
|
||||
b2becee7 | Moritz Bunkus | use List::Util qw(max min sum);
|
||
0c298dbf | Sven Schöling | |||
use SL::DB::Order;
|
||||
9c7262bf | Sven Schöling | use SL::DB::ProjectType;
|
||
0c298dbf | Sven Schöling | use SL::Controller::Helper::GetModels;
|
||
use SL::Controller::Helper::ReportGenerator;
|
||||
use SL::Locale::String;
|
||||
use Rose::Object::MakeMethods::Generic (
|
||||
61d88e69 | Moritz Bunkus | scalar => [ qw(orders) ],
|
||
'scalar --get_set_init' => [ qw(project_types models) ],
|
||||
0c298dbf | Sven Schöling | );
|
||
__PACKAGE__->run_before(sub { $::auth->assert('sales_order_edit'); });
|
||||
5d195a27 | Sven Schöling | my %sort_columns = (
|
||
0c298dbf | Sven Schöling | ordnumber => t8('Order'),
|
||
customer => t8('Customer'),
|
||||
transaction_description => t8('Transaction description'),
|
||||
globalprojectnumber => t8('Project'),
|
||||
9c7262bf | Sven Schöling | globalproject_type => t8('Project Type'),
|
||
0c298dbf | Sven Schöling | );
|
||
sub action_list {
|
||||
my ($self) = @_;
|
||||
$self->make_filter_summary;
|
||||
$self->prepare_report;
|
||||
61d88e69 | Moritz Bunkus | $self->orders($self->models->get);
|
||
0c298dbf | Sven Schöling | |||
$self->calculate_data;
|
||||
$self->list_objects;
|
||||
}
|
||||
# private functions
|
||||
sub prepare_report {
|
||||
my ($self) = @_;
|
||||
my $report = SL::ReportGenerator->new(\%::myconfig, $::form);
|
||||
$self->{report} = $report;
|
||||
fee5532a | Moritz Bunkus | my @columns = qw(customer globalprojectnumber globalproject_type transaction_description ordnumber net_amount delivered_amount delivered_amount_p billed_amount billed_amount_p paid_amount paid_amount_p
|
||
6aeff060 | Sven Schöling | billable_amount billable_amount_p other_amount);
|
||
fee5532a | Moritz Bunkus | my @sortable = qw(ordnumber transdate customer globalprojectnumber globalproject_type transaction_description );
|
||
24597232 | Moritz Bunkus | $self->{number_columns} = [ qw(net_amount billed_amount billed_amount_p delivered_amount delivered_amount_p paid_amount paid_amount_p other_amount billable_amount billable_amount_p) ];
|
||
0c298dbf | Sven Schöling | |||
my %column_defs = (
|
||||
24597232 | Moritz Bunkus | net_amount => { text => $::locale->text('Order amount') },
|
||
0c298dbf | Sven Schöling | billed_amount => { text => $::locale->text('Billed amount') },
|
||
billed_amount_p => { text => $::locale->text('%') },
|
||||
delivered_amount => { text => $::locale->text('Delivered amount') },
|
||||
delivered_amount_p => { text => $::locale->text('%') },
|
||||
paid_amount => { text => $::locale->text('Paid amount') },
|
||||
paid_amount_p => { text => $::locale->text('%') },
|
||||
billable_amount => { text => $::locale->text('Billable amount') },
|
||||
billable_amount_p => { text => $::locale->text('%') },
|
||||
other_amount => { text => $::locale->text('Billed extra expenses') },
|
||||
fee5532a | Moritz Bunkus | transaction_description => { text => $::locale->text('Transaction description') },
|
||
0c298dbf | Sven Schöling | ordnumber => { obj_link => sub { $self->link_to($_[0]) } },
|
||
customer => { sub => sub { $_[0]->customer->name },
|
||||
obj_link => sub { $self->link_to($_[0]->customer) } },
|
||||
bfb68a07 | Moritz Bunkus | globalprojectnumber => { sub => sub { $_[0]->globalproject_id ? $_[0]->globalproject->projectnumber : '' },
|
||
obj_link => sub { $self->link_to($_[0]->globalproject) } },
|
||||
9c7262bf | Sven Schöling | globalproject_type => { text => $::locale->text('Project type'),
|
||
sub => sub { $_[0]->globalproject_id ? $_[0]->globalproject->project_type->description : '' } },
|
||||
0c298dbf | Sven Schöling | );
|
||
59b35cf6 | Moritz Bunkus | $column_defs{$_}->{text} ||= $::locale->text( $self->models->get_sort_spec->{$_}->{title} ) for keys %column_defs;
|
||
$column_defs{$_}->{align} = 'right' for @{ $self->{number_columns} };
|
||||
0c298dbf | Sven Schöling | |||
$report->set_options(
|
||||
std_column_visibility => 1,
|
||||
c9751ed4 | Moritz Bunkus | controller_class => 'FinancialControllingReport',
|
||
0c298dbf | Sven Schöling | output_format => 'HTML',
|
||
top_info_text => $::locale->text('Financial controlling report for open sales orders'),
|
||||
title => $::locale->text('Financial Controlling Report'),
|
||||
allow_pdf_export => 1,
|
||||
allow_csv_export => 1,
|
||||
);
|
||||
$report->set_columns(%column_defs);
|
||||
$report->set_column_order(@columns);
|
||||
$report->set_export_options(qw(list filter));
|
||||
$report->set_options_from_form;
|
||||
5d195a27 | Sven Schöling | $self->models->disable_plugin('paginated') if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
|
||
$self->models->finalize;
|
||||
$self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
|
||||
$report->set_options(
|
||||
raw_top_info_text => $self->render('financial_controlling_report/report_top', { output => 0 }),
|
||||
raw_bottom_info_text => $self->render('financial_controlling_report/report_bottom', { output => 0 }, models => $self->models),
|
||||
);
|
||||
0c298dbf | Sven Schöling | }
|
||
sub calculate_data {
|
||||
my ($self) = @_;
|
||||
61d88e69 | Moritz Bunkus | foreach my $order (@{ $self->orders }) {
|
||
7f82c68c | Moritz Bunkus | my @delivery_orders = @{ $order->linked_records(direction => 'to', to => 'DeliveryOrder', via => 'Order', query => [ '!customer_id' => undef ]) };
|
||
my @invoices = @{ $order->linked_records(direction => 'to', to => 'Invoice', via => [ 'Order', 'DeliveryOrder' ]) };
|
||||
@invoices = (
|
||||
grep({ !$_->storno_id } @invoices),
|
||||
map({ @{ $_->storno_invoices } } grep { $_->storno && !$_->storno_id } @invoices),
|
||||
);
|
||||
61d88e69 | Moritz Bunkus | $order->{delivered_amount} = sum(map { $self->sum_relevant_items(order => $order, other => $_, by_order => 1) } @delivery_orders) // 0;
|
||
$order->{billed_amount} = sum(map { $self->sum_relevant_items(order => $order, other => $_) } @invoices) // 0;
|
||||
$order->{paid_amount} = sum(map { $_->paid * $_->netamount / (($_->amount * 1) || ($_->netamount * 1) || 1) } @invoices) // 0;
|
||||
my $billed_amount = sum(map { $_->netamount } @invoices) // 0;
|
||||
0c298dbf | Sven Schöling | $order->{other_amount} = $billed_amount - $order->{billed_amount};
|
||
$order->{billable_amount} = $order->{delivered_amount} - $order->{billed_amount};
|
||||
24597232 | Moritz Bunkus | if ($order->periodic_invoices_config) {
|
||
bdb4582b | Moritz Bunkus | $order->{net_amount} = $self->calculate_periodic_invoices_order_netamount($order);
|
||
24597232 | Moritz Bunkus | |||
} else {
|
||||
$order->{net_amount} = $order->netamount;
|
||||
}
|
||||
0c298dbf | Sven Schöling | foreach (qw(delivered billed paid billable)) {
|
||
24597232 | Moritz Bunkus | $order->{"${_}_amount_p"} = $order->{net_amount} * 1 ? $order->{"${_}_amount"} * 100 / $order->{net_amount} : undef;
|
||
0c298dbf | Sven Schöling | }
|
||
}
|
||||
}
|
||||
bdb4582b | Moritz Bunkus | sub calculate_periodic_invoices_order_netamount {
|
||
my ($self, $order) = @_;
|
||||
b2becee7 | Moritz Bunkus | my $year = DateTime->today_local->year;
|
||
my $year_start = DateTime->new_local(day => 1, month => 1, year => $year);
|
||||
my $year_end = DateTime->new_local(day => 31, month => 12, year => $year);
|
||||
bdb4582b | Moritz Bunkus | my $cfg = $order->periodic_invoices_config;
|
||
b2becee7 | Moritz Bunkus | my $period_len = $cfg->get_billing_period_length;
|
||
my $num_months = 0;
|
||||
bdb4582b | Moritz Bunkus | my $cur_date = $cfg->start_date->clone;
|
||
b2becee7 | Moritz Bunkus | my $end_date = $cfg->terminated ? $cfg->end_date : undef;
|
||
$end_date //= $year_end;
|
||||
$end_date = min $end_date, $year_end;
|
||||
bdb4582b | Moritz Bunkus | |||
while ($cur_date <= $end_date) {
|
||||
b2becee7 | Moritz Bunkus | $num_months += $period_len if $cur_date >= $year_start;
|
||
$cur_date->add(months => $period_len);
|
||||
bdb4582b | Moritz Bunkus | }
|
||
b2becee7 | Moritz Bunkus | return $num_months * $order->netamount / $order->periodic_invoices_config->get_order_value_period_length;
|
||
bdb4582b | Moritz Bunkus | }
|
||
0c298dbf | Sven Schöling | sub sum_items {
|
||
my ($self, %params) = @_;
|
||||
my %vals;
|
||||
foreach my $item (@{ $params{obj}->items }) {
|
||||
a7e58f7e | Moritz Bunkus | my $key = $item->parts_id;
|
||
$key .= ':' . $item->serialnumber if $item->serialnumber;
|
||||
$vals{$key} ||= { parts_id => $item->parts_id, serialnumber => $item->serialnumber, amount => 0, base_qty => 0 };
|
||||
$vals{$key}->{amount} += $item->qty * $item->sellprice * (1 - $item->discount) / (($item->price_factor * 1) || 1);
|
||||
$vals{$key}->{base_qty} += $item->qty * $item->unit_obj->base_factor;
|
||||
0c298dbf | Sven Schöling | }
|
||
return \%vals;
|
||||
}
|
||||
sub sum_relevant_items {
|
||||
my ($self, %params) = @_;
|
||||
$params{order}->{amounts_by_parts_id} ||= $self->sum_items(obj => $params{order});
|
||||
my $sums = $self->sum_items(obj => $params{other});
|
||||
my $total = 0;
|
||||
foreach my $item (grep { $params{order}->{amounts_by_parts_id}->{ $_->{parts_id} } } values %{ $sums }) {
|
||||
a7e58f7e | Moritz Bunkus | my $key = $item->{parts_id};
|
||
if ($params{by_order}) {
|
||||
$key .= ':' . $item->{serialnumber};
|
||||
my $order_item = $params{order}->{amounts_by_parts_id}->{ $key } || $params{order}->{amounts_by_parts_id}->{ $item->{parts_id} };
|
||||
if ($order_item && $order_item->{base_qty}) {
|
||||
$total += $order_item->{amount} * $item->{base_qty} / $order_item->{base_qty};
|
||||
next;
|
||||
}
|
||||
0c298dbf | Sven Schöling | }
|
||
a7e58f7e | Moritz Bunkus | |||
$total += $item->{amount};
|
||||
0c298dbf | Sven Schöling | }
|
||
return $total;
|
||||
}
|
||||
sub list_objects {
|
||||
my ($self) = @_;
|
||||
d740b61d | Moritz Bunkus | my $modify_data = sub {
|
||
my ($data) = @_;
|
||||
59b35cf6 | Moritz Bunkus | $data->{$_}->{data} = defined $data->{$_}->{data} ? int($data->{$_}->{data}) : '' for grep { m/_p$/ } @{ $self->{number_columns} };
|
||
$data->{$_}->{data} = $::form->format_amount(\%::myconfig, $data->{$_}->{data}, 2) for grep { !m/_p$/ } @{ $self->{number_columns} };
|
||||
d740b61d | Moritz Bunkus | };
|
||
0c298dbf | Sven Schöling | |||
61d88e69 | Moritz Bunkus | return $self->report_generator_list_objects(report => $self->{report}, objects => $self->orders, data_callback => $modify_data);
|
||
0c298dbf | Sven Schöling | }
|
||
sub make_filter_summary {
|
||||
my ($self) = @_;
|
||||
my $filter = $::form->{filter} || {};
|
||||
my @filter_strings;
|
||||
my @filters = (
|
||||
[ $filter->{"ordnumber:substr::ilike"}, $::locale->text('Number') ],
|
||||
[ $filter->{"transdate:date::ge"}, $::locale->text('Order Date') . " " . $::locale->text('From Date') ],
|
||||
[ $filter->{"transdate:date::le"}, $::locale->text('Order Date') . " " . $::locale->text('To Date') ],
|
||||
[ $filter->{customer}{"name:substr::ilike"}, $::locale->text('Customer') ],
|
||||
[ $filter->{customer}{"customernumber:substr::ilike"}, $::locale->text('Customer Number') ],
|
||||
);
|
||||
$self->{filter_summary} = join ', ', @filter_strings;
|
||||
}
|
||||
61d88e69 | Moritz Bunkus | sub init_project_types { SL::DB::Manager::ProjectType->get_all_sorted }
|
||
5d195a27 | Sven Schöling | sub init_models {
|
||
my ($self) = @_;
|
||||
SL::Controller::Helper::GetModels->new(
|
||||
controller => $self,
|
||||
model => 'Order',
|
||||
sorted => {
|
||||
_default => {
|
||||
by => 'globalprojectnumber',
|
||||
dir => 1,
|
||||
},
|
||||
%sort_columns,
|
||||
},
|
||||
query => [
|
||||
SL::DB::Manager::Order->type_filter('sales_order'),
|
||||
'!closed' => 1,
|
||||
or => [
|
||||
globalproject_id => undef,
|
||||
and => [
|
||||
'globalproject.active' => 1,
|
||||
'globalproject.valid' => 1,
|
||||
]],
|
||||
24597232 | Moritz Bunkus | # keine WR
|
||
# oder aber (WR aktiv und (kein enddatum oder enddatum noch nicht überschritten))
|
||||
or => [
|
||||
'periodic_invoices_config.id' => undef,
|
||||
# and => [
|
||||
'periodic_invoices_config.active' => 1,
|
||||
# or => [
|
||||
# 'periodic_invoices_config.end_date' => undef,
|
||||
# 'periodic_invoices_config.end_date' => { le => DateTime->today_local },
|
||||
# ]
|
||||
# ]
|
||||
],
|
||||
5d195a27 | Sven Schöling | ],
|
||
cb725db7 | Moritz Bunkus | with_objects => [ 'customer', 'globalproject', 'globalproject.project_type', 'periodic_invoices_config' ],
|
||
5d195a27 | Sven Schöling | );
|
||
}
|
||||
0c298dbf | Sven Schöling | sub link_to {
|
||
my ($self, $object, %params) = @_;
|
||||
return unless $object;
|
||||
my $action = $params{action} || 'edit';
|
||||
if ($object->isa('SL::DB::Order')) {
|
||||
my $type = $object->type;
|
||||
my $id = $object->id;
|
||||
return "oe.pl?action=$action&type=$type&vc=customer&id=$id";
|
||||
}
|
||||
if ($object->isa('SL::DB::Customer')) {
|
||||
my $id = $object->id;
|
||||
48786831 | Moritz Bunkus | return "controller.pl?action=CustomerVendor/$action&id=$id";
|
||
0c298dbf | Sven Schöling | }
|
||
bfb68a07 | Moritz Bunkus | if ($object->isa('SL::DB::Project')) {
|
||
my $id = $object->id;
|
||||
return "controller.pl?action=Project/$action&id=$id";
|
||||
}
|
||||
0c298dbf | Sven Schöling | }
|
||
1;
|