1 #=====================================================================
4 # Based on SQL-Ledger Version 2.1.9
5 # Web http://www.lx-office.org
7 #=====================================================================
8 # SQL-Ledger Accounting
11 # Author: Dieter Simader
12 # Email: dsimader@sql-ledger.org
13 # Web: http://www.sql-ledger.org
16 # This program is free software; you can redistribute it and/or modify
17 # it under the terms of the GNU General Public License as published by
18 # the Free Software Foundation; either version 2 of the License, or
19 # (at your option) any later version.
21 # This program is distributed in the hope that it will be useful,
22 # but WITHOUT ANY WARRANTY; without even the implied warranty of
23 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 # GNU General Public License for more details.
25 # You should have received a copy of the GNU General Public License
26 # along with this program; if not, write to the Free Software
27 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #======================================================================
32 #======================================================================
34 use POSIX qw(strftime);
35 use List::Util qw(sum first);
40 use SL::ReportGenerator;
43 require "bin/mozilla/arap.pl";
44 require "bin/mozilla/common.pl";
45 require "bin/mozilla/drafts.pl";
46 require "bin/mozilla/reportgenerator.pl";
51 $main::lxdebug->enter_sub();
52 $main::auth->assert('general_ledger | invoice_edit');
54 my $form = $main::form;
55 my %myconfig = %main::myconfig;
56 my $locale = $main::locale;
58 my ($customer, $department);
60 # setup customer selection
61 $form->all_vc(\%myconfig, "customer", "AR");
63 $form->{title} = $locale->text('Sales Report');
64 $form->{jsscript} = 1;
66 $form->get_lists("projects" => { "key" => "ALL_PROJECTS", "all" => 1 },
67 "departments" => "ALL_DEPARTMENTS",
68 "business_types" => "ALL_BUSINESS_TYPES",
69 "salesmen" => "ALL_SALESMEN",
70 'employees' => 'ALL_EMPLOYEES',
71 'partsgroup' => 'ALL_PARTSGROUPS',
72 "customers" => "ALL_VC");
73 $form->{CUSTOM_VARIABLES_IC} = CVar->get_configs('module' => 'IC');
74 ($form->{CUSTOM_VARIABLES_FILTER_CODE_IC},
75 $form->{CUSTOM_VARIABLES_INCLUSION_CODE_IC}) = CVar->render_search_options('variables' => $form->{CUSTOM_VARIABLES_IC},
76 'include_prefix' => 'l_',
77 'include_value' => 'Y');
79 $form->{CUSTOM_VARIABLES_CT} = CVar->get_configs('module' => 'CT');
80 ($form->{CUSTOM_VARIABLES_FILTER_CODE_CT},
81 $form->{CUSTOM_VARIABLES_INCLUSION_CODE_CT}) = CVar->render_search_options('variables' => $form->{CUSTOM_VARIABLES_CT},
82 'include_prefix' => 'l_',
83 'include_value' => 'Y');
84 $form->{vc_keys} = sub { "$_[0]->{name}--$_[0]->{id}" };
85 $form->{employee_labels} = sub { $_[0]->{"name"} || $_[0]->{"login"} };
86 $form->{salesman_labels} = $form->{employee_labels};
89 print $form->parse_html_template('vk/search_invoice', { %myconfig });
91 $main::lxdebug->leave_sub();
94 sub invoice_transactions {
95 $main::lxdebug->enter_sub();
97 $main::auth->assert('general_ledger | invoice_edit');
99 my $form = $main::form;
100 my %myconfig = %main::myconfig;
101 my $locale = $main::locale;
103 my ($callback, $href, @columns);
105 # can't currently be configured from report, empty line between main sortings
106 my $addemptylines = 1;
108 # don't add empty lines between mainsort subtotals when only subtotal_mainsort is selected
109 if ($form->{l_subtotal_mainsort} eq "Y" and not defined $form->{l_headers_mainsort} and not defined $form->{l_headers_subsort} and not defined $form->{l_subtotal_subsort} ) {
113 if ( $form->{customer} =~ /--/ ) {
114 # Felddaten kommen aus Dropdownbox
115 ($form->{customername}, $form->{customer_id}) = split(/--/, $form->{customer});
116 } elsif ($form->{customer}) {
117 # es wurde ein Wert im Freitextfeld übergeben, auf Eindeutigkeit überprüfen
119 # check_name wird mit no_select => 1 ausgeführt, ist die Abfrage nicht eindeutig kommt ein Fehler
120 # und die Abfrage muß erneut ausgeführt werden
122 # Ohne no_select kommt bei Auswahl des Kunden ein Aufruf von update der ins
123 # Nichts führt, daher diese Zwischenlösung
125 &check_name('customer', no_select => 1);
127 # $form->{customer_id} was already set by check_name
128 $form->{customername} = $form->{customer};
130 # if $form->{customer} is empty nothing further happens here
132 # test for decimalplaces or set to default of 2
133 $form->{decimalplaces} = 2 unless $form->{decimalplaces} > 0 && $form->{decimalplaces} < 6;
135 my $cvar_configs_ct = CVar->get_configs('module' => 'CT');
136 my $cvar_configs_ic = CVar->get_configs('module' => 'IC');
138 # report_generator_set_default_sort('transdate', 1);
140 VK->invoice_transactions(\%myconfig, \%$form);
143 if ( $form->{mainsort} eq 'month' or $form->{subsort} eq 'month' ) {
145 # Data already comes out of SELECT statement in correct month order, but
146 # remove whitespaces (month names are padded) and translate them as early
149 foreach (@{ $form->{AR} }) {
150 $_->{month} =~ s/\s//g;
151 $_->{month} = $locale->text($_->{month});
155 $form->{title} = $locale->text('Sales Report');
158 qw(description invnumber transdate customernumber customername partnumber partsgroup country business transdate qty parts_unit weight sellprice sellprice_total discount lastcost lastcost_total marge_total marge_percent employee salesman);
160 my @includeable_custom_variables = grep { $_->{includeable} } @{ $cvar_configs_ic }, @{ $cvar_configs_ct };
161 my @searchable_custom_variables = grep { $_->{searchable} } @{ $cvar_configs_ic }, @{ $cvar_configs_ct };
162 my %column_defs_cvars = map { +"cvar_$_->{name}" => { 'text' => $_->{description} } } @includeable_custom_variables;
164 push @columns, map { "cvar_$_->{name}" } @includeable_custom_variables;
167 # hidden variables für pdf/csv export übergeben
168 # einmal mit l_ um zu bestimmen welche Spalten ausgegeben werden sollen
169 # einmal optionen für die Überschrift (z.B. transdatefrom, partnumber, ...)
170 my @hidden_variables = (qw(l_headers_mainsort l_headers_subsort l_subtotal_mainsort l_subtotal_subsort l_total l_parts l_customername l_customernumber transdatefrom transdateto decimalplaces customer customername customer_id department partnumber partsgroup country business description project_id customernumber salesman employee salesman_id employee_id business_id partsgroup_id mainsort subsort),
172 map({ "cvar_$_->{name}" } @searchable_custom_variables),
173 map { "l_$_" } @columns
175 my @hidden_nondefault = grep({ $form->{$_} } @hidden_variables);
176 # Variablen werden dann als Hidden Variable mitgegeben, z.B.
177 # <input type="hidden" name="report_generator_hidden_transdateto" value="21.05.2010">
179 $href = build_std_url('action=invoice_transactions', grep { $form->{$_} } @hidden_variables);
180 # href = vk.pl?action=invoice_transactions&l_headers=Y&l_subtotal=Y&l_total=Y&transdatefrom=04.03.2010 ...
183 'description' => { 'text' => $locale->text('Description'), },
184 'partnumber' => { 'text' => $locale->text('Part Number'), },
185 'partsgroup' => { 'text' => $locale->text('Group'), },
186 'country' => { 'text' => $locale->text('Country'), },
187 'business' => { 'text' => $locale->text('Customer type'), },
188 'employee' => { 'text' => $locale->text('Employee'), },
189 'salesman' => { 'text' => $locale->text('Salesperson'), },
190 'invnumber' => { 'text' => $locale->text('Invoice Number'), },
191 'transdate' => { 'text' => $locale->text('Invoice Date'), },
192 'qty' => { 'text' => $locale->text('Quantity'), },
193 'parts_unit' => { 'text' => $locale->text('Base unit'), },
194 'weight' => { 'text' => $locale->text('Weight'), },
195 'sellprice' => { 'text' => $locale->text('Sales price'), },
196 'sellprice_total' => { 'text' => $locale->text('Sales net amount'), },
197 'lastcost_total' => { 'text' => $locale->text('Purchase net amount'), },
198 'discount' => { 'text' => $locale->text('Discount'), },
199 'lastcost' => { 'text' => $locale->text('Purchase price'), },
200 'marge_total' => { 'text' => $locale->text('Sales margin'), },
201 'marge_percent' => { 'text' => $locale->text('Sales margin %'), },
202 'customernumber' => { 'text' => $locale->text('Customer Number'), },
203 'customername' => { 'text' => $locale->text('Customer Name'), },
204 # add 3 more column_defs so we have a translation for top_info_text
205 'customer' => { 'text' => $locale->text('Customer'), },
206 'part' => { 'text' => $locale->text('Part'), },
207 'month' => { 'text' => $locale->text('Month'), },
211 map { $column_defs{$_}->{visible} = $form->{"l_$_"} eq 'Y' } @columns;
213 my %column_alignment = map { $_ => 'right' } qw(lastcost sellprice sellprice_total lastcost_total parts_unit discount marge_total marge_percent qty weight);
216 # so now the check-box "Description" is only used as switch for part description in invoice-mode
217 # always fill the column "Description" if we are in Zwischensummenmode
218 $form->{"l_description"} = "Y" if not defined $form->{"l_parts"};;
219 map { $column_defs{$_}->{visible} = $form->{"l_${_}"} ? 1 : 0 } @columns;
223 push @options, $locale->text('Description') . " : $form->{description}" if $form->{description};
224 push @options, $locale->text('Customer') . " : $form->{customername}" if $form->{customer};
225 push @options, $locale->text('Customer Number') . " : $form->{customernumber}" if $form->{customernumber};
226 # TODO: es wird nur id übergeben
227 push @options, $locale->text('Department') . " : " . (split /--/, $form->{department})[0] if $form->{department};
228 push @options, $locale->text('Invoice Number') . " : $form->{invnumber}" if $form->{invnumber};
229 push @options, $locale->text('Invoice Date') . " : $form->{invdate}" if $form->{invdate};
230 push @options, $locale->text('Part Number') . " : $form->{partnumber}" if $form->{partnumber};
231 push @options, $locale->text('Group') . " : " . SL::DB::PartsGroup->new(id => $form->{partsgroup_id})->load->partsgroup if $form->{partsgroup_id};
232 push @options, $locale->text('Country') . " : $form->{country}" if $form->{country};
233 push @options, $locale->text('Employee') . ' : ' . SL::DB::Employee->new(id => $form->{employee_id})->load->name if $form->{employee_id};
234 push @options, $locale->text('Salesman') . ' : ' . SL::DB::Employee->new(id => $form->{salesman_id})->load->name if $form->{salesman_id};
235 push @options, $locale->text('Customer type') . ' : ' . SL::DB::Business->new(id => $form->{business_id})->load->description if $form->{business_id};
236 push @options, $locale->text('Order Number') . " : $form->{ordnumber}" if $form->{ordnumber};
237 push @options, $locale->text('Notes') . " : $form->{notes}" if $form->{notes};
238 push @options, $locale->text('Transaction description') . " : $form->{transaction_description}" if $form->{transaction_description};
239 push @options, $locale->text('From') . " " . $locale->date(\%myconfig, $form->{transdatefrom}, 1) if $form->{transdatefrom};
240 push @options, $locale->text('Bis') . " " . $locale->date(\%myconfig, $form->{transdateto}, 1) if $form->{transdateto};
242 my $report = SL::ReportGenerator->new(\%myconfig, $form);
244 $report->set_options('top_info_text' => join("\n", $locale->text('Main sorting') . ' : ' . $column_defs{$form->{mainsort}}->{text} , $locale->text('Secondary sorting') . ' : ' . $column_defs{$form->{'subsort'}}->{text}, @options),
245 'output_format' => 'HTML',
246 'title' => $form->{title},
247 'attachment_basename' => $locale->text('Sales Report') . strftime('_%Y%m%d', localtime time),
249 $report->set_options_from_form();
250 $locale->set_numberformat_wo_thousands_separator(\%myconfig) if lc($report->{options}->{output_format}) eq 'csv';
252 $report->set_columns(%column_defs);
253 $report->set_column_order(@columns);
255 $report->set_export_options('invoice_transactions', @hidden_variables, qw(mainsort sortdir));
257 $report->set_sort_indicator($form->{mainsort}, $form->{sortdir});
259 CVar->add_custom_variables_to_report('module' => 'CT',
260 'trans_id_field' => 'customerid',
261 'configs' => $cvar_configs_ct,
262 'column_defs' => \%column_defs,
263 'data' => $form->{AR}
266 CVar->add_custom_variables_to_report('module' => 'IC',
267 'trans_id_field' => 'parts_id',
268 'configs' => $cvar_configs_ic,
269 'column_defs' => \%column_defs,
270 'data' => $form->{AR}
273 my $num_visible_columns = scalar $report->get_visible_columns;
277 class => 'listrowempty',
278 colspan => $num_visible_columns,
282 # add sort and escape callback, this one we use for the add sub
283 $form->{callback} = $href .= "&sort=$form->{mainsort}";
285 # escape callback for href
286 $callback = $form->escape($href);
288 my @subtotal_columns = qw(qty weight sellprice sellprice_total lastcost lastcost_total marge_total marge_percent discount);
290 # sum of sellprice_total, lastcost_total and marge_total
291 # average of marge_percent
292 my @total_columns = qw(sellprice_total lastcost_total marge_total marge_percent );
294 my %totals = map { $_ => 0 } @total_columns;
295 my %subtotals1 = map { $_ => 0 } @subtotal_columns;
296 my %subtotals2 = map { $_ => 0 } @subtotal_columns;
301 my $all_units = AM->retrieve_all_units();
303 foreach my $ar (@{ $form->{AR} }) {
304 $basefactor = $all_units->{$ar->{unit}}->{factor} / $all_units->{$ar->{parts_unit}}->{factor};
305 $basefactor = 1 unless $basefactor;
307 $ar->{price_factor} = 1 unless $ar->{price_factor};
308 # calculate individual sellprice
309 # discount was already accounted for in db sellprice
310 $ar->{sellprice} = $ar->{sellprice} / $ar->{price_factor} / $basefactor;
311 $ar->{lastcost} = $ar->{lastcost} / $ar->{price_factor} / $basefactor;
312 $ar->{sellprice_total} = $form->round_amount( $ar->{qty} * ( $ar->{fxsellprice} * ( 1 - $ar->{discount} ) ) / $ar->{price_factor}, $form->{"decimalplaces"});
313 $ar->{lastcost_total} = $form->round_amount( $ar->{qty} * $ar->{lastcost} * $basefactor, $form->{"decimalplaces"});
314 # marge_percent wird neu berechnet, da Wert in invoice leer ist (Bug)
315 $ar->{marge_percent} = $ar->{sellprice_total} ? (($ar->{sellprice_total}-$ar->{lastcost_total}) / $ar->{sellprice_total} * 100) : 0;
316 # marge_total neu berechnen
317 $ar->{marge_total} = $ar->{sellprice_total} ? $ar->{sellprice_total}-$ar->{lastcost_total} : 0;
318 $ar->{discount} *= 100; # für Ausgabe formatieren, 10% stored as 0.1 in db
320 #adapt qty to the chosen unit
321 $ar->{qty} *= $basefactor;
323 #weight is the still the weight per part, but here we want the total weight
324 $ar->{weight} *= $ar->{qty};
326 # Anfangshauptüberschrift
327 if ( $form->{l_headers_mainsort} eq "Y" && ( $idx == 0 or $ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx - 1]->{ $form->{'mainsort'} } )) {
329 # use $emptyname for mainsort header if mainsort is empty
330 data => $ar->{$form->{'mainsort'}} || $locale->text('empty'),
331 class => "listmainsortheader",
332 colspan => $num_visible_columns,
334 $report->add_data([ { description => $headerrow } ]);
336 # add empty row after main header
337 # my $emptyheaderrow->{description}->{data} = "";
338 # $emptyheaderrow->{description}->{class} = "listmainsortheader";
339 # my $emptyheaderrow_set = [ $emptyheaderrow ];
340 # $report->add_data($emptyheaderrow_set) if $form->{l_headers} eq "Y";
343 # subsort überschriften
344 # special case: subsort headers only makes (aesthetical) sense if we show individual parts
346 or $ar->{ $form->{'subsort'} } ne $form->{AR}->[$idx - 1]->{ $form->{'subsort'} }
347 or $ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx - 1]->{ $form->{'mainsort'} })
348 && ($form->{l_headers_subsort} eq "Y")
352 # if subsort name is defined, use that name in header, otherwise use $emptyname
353 data => $ar->{$form->{'subsort'}} || $locale->text('empty'),
354 class => "listsubsortheader",
355 colspan => $num_visible_columns,
357 $report->add_data([ { description => $headerrow } ]);
360 map { $subtotals1{$_} += $ar->{$_};
361 $subtotals2{$_} += $ar->{$_};
364 map { $totals{$_} += $ar->{$_} } @total_columns;
366 if ( $subtotals1{qty} != 0 ) {
367 # calculate averages for subtotals1 and subtotals2
368 # credited positions reduce both total and qty and thus don't influence average prices
369 $subtotals1{sellprice} = $subtotals1{sellprice_total} / $subtotals1{qty};
370 $subtotals1{lastcost} = $subtotals1{lastcost_total} / $subtotals1{qty};
372 # qty is zero, so we have a special case where each position in subtotal
373 # group has a corresponding credit note so that the total qty is zero in
374 # this case we also want the total amounts to be zero, so overwrite them,
375 # rather than leaving the last value in sellprice/lastcost
377 $subtotals1{sellprice} = 0;
378 $subtotals1{lastcost} = 0;
381 if ( $subtotals2{qty} != 0 ) {
382 $subtotals2{sellprice} = $subtotals2{sellprice_total} / $subtotals2{qty};
383 $subtotals2{lastcost} = $subtotals2{lastcost_total} / $subtotals2{qty};
385 $subtotals2{sellprice} = 0;
386 $subtotals2{lastcost} = 0;
389 # Ertrag prozentual in den Summen: (summe VK - summe Ertrag) / summe VK
390 $subtotals1{marge_percent} = $subtotals1{sellprice_total} ? (($subtotals1{sellprice_total} - $subtotals1{lastcost_total}) / $subtotals1{sellprice_total}) * 100 : 0;
391 $subtotals2{marge_percent} = $subtotals2{sellprice_total} ? (($subtotals2{sellprice_total} - $subtotals2{lastcost_total}) / $subtotals2{sellprice_total}) *100 : 0;
393 # Ertrag prozentual: (Summe VK betrag - Summe EK betrag) / Summe VK betrag
394 # wird laufend bei jeder Position neu berechnet
395 $totals{marge_percent} = $totals{sellprice_total} ? ( ($totals{sellprice_total} - $totals{lastcost_total}) / $totals{sellprice_total} ) * 100 : 0;
397 map { $ar->{$_} = $form->format_amount(\%myconfig, $ar->{$_}, 2) } qw(marge_percent qty);
398 map { $ar->{$_} = $form->format_amount(\%myconfig, $ar->{$_}, 3) } qw(weight);
399 map { $ar->{$_} = $form->format_amount(\%myconfig, $ar->{$_}, $form->{"decimalplaces"} )} qw(lastcost sellprice sellprice_total lastcost_total marge_total);
401 # Einzelzeilen nur zeigen wenn l_parts gesetzt ist, nützlich, wenn man nur
402 # Subtotals und Totals sehen möchte
403 if ($form->{l_parts}) {
405 map { ($_ => { data => $ar->{$_}, align => $column_alignment{$_} }) } @columns
408 $row{invnumber}->{link} = build_std_url("script=is.pl", 'action=edit') . "&id=" . E($ar->{id}) . "&callback=${callback}";
410 # use partdescription according to invoice in article mode
411 $row{description}->{data} = $ar->{invoice_description};
413 $report->add_data(\%row);
416 # hier wird bei l_subtotal nicht differenziert zwischen mainsort und subsort
417 # macht man l_subtotal_mainsort aus wird l_subtotal_subsort auch nicht ausgeführt
418 if ( ($form->{l_subtotal_mainsort} eq 'Y')
419 && ($form->{l_subtotal_subsort} eq 'Y')
420 && (($idx == (scalar @{ $form->{AR} } - 1)) # last element always has a subtotal
421 || ($ar->{ $form->{'subsort'} } ne $form->{AR}->[$idx + 1]->{ $form->{'subsort'} })
422 || ($ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx + 1]->{ $form->{'mainsort'} })
423 )) { # if value that is sorted by changes, print subtotal
425 $report->add_data(create_subtotal_row_invoice(\%subtotals2, \@columns, \%column_alignment, \@subtotal_columns, $form->{l_parts} ? 'listsubtotal' : undef, $ar->{ $form->{'subsort'} }));
426 $report->add_data({ %empty_row }) if $form->{l_parts} and $addemptylines;
429 # if last mainsort is reached or mainsort has changed, add mainsort subtotal and empty row
430 if ( ($form->{l_subtotal_mainsort} eq 'Y')
431 && ($form->{l_subtotal_mainsort} eq 'Y')
432 && ($form->{mainsort} ne $form->{subsort})
433 && (($idx == (scalar @{ $form->{AR} } - 1)) # last element always has a subtotal
434 || ($ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx + 1]->{ $form->{'mainsort'} })
435 )) { # if value that is sorted by changes, print subtotal
436 # subtotal is overriden if mainsort and subsort are equal, don't print
437 # subtotal line even if it is selected
438 $report->add_data(create_subtotal_row_invoice(\%subtotals1, \@columns, \%column_alignment, \@subtotal_columns, 'listsubtotal', $ar->{$form->{mainsort}}));
439 $report->add_data({ %empty_row }) if $addemptylines; # insert empty row after mainsort
444 if ( $form->{l_total} eq "Y" ) {
445 $report->add_separator();
446 $report->add_data(create_subtotal_row_invoice(\%totals, \@columns, \%column_alignment, \@total_columns, 'listtotal', 'l_total'))
449 $report->generate_with_headers();
450 $main::lxdebug->leave_sub();
453 sub create_subtotal_row_invoice {
454 $main::lxdebug->enter_sub();
456 my ($totals, $columns, $column_alignment, $subtotal_columns, $class, $name) = @_;
458 my $form = $main::form;
459 my %myconfig = %main::myconfig;
460 my $locale = $main::locale;
462 my $row = { map { $_ => { data => '', class => $class, align => $column_alignment->{$_}, } } @{ $columns } };
464 # set name as "empty" if no value is given, except if we are dealing with the
465 # absolute total, then just write "Total sum"
466 # here we assume that no name will be called 'l_total'
467 $name = $locale->text('empty') unless $name;
468 if ( $name eq 'l_total' ) {
469 $row->{description}->{data} = $locale->text('Total sum');
471 $row->{description}->{data} = $locale->text('Total') . ' ' . $name;
474 map { $row->{$_}->{data} = $form->format_amount(\%myconfig, $totals->{$_}, 2) } qw(marge_total marge_percent qty);
475 map { $row->{$_}->{data} = $form->format_amount(\%myconfig, $totals->{$_}, 3) } qw(weight);
476 map { $row->{$_}->{data} = $form->format_amount(\%myconfig, $totals->{$_}, $form->{decimalplaces}) } qw(lastcost sellprice sellprice_total lastcost_total);
479 map { $totals->{$_} = 0 } @{ $subtotal_columns };
481 $main::lxdebug->leave_sub();