1 package SL::Controller::FinancialControllingReport;
4 use parent qw(SL::Controller::Base);
6 use List::Util qw(sum);
9 use SL::DB::ProjectType;
10 use SL::Controller::Helper::GetModels;
11 use SL::Controller::Helper::Paginated;
12 use SL::Controller::Helper::Sorted;
13 use SL::Controller::Helper::ParseFilter;
14 use SL::Controller::Helper::ReportGenerator;
15 use SL::Locale::String;
17 use Rose::Object::MakeMethods::Generic (
18 scalar => [ qw(db_args flat_filter project_types) ],
21 __PACKAGE__->run_before(sub { $::auth->assert('sales_order_edit'); });
23 __PACKAGE__->get_models_url_params('flat_filter');
24 __PACKAGE__->make_paginated(
26 PAGINATE_ARGS => 'db_args',
30 __PACKAGE__->make_sorted(
34 DEFAULT_BY => 'globalprojectnumber',
37 ordnumber => t8('Order'),
38 customer => t8('Customer'),
39 transaction_description => t8('Transaction description'),
40 globalprojectnumber => t8('Project'),
41 globalproject_type => t8('Project Type'),
42 netamount => t8('Order amount'),
48 $self->project_types(SL::DB::Manager::ProjectType->get_all_sorted);
50 $self->db_args($self->setup_db_args_for_list(filter => $::form->{filter}));
51 $self->flat_filter({ map { $_->{key} => $_->{value} } $::form->flatten_variables('filter') });
52 $self->make_filter_summary;
54 $self->prepare_report;
56 $self->{orders} = $self->get_models(%{ $self->db_args });
58 $self->calculate_data;
65 sub setup_db_args_for_list {
69 my %args = ( parse_filter($::form->{filter}, with_objects => [ 'customer', 'globalproject', 'globalproject.project_type' ], launder_to => $self->{filter}));
71 @{ $args{query} || [] },
72 SL::DB::Manager::Order->type_filter('sales_order'),
81 my $report = SL::ReportGenerator->new(\%::myconfig, $::form);
82 $self->{report} = $report;
84 my @columns = qw(customer globalprojectnumber globalproject_type ordnumber netamount delivered_amount delivered_amount_p billed_amount billed_amount_p paid_amount paid_amount_p
85 billable_amount billable_amount_p other_amount);
86 my @sortable = qw(ordnumber transdate customer netamount globalprojectnumber globalproject_type);
87 $self->{number_columns} = [ qw(netamount billed_amount billed_amount_p delivered_amount delivered_amount_p paid_amount paid_amount_p other_amount billable_amount billable_amount_p) ];
91 billed_amount => { text => $::locale->text('Billed amount') },
92 billed_amount_p => { text => $::locale->text('%') },
93 delivered_amount => { text => $::locale->text('Delivered amount') },
94 delivered_amount_p => { text => $::locale->text('%') },
95 paid_amount => { text => $::locale->text('Paid amount') },
96 paid_amount_p => { text => $::locale->text('%') },
97 billable_amount => { text => $::locale->text('Billable amount') },
98 billable_amount_p => { text => $::locale->text('%') },
99 other_amount => { text => $::locale->text('Billed extra expenses') },
100 ordnumber => { obj_link => sub { $self->link_to($_[0]) } },
101 customer => { sub => sub { $_[0]->customer->name },
102 obj_link => sub { $self->link_to($_[0]->customer) } },
103 globalprojectnumber => { sub => sub { $_[0]->globalproject_id ? $_[0]->globalproject->projectnumber : '' },
104 obj_link => sub { $self->link_to($_[0]->globalproject) } },
105 globalproject_type => { text => $::locale->text('Project type'),
106 sub => sub { $_[0]->globalproject_id ? $_[0]->globalproject->project_type->description : '' } },
109 map { $column_defs{$_}->{text} ||= $::locale->text( $self->get_sort_spec->{$_}->{title} ) } keys %column_defs;
110 map { $column_defs{$_}->{align} = 'right' } @{ $self->{number_columns} };
112 $report->set_options(
113 std_column_visibility => 1,
114 controller_class => 'FinancialControllingReport',
115 output_format => 'HTML',
116 top_info_text => $::locale->text('Financial controlling report for open sales orders'),
117 raw_top_info_text => $self->render('financial_controlling_report/report_top', { no_output => 1, partial => 1 }),
118 raw_bottom_info_text => $self->render('financial_controlling_report/report_bottom', { no_output => 1, partial => 1 }),
119 title => $::locale->text('Financial Controlling Report'),
120 allow_pdf_export => 1,
121 allow_csv_export => 1,
123 $report->set_columns(%column_defs);
124 $report->set_column_order(@columns);
125 $report->set_export_options(qw(list filter));
126 $report->set_options_from_form;
127 $self->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
129 $self->disable_pagination if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
131 $self->{report_data} = {
132 column_defs => \%column_defs,
133 columns => \@columns,
140 foreach my $order (@{ $self->{orders} }) {
141 my @delivery_orders = @{ $order->linked_records(direction => 'to', to => 'DeliveryOrder', via => 'Order', query => [ '!customer_id' => undef ]) };
142 my @invoices = @{ $order->linked_records(direction => 'to', to => 'Invoice', via => [ 'Order', 'DeliveryOrder' ]) };
145 grep({ !$_->storno_id } @invoices),
146 map({ @{ $_->storno_invoices } } grep { $_->storno && !$_->storno_id } @invoices),
149 $order->{delivered_amount} = sum map { $self->sum_relevant_items(order => $order, other => $_, by_order => 1) } @delivery_orders;
150 $order->{billed_amount} = sum map { $self->sum_relevant_items(order => $order, other => $_) } @invoices;
151 $order->{paid_amount} = sum map { $_->paid * $_->netamount / (($_->amount * 1) || ($_->netamount * 1) || 1) } @invoices;
152 my $billed_amount = sum map { $_->netamount } @invoices;
153 $order->{other_amount} = $billed_amount - $order->{billed_amount};
154 $order->{billable_amount} = $order->{delivered_amount} - $order->{billed_amount};
156 foreach (qw(delivered billed paid billable)) {
157 $order->{"${_}_amount_p"} = $order->netamount * 1 ? $order->{"${_}_amount"} * 100 / $order->netamount : undef;
163 my ($self, %params) = @_;
167 foreach my $item (@{ $params{obj}->items }) {
168 $vals{$item->parts_id} ||= { parts_id => $item->parts_id, amount => 0, base_qty => 0 };
169 $vals{$item->parts_id}->{amount} += $item->qty * $item->sellprice * (1 - $item->discount) / (($item->price_factor * 1) || 1);
170 $vals{$item->parts_id}->{base_qty} += $item->qty * $item->unit_obj->base_factor;
176 sub sum_relevant_items {
177 my ($self, %params) = @_;
179 $params{order}->{amounts_by_parts_id} ||= $self->sum_items(obj => $params{order});
180 my $sums = $self->sum_items(obj => $params{other});
183 foreach my $item (grep { $params{order}->{amounts_by_parts_id}->{ $_->{parts_id} } } values %{ $sums }) {
184 my $order_item = $params{order}->{amounts_by_parts_id}->{ $item->{parts_id} };
185 if ($params{by_order} && $order_item->{base_qty}) {
186 $total += $order_item->{amount} * $item->{base_qty} / $order_item->{base_qty};
188 $total += $item->{amount};
197 my $column_defs = $self->{report_data}->{column_defs};
199 for my $obj (@{ $self->{orders} || [] }) {
202 data => $column_defs->{$_}{sub} ? $column_defs->{$_}{sub}->($obj)
203 : $obj->can($_) ? $obj->$_
205 link => $column_defs->{$_}{obj_link} ? $column_defs->{$_}{obj_link}->($obj) : '',
207 } @{ $self->{report_data}{columns} || {} };
209 map { $data{$_}->{data} = defined $data{$_}->{data} ? int($data{$_}->{data}) : '' } grep { m/_p$/ } @{ $self->{number_columns} };
210 map { $data{$_}->{data} = $::form->format_amount(\%::myconfig, $data{$_}->{data}, 2) } grep { !m/_p$/ } @{ $self->{number_columns} };
212 $self->{report}->add_data(\%data);
215 return $self->{report}->generate_with_headers;
218 sub make_filter_summary {
221 my $filter = $::form->{filter} || {};
225 [ $filter->{"ordnumber:substr::ilike"}, $::locale->text('Number') ],
226 [ $filter->{"transdate:date::ge"}, $::locale->text('Order Date') . " " . $::locale->text('From Date') ],
227 [ $filter->{"transdate:date::le"}, $::locale->text('Order Date') . " " . $::locale->text('To Date') ],
228 [ $filter->{customer}{"name:substr::ilike"}, $::locale->text('Customer') ],
229 [ $filter->{customer}{"customernumber:substr::ilike"}, $::locale->text('Customer Number') ],
232 $self->{filter_summary} = join ', ', @filter_strings;
236 my ($self, $object, %params) = @_;
238 return unless $object;
239 my $action = $params{action} || 'edit';
241 if ($object->isa('SL::DB::Order')) {
242 my $type = $object->type;
243 my $id = $object->id;
245 return "oe.pl?action=$action&type=$type&vc=customer&id=$id";
247 if ($object->isa('SL::DB::Customer')) {
248 my $id = $object->id;
249 return "ct.pl?action=$action&id=$id&db=customer";
251 if ($object->isa('SL::DB::Project')) {
252 my $id = $object->id;
253 return "controller.pl?action=Project/$action&id=$id";