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 if ( $form->{customer} =~ /--/ ) {
109 # Felddaten kommen aus Dropdownbox
110 ($form->{customername}, $form->{customer_id}) = split(/--/, $form->{customer});
111 } elsif ($form->{customer}) {
112 # es wurde ein Wert im Freitextfeld übergeben, auf Eindeutigkeit überprüfen
114 # check_name wird mit no_select => 1 ausgeführt, ist die Abfrage nicht eindeutig kommt ein Fehler
115 # und die Abfrage muß erneut ausgeführt werden
117 # Ohne no_select kommt bei Auswahl des Kunden ein Aufruf von update der ins
118 # Nichts führt, daher diese Zwischenlösung
120 &check_name('customer', no_select => 1);
122 # $form->{customer_id} wurde schon von check_name gesetzt
123 $form->{customername} = $form->{customer};
125 # ist $form->{customer} leer passiert hier nichts weiter
127 # decimalplaces überprüfen oder auf Default 2 setzen
128 $form->{decimalplaces} = 2 unless $form->{decimalplaces} > 0 && $form->{decimalplaces} < 6;
130 my $cvar_configs_ct = CVar->get_configs('module' => 'CT');
131 my $cvar_configs_ic = CVar->get_configs('module' => 'IC');
133 # report_generator_set_default_sort('transdate', 1);
135 VK->invoice_transactions(\%myconfig, \%$form);
138 if ( $form->{mainsort} eq 'month' or $form->{subsort} eq 'month' ) {
140 # Data already comes out of SELECT statement in correct month order, but
141 # remove whitespaces (month names are padded) and translate them as early
144 foreach (@{ $form->{AR} }) {
145 $_->{month} =~ s/\s//g;
146 $_->{month} = $locale->text($_->{month});
150 $form->{title} = $locale->text('Sales Report');
153 qw(description invnumber transdate customernumber customername partnumber partsgroup country business transdate qty parts_unit sellprice sellprice_total discount lastcost lastcost_total marge_total marge_percent employee salesman);
155 my @includeable_custom_variables = grep { $_->{includeable} } @{ $cvar_configs_ic }, @{ $cvar_configs_ct };
156 my @searchable_custom_variables = grep { $_->{searchable} } @{ $cvar_configs_ic }, @{ $cvar_configs_ct };
157 my %column_defs_cvars = map { +"cvar_$_->{name}" => { 'text' => $_->{description} } } @includeable_custom_variables;
159 push @columns, map { "cvar_$_->{name}" } @includeable_custom_variables;
162 # hidden variables für pdf/csv export übergeben
163 # einmal mit l_ um zu bestimmen welche Spalten ausgegeben werden sollen
164 # einmal optionen für die Überschrift (z.B. transdatefrom, partnumber, ...)
165 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),
167 map({ "cvar_$_->{name}" } @searchable_custom_variables),
168 map { "l_$_" } @columns
170 my @hidden_nondefault = grep({ $form->{$_} } @hidden_variables);
171 # Variablen werden dann als Hidden Variable mitgegeben, z.B.
172 # <input type="hidden" name="report_generator_hidden_transdateto" value="21.05.2010">
174 $href = build_std_url('action=invoice_transactions', grep { $form->{$_} } @hidden_variables);
175 # href = vk.pl?action=invoice_transactions&l_headers=Y&l_subtotal=Y&l_total=Y&transdatefrom=04.03.2010 ...
178 'description' => { 'text' => $locale->text('Description'), },
179 'partnumber' => { 'text' => $locale->text('Part Number'), },
180 'partsgroup' => { 'text' => $locale->text('Group'), },
181 'country' => { 'text' => $locale->text('Country'), },
182 'business' => { 'text' => $locale->text('Customer type'), },
183 'employee' => { 'text' => $locale->text('Employee'), },
184 'salesman' => { 'text' => $locale->text('Salesperson'), },
185 'invnumber' => { 'text' => $locale->text('Invoice Number'), },
186 'transdate' => { 'text' => $locale->text('Invoice Date'), },
187 'qty' => { 'text' => $locale->text('Quantity'), },
188 'parts_unit' => { 'text' => $locale->text('Base unit'), },
189 'sellprice' => { 'text' => $locale->text('Sales price'), },
190 'sellprice_total' => { 'text' => $locale->text('Sales net amount'), },
191 'lastcost_total' => { 'text' => $locale->text('Purchase net amount'), },
192 'discount' => { 'text' => $locale->text('Discount'), },
193 'lastcost' => { 'text' => $locale->text('Purchase price'), },
194 'marge_total' => { 'text' => $locale->text('Sales margin'), },
195 'marge_percent' => { 'text' => $locale->text('Sales margin %'), },
196 'customernumber' => { 'text' => $locale->text('Customer Number'), },
197 'customername' => { 'text' => $locale->text('Customer Name'), },
198 # add 3 more column_defs so we have a translation for top_info_text
199 'customer' => { 'text' => $locale->text('Customer'), },
200 'part' => { 'text' => $locale->text('Part'), },
201 'month' => { 'text' => $locale->text('Month'), },
205 map { $column_defs{$_}->{visible} = $form->{"l_$_"} eq 'Y' } @columns;
207 my %column_alignment = map { $_ => 'right' } qw(lastcost sellprice sellprice_total lastcost_total parts_unit discount marge_total marge_percent qty);
210 # so now the check-box "Description" is only used as switch for part description in invoice-mode
211 # always fill the column "Description" if we are in Zwischensummenmode
212 if (not defined $form->{"l_parts"}) {
213 $form->{"l_description"} = "Y";
215 map { $column_defs{$_}->{visible} = $form->{"l_${_}"} ? 1 : 0 } @columns;
219 if ($form->{description}) {
220 push @options, $locale->text('Description') . " : $form->{description}";
222 if ($form->{customer}) {
223 push @options, $locale->text('Customer') . " : $form->{customername}";
225 if ($form->{customernumber}) {
226 push @options, $locale->text('Customer Number') . " : $form->{customernumber}";
228 # TODO: es wird nur id übergeben
229 if ($form->{department}) {
230 my ($department) = split /--/, $form->{department};
231 push @options, $locale->text('Department') . " : $department";
233 if ($form->{invnumber}) {
234 push @options, $locale->text('Invoice Number') . " : $form->{invnumber}";
236 if ($form->{invdate}) {
237 push @options, $locale->text('Invoice Date') . " : $form->{invdate}";
239 if ($form->{partnumber}) {
240 push @options, $locale->text('Part Number') . " : $form->{partnumber}";
242 if ($form->{partsgroup_id}) {
243 my $partsgroup = SL::DB::PartsGroup->new(id => $form->{partsgroup_id})->load;
244 push @options, $locale->text('Group') . " : $partsgroup->{partsgroup}";
246 if ($form->{country}) {
247 push @options, $locale->text('Country') . " : $form->{country}";
249 if ($form->{employee_id}) {
250 my $employee = SL::DB::Employee->new(id => $form->{employee_id})->load;
251 push @options, $locale->text('Employee') . ' : ' . $employee->name;
253 if ($form->{salesman_id}) {
254 my $salesman = SL::DB::Employee->new(id => $form->{salesman_id})->load;
255 push @options, $locale->text('Salesman') . ' : ' . $salesman->name;
257 if ($form->{business_id}) {
258 my $business = SL::DB::Business->new(id => $form->{business_id})->load;
259 push @options, $locale->text('Customer type') . ' : ' . $business->description;
261 if ($form->{ordnumber}) {
262 push @options, $locale->text('Order Number') . " : $form->{ordnumber}";
264 if ($form->{notes}) {
265 push @options, $locale->text('Notes') . " : $form->{notes}";
267 if ($form->{transaction_description}) {
268 push @options, $locale->text('Transaction description') . " : $form->{transaction_description}";
270 if ($form->{transdatefrom}) {
271 push @options, $locale->text('From') . " " . $locale->date(\%myconfig, $form->{transdatefrom}, 1);
273 if ($form->{transdateto}) {
274 push @options, $locale->text('Bis') . " " . $locale->date(\%myconfig, $form->{transdateto}, 1);
277 my $report = SL::ReportGenerator->new(\%myconfig, $form);
279 $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),
280 'output_format' => 'HTML',
281 'title' => $form->{title},
282 'attachment_basename' => $locale->text('Sales Report') . strftime('_%Y%m%d', localtime time),
284 $report->set_options_from_form();
285 $locale->set_numberformat_wo_thousands_separator(\%myconfig) if lc($report->{options}->{output_format}) eq 'csv';
287 $report->set_columns(%column_defs);
288 $report->set_column_order(@columns);
290 $report->set_export_options('invoice_transactions', @hidden_variables, qw(mainsort sortdir));
292 $report->set_sort_indicator($form->{mainsort}, $form->{sortdir});
294 CVar->add_custom_variables_to_report('module' => 'CT',
295 'trans_id_field' => 'customerid',
296 'configs' => $cvar_configs_ct,
297 'column_defs' => \%column_defs,
298 'data' => $form->{AR}
301 CVar->add_custom_variables_to_report('module' => 'IC',
302 'trans_id_field' => 'parts_id',
303 'configs' => $cvar_configs_ic,
304 'column_defs' => \%column_defs,
305 'data' => $form->{AR}
308 # add sort and escape callback, this one we use for the add sub
309 $form->{callback} = $href .= "&sort=$form->{mainsort}";
311 # escape callback for href
312 $callback = $form->escape($href);
314 my @subtotal_columns = qw(qty sellprice sellprice_total lastcost lastcost_total marge_total marge_percent discount);
316 # Summe von sellprice_total, lastcost_total und marge_total
317 # Durchschnitt von marge_percent
318 my @total_columns = qw(sellprice_total lastcost_total marge_total marge_percent );
320 my %totals = map { $_ => 0 } @total_columns;
321 my %subtotals1 = map { $_ => 0 } @subtotal_columns;
322 my %subtotals2 = map { $_ => 0 } @subtotal_columns;
327 my $all_units = AM->retrieve_all_units();
329 foreach my $ar (@{ $form->{AR} }) {
330 $basefactor = $all_units->{$ar->{unit}}->{factor} / $all_units->{$ar->{parts_unit}}->{factor};
331 $basefactor = 1 unless $basefactor;
333 $ar->{price_factor} = 1 unless $ar->{price_factor};
334 # calculate individual sellprice
335 # discount was already accounted for in db sellprice
336 $ar->{sellprice} = $ar->{sellprice} / $ar->{price_factor} / $basefactor;
337 $ar->{lastcost} = $ar->{lastcost} / $ar->{price_factor};
338 $ar->{sellprice_total} = $ar->{qty} * ( $ar->{fxsellprice} * ( 1 - $ar->{discount} ) ) / $ar->{price_factor};
339 $ar->{lastcost_total} = $ar->{qty} * $ar->{lastcost} * $basefactor;
340 # marge_percent wird neu berechnet, da Wert in invoice leer ist (Bug)
341 $ar->{marge_percent} = $ar->{sellprice_total} ? (($ar->{sellprice_total}-$ar->{lastcost_total}) / $ar->{sellprice_total} * 100) : 0;
342 # marge_total neu berechnen
343 $ar->{marge_total} = $ar->{sellprice_total} ? $ar->{sellprice_total}-$ar->{lastcost_total} : 0;
344 $ar->{discount} *= 100; # für Ausgabe formatieren, 10% stored as 0.1 in db
346 # Anfangshauptüberschrift
347 if ( $form->{l_headers_mainsort} eq "Y" && ( $idx == 0 or $ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx - 1]->{ $form->{'mainsort'} } )) {
350 # use $emptyname for mainsort header if mainsort is empty
351 if ( $ar->{$form->{'mainsort'}} ) {
352 $headerrow->{description}->{data} = $ar->{$form->{'mainsort'}};
354 $headerrow->{description}->{data} = $locale->text('empty');
357 $headerrow->{description}->{class} = "listmainsortheader";
358 my $headerrow_set = [ $headerrow ];
359 $report->add_data($headerrow_set);
361 # add empty row after main header
362 # my $emptyheaderrow->{description}->{data} = "";
363 # $emptyheaderrow->{description}->{class} = "listmainsortheader";
364 # my $emptyheaderrow_set = [ $emptyheaderrow ];
365 # $report->add_data($emptyheaderrow_set) if $form->{l_headers} eq "Y";
368 # subsort überschriften
370 or $ar->{ $form->{'subsort'} } ne $form->{AR}->[$idx - 1]->{ $form->{'subsort'} }
371 or $ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx - 1]->{ $form->{'mainsort'} }
375 # if subsort name is defined, use that name in header, otherwise use $emptyname
376 if ( $ar->{$form->{'subsort'}} ) {
377 $headerrow->{description}->{data} = $ar->{$form->{'subsort'}};
379 $headerrow->{description}->{data} = $locale->text('empty');
381 $headerrow->{description}->{class} = "listsubsortheader";
382 my $headerrow_set = [ $headerrow ];
383 # special case: subsort headers only makes (aesthetical) sense if we show individual parts
384 $report->add_data($headerrow_set) if $form->{l_headers_subsort} eq "Y" and $form->{l_parts};
387 map { $subtotals1{$_} += $ar->{$_};
388 $subtotals2{$_} += $ar->{$_};
391 map { $totals{$_} += $ar->{$_} } @total_columns;
393 if ( $subtotals1{qty} != 0 ) {
394 # calculate averages for subtotals1 and subtotals2
395 # credited positions reduce both total and qty and thus don't influence average prices
396 $subtotals1{sellprice} = $subtotals1{sellprice_total} / $subtotals1{qty};
397 $subtotals1{lastcost} = $subtotals1{lastcost_total} / $subtotals1{qty};
399 # qty is zero, so we have a special case where each position in subtotal
400 # group has a corresponding credit note so that the total qty is zero in
401 # this case we also want the total amounts to be zero, so overwrite them,
402 # rather than leaving the last value in sellprice/lastcost
404 $subtotals1{sellprice} = 0;
405 $subtotals1{lastcost} = 0;
408 if ( $subtotals2{qty} != 0 ) {
409 $subtotals2{sellprice} = $subtotals2{sellprice_total} / $subtotals2{qty};
410 $subtotals2{lastcost} = $subtotals2{lastcost_total} / $subtotals2{qty};
412 $subtotals2{sellprice} = 0;
413 $subtotals2{lastcost} = 0;
416 # Ertrag prozentual in den Summen: (summe VK - summe Ertrag) / summe VK
417 $subtotals1{marge_percent} = $subtotals1{sellprice_total} ? (($subtotals1{sellprice_total} - $subtotals1{lastcost_total}) / $subtotals1{sellprice_total}) * 100 : 0;
418 $subtotals2{marge_percent} = $subtotals2{sellprice_total} ? (($subtotals2{sellprice_total} - $subtotals2{lastcost_total}) / $subtotals2{sellprice_total}) *100 : 0;
420 # Ertrag prozentual: (Summe VK betrag - Summe EK betrag) / Summe VK betrag
421 # wird laufend bei jeder Position neu berechnet
422 $totals{marge_percent} = $totals{sellprice_total} ? ( ($totals{sellprice_total} - $totals{lastcost_total}) / $totals{sellprice_total} ) * 100 : 0;
424 #passt die qty an die gewählte Einheit an
425 #qty wurde bisher noch für andere Berechnungen benötigt und daher erst am Schluss überschrieben
426 $ar->{qty} *= $basefactor;
428 map { $ar->{$_} = $form->format_amount(\%myconfig, $ar->{$_}, 2) } qw(marge_total marge_percent);
429 map { $ar->{$_} = $form->format_amount(\%myconfig, $ar->{$_}, $form->{"decimalplaces"} )} qw(lastcost sellprice sellprice_total lastcost_total);
433 foreach my $column (@columns) {
435 'data' => $ar->{$column},
436 'align' => $column_alignment{$column},
440 $row->{description}->{class} = 'listsortdescription';
442 $row->{invnumber}->{link} = build_std_url("script=is.pl", 'action=edit')
443 . "&id=" . E($ar->{id}) . "&callback=${callback}";
445 # Einzelzeilen nur zeigen wenn l_parts gesetzt ist, nützlich, wenn man nur
446 # Subtotals und Totals sehen möchte
447 my $row_set = $form->{l_parts} ? [ $row ] : [ ];
449 # hier wird bei l_subtotal nicht differenziert zwischen mainsort und subsort
450 # macht man l_subtotal_mainsort aus wird l_subtotal_subsort auch nicht ausgeführt
451 if (($form->{l_subtotal_mainsort} eq 'Y')
452 && (($idx == (scalar @{ $form->{AR} } - 1)) # last element always has a subtotal
453 || ($ar->{ $form->{'subsort'} } ne $form->{AR}->[$idx + 1]->{ $form->{'subsort'} })
454 || ($ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx + 1]->{ $form->{'mainsort'} })
455 )) { # if value that is sorted by changes, print subtotal
457 if ($form->{l_subtotal_subsort} eq 'Y') {
458 push @{ $row_set }, create_subtotal_row_invoice(\%subtotals2, \@columns, \%column_alignment, \@subtotal_columns, 'listsubsortsubtotal', $ar->{ $form->{'subsort'} }) ;
459 push @{ $row_set }, insert_empty_row() if $form->{l_parts} and $addemptylines;
463 # if last mainsort is reached or mainsort has changed, add mainsort subtotal and empty row
464 if (($form->{l_subtotal_mainsort} eq 'Y')
465 && (($idx == (scalar @{ $form->{AR} } - 1)) # last element always has a subtotal
466 || ($ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx + 1]->{ $form->{'mainsort'} })
467 )) { # if value that is sorted by changes, print subtotal
468 if ($form->{l_subtotal_mainsort} eq 'Y' and $form->{mainsort} ne $form->{subsort} ) {
469 # subtotal is overriden if mainsort and subsort are equal, don't print
470 # subtotal line even if it is selected
471 push @{ $row_set }, create_subtotal_row_invoice(\%subtotals1, \@columns, \%column_alignment, \@subtotal_columns, 'listmainsortsubtotal', $ar->{$form->{mainsort}});
472 push @{ $row_set }, insert_empty_row() if $addemptylines; # insert empty row after mainsort
476 $report->add_data($row_set);
480 if ( $form->{l_total} eq "Y" ) {
481 $report->add_separator();
482 $report->add_data(create_subtotal_row_invoice(\%totals, \@columns, \%column_alignment, \@total_columns, 'listtotal', 'l_total'))
485 $report->generate_with_headers();
486 $main::lxdebug->leave_sub();
490 sub insert_empty_row {
492 $dummyrow->{description}->{data} = "";
493 my $dummyrowset = [ $dummyrow ];
499 sub create_subtotal_row_invoice {
500 $main::lxdebug->enter_sub();
502 my ($totals, $columns, $column_alignment, $subtotal_columns, $class, $name) = @_;
504 my $form = $main::form;
505 my %myconfig = %main::myconfig;
506 my $locale = $main::locale;
508 my $row = { map { $_ => { 'data' => '', 'class' => $class, 'align' => $column_alignment->{$_}, } } @{ $columns } };
510 # set name as "empty" if no value is given, except if we are dealing with the
511 # absolute total, then just write "Total sum"
512 # here we assume that no name will be called 'l_total'
513 $name = $locale->text('empty') unless $name;
514 if ( $name eq 'l_total' ) {
515 $row->{description}->{data} = $locale->text('Total sum');
517 $row->{description}->{data} = $locale->text('Total') . ' ' . $name;
520 map { $row->{$_}->{data} = $form->format_amount(\%myconfig, $totals->{$_}, 2) } qw(marge_total marge_percent);
521 map { $row->{$_}->{data} = $form->format_amount(\%myconfig, $totals->{$_}, 0) } qw(qty);
522 map { $row->{$_}->{data} = $form->format_amount(\%myconfig, $totals->{$_}, $form->{decimalplaces}) } qw(lastcost sellprice sellprice_total lastcost_total);
525 map { $totals->{$_} = 0 } @{ $subtotal_columns };
527 $main::lxdebug->leave_sub();