SL/Controller/FinancialControllingReport.pm

   1 package SL::Controller::FinancialControllingReport;
   2
   3 use strict;
   4 use parent qw(SL::Controller::Base);
   5
   6 use List::Util qw(sum);
   7
   8 use SL::DB::Order;
   9 use SL::Controller::Helper::GetModels;
  10 use SL::Controller::Helper::Paginated;
  11 use SL::Controller::Helper::Sorted;
  12 use SL::Controller::Helper::ParseFilter;
  13 use SL::Controller::Helper::ReportGenerator;
  14 use SL::Locale::String;
  15
  16 use Rose::Object::MakeMethods::Generic (
  17   scalar => [ qw(db_args flat_filter) ],
  18 );
  19
  20 __PACKAGE__->run_before(sub { $::auth->assert('sales_order_edit'); });
  21
  22 __PACKAGE__->get_models_url_params('flat_filter');
  23 __PACKAGE__->make_paginated(
  24   MODEL         => 'Order',
  25   PAGINATE_ARGS => 'db_args',
  26   ONLY          => [ qw(list) ],
  27 );
  28
  29 __PACKAGE__->make_sorted(
  30   MODEL                   => 'Order',
  31   ONLY                    => [ qw(list) ],
  32
  33   DEFAULT_BY              => 'globalprojectnumber',
  34   DEFAULT_DIR             => 1,
  35
  36   ordnumber               => t8('Order'),
  37   customer                => t8('Customer'),
  38   transaction_description => t8('Transaction description'),
  39   globalprojectnumber     => t8('Project'),
  40   netamount               => t8('Order amount'),
  41 );
  42
  43 sub action_list {
  44   my ($self) = @_;
  45
  46   $self->db_args($self->setup_db_args_for_list(filter => $::form->{filter}));
  47   $self->flat_filter({ map { $_->{key} => $_->{value} } $::form->flatten_variables('filter') });
  48   $self->make_filter_summary;
  49
  50   $self->prepare_report;
  51
  52   $self->{orders} = $self->get_models(%{ $self->db_args });
  53
  54   $self->calculate_data;
  55
  56   $self->list_objects;
  57 }
  58
  59 # private functions
  60
  61 sub setup_db_args_for_list {
  62   my ($self) = @_;
  63
  64   $self->{filter} = {};
  65   my %args     = ( parse_filter($::form->{filter}, with_objects => [ 'customer', 'globalproject' ], launder_to => $self->{filter}));
  66   $args{query} = [
  67     @{ $args{query} || [] },
  68     SL::DB::Manager::Order->type_filter('sales_order'),
  69   ];
  70
  71   return \%args;
  72 }
  73
  74 sub prepare_report {
  75   my ($self)      = @_;
  76
  77   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
  78   $self->{report} = $report;
  79
  80   my @columns     = qw(customer globalprojectnumber project_type ordnumber netamount delivered_amount delivered_amount_p billed_amount billed_amount_p paid_amount paid_amount_p
  81                        billable_amount billable_amount_p other_amount);
  82   my @sortable    = qw(ordnumber transdate customer netamount globalprojectnumber);
  83   $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) ];
  84
  85   my %column_defs           = (
  86     netamount               => {                                                                                         },
  87     billed_amount           => { text     => $::locale->text('Billed amount')                                            },
  88     billed_amount_p         => { text     => $::locale->text('%')                                                        },
  89     delivered_amount        => { text     => $::locale->text('Delivered amount')                                         },
  90     delivered_amount_p      => { text     => $::locale->text('%')                                                        },
  91     paid_amount             => { text     => $::locale->text('Paid amount')                                              },
  92     paid_amount_p           => { text     => $::locale->text('%')                                                        },
  93     billable_amount         => { text     => $::locale->text('Billable amount')                                          },
  94     billable_amount_p       => { text     => $::locale->text('%')                                                        },
  95     other_amount            => { text     => $::locale->text('Billed extra expenses')                                    },
  96     ordnumber               => { obj_link => sub { $self->link_to($_[0])                                              }  },
  97     customer                => {      sub => sub { $_[0]->customer->name                                              },
  98                                  obj_link => sub { $self->link_to($_[0]->customer)                                    }  },
  99     globalprojectnumber     => {      sub => sub { $_[0]->globalproject_id ? $_[0]->globalproject->projectnumber : '' }  },
 100     project_type            => { text     => $::locale->text('Project type'),
 101                                  sub      => sub { $_[0]->globalproject_id ? $_[0]->globalproject->type          : '' }  },
 102   );
 103
 104   map { $column_defs{$_}->{text} ||= $::locale->text( $self->get_sort_spec->{$_}->{title} ) } keys %column_defs;
 105   map { $column_defs{$_}->{align} = 'right' } @{ $self->{number_columns} };
 106
 107   $report->set_options(
 108     std_column_visibility => 1,
 109     controller_class      => 'FinancialControllingReport',
 110     output_format         => 'HTML',
 111     top_info_text         => $::locale->text('Financial controlling report for open sales orders'),
 112     raw_top_info_text     => $self->render('financial_controlling_report/report_top',    { no_output => 1, partial => 1 }),
 113     raw_bottom_info_text  => $self->render('financial_controlling_report/report_bottom', { no_output => 1, partial => 1 }),
 114     title                 => $::locale->text('Financial Controlling Report'),
 115     allow_pdf_export      => 1,
 116     allow_csv_export      => 1,
 117   );
 118   $report->set_columns(%column_defs);
 119   $report->set_column_order(@columns);
 120   $report->set_export_options(qw(list filter));
 121   $report->set_options_from_form;
 122   $self->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
 123
 124   $self->disable_pagination if $report->{options}{output_format} =~ /^(pdf|csv)$/i;
 125
 126   $self->{report_data} = {
 127     column_defs        => \%column_defs,
 128     columns            => \@columns,
 129   };
 130 }
 131
 132 sub calculate_data {
 133   my ($self) = @_;
 134
 135   foreach my $order (@{ $self->{orders} }) {
 136     my $delivery_orders = $order->linked_records(direction => 'to', to => 'DeliveryOrder', via => 'Order', query => [ '!customer_id' => undef ]);
 137     my $invoices        = $order->linked_records(direction => 'to', to => 'Invoice',       via => [ 'Order', 'DeliveryOrder' ]);
 138
 139     $order->{delivered_amount}  = sum map { $self->sum_relevant_items(order => $order, other => $_, by_order => 1) } @{ $delivery_orders };
 140     $order->{billed_amount}     = sum map { $self->sum_relevant_items(order => $order, other => $_)                } @{ $invoices        };
 141     $order->{paid_amount}       = sum map { $_->paid                                                               } @{ $invoices        };
 142     my $billed_amount           = sum map { $_->netamount                                                          } @{ $invoices        };
 143     $order->{other_amount}      = $billed_amount             - $order->{billed_amount};
 144     $order->{billable_amount}   = $order->{delivered_amount} - $order->{billed_amount};
 145
 146     foreach (qw(delivered billed paid billable)) {
 147       $order->{"${_}_amount_p"} = $order->netamount * 1 ? $order->{"${_}_amount"} * 100 / $order->netamount : undef;
 148     }
 149   }
 150 }
 151
 152 sub sum_items {
 153   my ($self, %params) = @_;
 154
 155   my %vals;
 156
 157   foreach my $item (@{ $params{obj}->items }) {
 158     $vals{$item->parts_id}            ||= { parts_id => $item->parts_id, amount => 0, base_qty => 0 };
 159     $vals{$item->parts_id}->{amount}   += $item->qty * $item->sellprice * (1 - $item->discount) / (($item->price_factor * 1) || 1);
 160     $vals{$item->parts_id}->{base_qty} += $item->qty * $item->unit_obj->base_factor;
 161   }
 162
 163   return \%vals;
 164 }
 165
 166 sub sum_relevant_items {
 167   my ($self, %params) = @_;
 168
 169   $params{order}->{amounts_by_parts_id} ||= $self->sum_items(obj => $params{order});
 170   my $sums                                = $self->sum_items(obj => $params{other});
 171   my $total                               = 0;
 172
 173   foreach my $item (grep { $params{order}->{amounts_by_parts_id}->{ $_->{parts_id} } } values %{ $sums }) {
 174     my $order_item = $params{order}->{amounts_by_parts_id}->{ $item->{parts_id} };
 175     if ($params{by_order} && $order_item->{base_qty}) {
 176       $total += $order_item->{amount} * $item->{base_qty} / $order_item->{base_qty};
 177     } else {
 178       $total += $item->{amount};
 179     }
 180   }
 181
 182   return $total;
 183 }
 184
 185 sub list_objects {
 186   my ($self)      = @_;
 187   my $column_defs = $self->{report_data}->{column_defs};
 188
 189   for my $obj (@{ $self->{orders} || [] }) {
 190     my %data = map {
 191       $_ => {
 192         data => $column_defs->{$_}{sub} ? $column_defs->{$_}{sub}->($obj)
 193               : $obj->can($_)           ? $obj->$_
 194               :                           $obj->{$_},
 195         link => $column_defs->{$_}{obj_link} ? $column_defs->{$_}{obj_link}->($obj) : '',
 196       },
 197     } @{ $self->{report_data}{columns} || {} };
 198
 199     map { $data{$_}->{data} = defined $data{$_}->{data} ? int($data{$_}->{data}) : ''    } grep {  m/_p$/ } @{ $self->{number_columns} };
 200     map { $data{$_}->{data} = $::form->format_amount(\%::myconfig, $data{$_}->{data}, 2) } grep { !m/_p$/ } @{ $self->{number_columns} };
 201
 202     $self->{report}->add_data(\%data);
 203   }
 204
 205   return $self->{report}->generate_with_headers;
 206 }
 207
 208 sub make_filter_summary {
 209   my ($self) = @_;
 210
 211   my $filter = $::form->{filter} || {};
 212   my @filter_strings;
 213
 214   my @filters = (
 215     [ $filter->{"ordnumber:substr::ilike"},                $::locale->text('Number')                                          ],
 216     [ $filter->{"transdate:date::ge"},                     $::locale->text('Order Date') . " " . $::locale->text('From Date') ],
 217     [ $filter->{"transdate:date::le"},                     $::locale->text('Order Date') . " " . $::locale->text('To Date')   ],
 218     [ $filter->{customer}{"name:substr::ilike"},           $::locale->text('Customer')                                        ],
 219     [ $filter->{customer}{"customernumber:substr::ilike"}, $::locale->text('Customer Number')                                 ],
 220   );
 221
 222   $self->{filter_summary} = join ', ', @filter_strings;
 223 }
 224
 225 sub link_to {
 226   my ($self, $object, %params) = @_;
 227
 228   return unless $object;
 229   my $action = $params{action} || 'edit';
 230
 231   if ($object->isa('SL::DB::Order')) {
 232     my $type = $object->type;
 233     my $id   = $object->id;
 234
 235     return "oe.pl?action=$action&type=$type&vc=customer&id=$id";
 236   }
 237   if ($object->isa('SL::DB::Customer')) {
 238     my $id     = $object->id;
 239     return "ct.pl?action=$action&id=$id&db=customer";
 240   }
 241 }
 242
 243 1;