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