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');
65 $form->get_lists("projects" => { "key" => "ALL_PROJECTS", "all" => 1 },
66 "departments" => "ALL_DEPARTMENTS",
67 "business_types" => "ALL_BUSINESS_TYPES",
68 "salesmen" => "ALL_SALESMEN",
69 'employees' => 'ALL_EMPLOYEES',
70 'partsgroup' => 'ALL_PARTSGROUPS',
71 "customers" => "ALL_VC");
72 $form->{CUSTOM_VARIABLES_IC} = CVar->get_configs('module' => 'IC');
73 ($form->{CUSTOM_VARIABLES_FILTER_CODE_IC},
74 $form->{CUSTOM_VARIABLES_INCLUSION_CODE_IC}) = CVar->render_search_options('variables' => $form->{CUSTOM_VARIABLES_IC},
75 'include_prefix' => 'l_',
76 'include_value' => 'Y');
78 $form->{CUSTOM_VARIABLES_CT} = CVar->get_configs('module' => 'CT');
79 ($form->{CUSTOM_VARIABLES_FILTER_CODE_CT},
80 $form->{CUSTOM_VARIABLES_INCLUSION_CODE_CT}) = CVar->render_search_options('variables' => $form->{CUSTOM_VARIABLES_CT},
81 'include_prefix' => 'l_',
82 'include_value' => 'Y');
83 $form->{vc_keys} = sub { "$_[0]->{name}--$_[0]->{id}" };
84 $form->{employee_labels} = sub { $_[0]->{"name"} || $_[0]->{"login"} };
85 $form->{salesman_labels} = $form->{employee_labels};
88 print $form->parse_html_template('vk/search_invoice', { %myconfig });
90 $main::lxdebug->leave_sub();
93 sub invoice_transactions {
94 $main::lxdebug->enter_sub();
96 $main::auth->assert('general_ledger | invoice_edit');
98 my $form = $main::form;
99 my %myconfig = %main::myconfig;
100 my $locale = $main::locale;
102 my ($callback, $href, @columns);
104 # can't currently be configured from report, empty line between main sortings
105 my $addemptylines = 1;
107 # don't add empty lines between mainsort subtotals when only subtotal_mainsort is selected
108 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} ) {
112 if ( $form->{customer} =~ /--/ ) {
113 # Felddaten kommen aus Dropdownbox
115 ($dummy, $form->{customer_id}) = split(/--/, $form->{customer});
117 # if $form->{customer} is empty nothing further happens here
119 # test for decimalplaces or set to default of 2
120 $form->{decimalplaces} = 2 unless $form->{decimalplaces} > 0 && $form->{decimalplaces} < 6;
122 my $cvar_configs_ct = CVar->get_configs('module' => 'CT');
123 my $cvar_configs_ic = CVar->get_configs('module' => 'IC');
125 # report_generator_set_default_sort('transdate', 1);
127 VK->invoice_transactions(\%myconfig, \%$form);
130 if ( $form->{mainsort} eq 'month' or $form->{subsort} eq 'month' ) {
132 # Data already comes out of SELECT statement in correct month order, but
133 # remove whitespaces (month names are padded) and translate them as early
136 foreach (@{ $form->{AR} }) {
137 $_->{month} =~ s/\s//g;
138 $_->{month} = $locale->text($_->{month});
142 $form->{title} = $locale->text('Sales Report');
145 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);
147 my @includeable_custom_variables = grep { $_->{includeable} } @{ $cvar_configs_ic }, @{ $cvar_configs_ct };
148 my @searchable_custom_variables = grep { $_->{searchable} } @{ $cvar_configs_ic }, @{ $cvar_configs_ct };
149 my %column_defs_cvars = map { +"cvar_$_->{name}" => { 'text' => $_->{description} } } @includeable_custom_variables;
151 push @columns, map { "cvar_$_->{name}" } @includeable_custom_variables;
154 # pass hidden variables for pdf/csv export
155 # first with l_ to determine which columns to show
156 # then with the options for headings (such as transdatefrom, partnumber, ...)
157 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 customer_id department partnumber partsgroup country business description project_id customernumber salesman employee salesman_id employee_id business_id partsgroup_id mainsort subsort),
159 map({ "cvar_$_->{name}" } @searchable_custom_variables),
160 map { "l_$_" } @columns
162 my @hidden_nondefault = grep({ $form->{$_} } @hidden_variables);
163 # variables are passed as hiddens, e.g.
164 # <input type="hidden" name="report_generator_hidden_transdateto" value="21.05.2010">
166 $href = build_std_url('action=invoice_transactions', grep { $form->{$_} } @hidden_variables);
167 # href = vk.pl?action=invoice_transactions&l_headers=Y&l_subtotal=Y&l_total=Y&transdatefrom=04.03.2010 ...
170 'description' => { 'text' => $locale->text('Description'), },
171 'partnumber' => { 'text' => $locale->text('Part Number'), },
172 'partsgroup' => { 'text' => $locale->text('Group'), },
173 'country' => { 'text' => $locale->text('Country'), },
174 'business' => { 'text' => $locale->text('Customer type'), },
175 'employee' => { 'text' => $locale->text('Employee'), },
176 'salesman' => { 'text' => $locale->text('Salesperson'), },
177 'invnumber' => { 'text' => $locale->text('Invoice Number'), },
178 'transdate' => { 'text' => $locale->text('Invoice Date'), },
179 'qty' => { 'text' => $locale->text('Quantity'), },
180 'parts_unit' => { 'text' => $locale->text('Base unit'), },
181 'weight' => { 'text' => $locale->text('Weight'), },
182 'sellprice' => { 'text' => $locale->text('Sales price'), },
183 'sellprice_total' => { 'text' => $locale->text('Sales net amount'), },
184 'lastcost_total' => { 'text' => $locale->text('Purchase net amount'), },
185 'discount' => { 'text' => $locale->text('Discount'), },
186 'lastcost' => { 'text' => $locale->text('Purchase price'), },
187 'marge_total' => { 'text' => $locale->text('Sales margin'), },
188 'marge_percent' => { 'text' => $locale->text('Sales margin %'), },
189 'customernumber' => { 'text' => $locale->text('Customer Number'), },
190 'customername' => { 'text' => $locale->text('Customer Name'), },
191 # add 3 more column_defs so we have a translation for top_info_text
192 'customer' => { 'text' => $locale->text('Customer'), },
193 'part' => { 'text' => $locale->text('Part'), },
194 'month' => { 'text' => $locale->text('Month'), },
198 map { $column_defs{$_}->{visible} = $form->{"l_$_"} eq 'Y' } @columns;
200 my %column_alignment = map { $_ => 'right' } qw(lastcost sellprice sellprice_total lastcost_total parts_unit discount marge_total marge_percent qty weight);
203 # so now the check-box "Description" is only used as switch for part description in invoice-mode
204 # always fill the column "Description" if we are in Zwischensummenmode
205 $form->{"l_description"} = "Y" if not defined $form->{"l_parts"};;
206 map { $column_defs{$_}->{visible} = $form->{"l_${_}"} ? 1 : 0 } @columns;
210 push @options, $locale->text('Description') . " : $form->{description}" if $form->{description};
211 push @options, $locale->text('Customer') . " : $form->{customer}" if $form->{customer};
212 push @options, $locale->text('Customer Number') . " : $form->{customernumber}" if $form->{customernumber};
213 # TODO: only customer id is passed
214 push @options, $locale->text('Department') . " : " . (split /--/, $form->{department})[0] if $form->{department};
215 push @options, $locale->text('Invoice Number') . " : $form->{invnumber}" if $form->{invnumber};
216 push @options, $locale->text('Invoice Date') . " : $form->{invdate}" if $form->{invdate};
217 push @options, $locale->text('Part Number') . " : $form->{partnumber}" if $form->{partnumber};
218 push @options, $locale->text('Group') . " : " . SL::DB::PartsGroup->new(id => $form->{partsgroup_id})->load->partsgroup if $form->{partsgroup_id};
219 push @options, $locale->text('Country') . " : $form->{country}" if $form->{country};
220 push @options, $locale->text('Employee') . ' : ' . SL::DB::Employee->new(id => $form->{employee_id})->load->name if $form->{employee_id};
221 push @options, $locale->text('Salesman') . ' : ' . SL::DB::Employee->new(id => $form->{salesman_id})->load->name if $form->{salesman_id};
222 push @options, $locale->text('Customer type') . ' : ' . SL::DB::Business->new(id => $form->{business_id})->load->description if $form->{business_id};
223 push @options, $locale->text('Order Number') . " : $form->{ordnumber}" if $form->{ordnumber};
224 push @options, $locale->text('Notes') . " : $form->{notes}" if $form->{notes};
225 push @options, $locale->text('Transaction description') . " : $form->{transaction_description}" if $form->{transaction_description};
226 push @options, $locale->text('From') . " " . $locale->date(\%myconfig, $form->{transdatefrom}, 1) if $form->{transdatefrom};
227 push @options, $locale->text('Bis') . " " . $locale->date(\%myconfig, $form->{transdateto}, 1) if $form->{transdateto};
229 my $report = SL::ReportGenerator->new(\%myconfig, $form);
231 $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),
232 'output_format' => 'HTML',
233 'title' => $form->{title},
234 'attachment_basename' => $locale->text('Sales Report') . strftime('_%Y%m%d', localtime time),
236 $report->set_options_from_form();
237 $locale->set_numberformat_wo_thousands_separator(\%myconfig) if lc($report->{options}->{output_format}) eq 'csv';
239 $report->set_columns(%column_defs);
240 $report->set_column_order(@columns);
242 $report->set_export_options('invoice_transactions', @hidden_variables, qw(mainsort sortdir));
244 $report->set_sort_indicator($form->{mainsort}, $form->{sortdir});
246 CVar->add_custom_variables_to_report('module' => 'CT',
247 'trans_id_field' => 'customerid',
248 'configs' => $cvar_configs_ct,
249 'column_defs' => \%column_defs,
250 'data' => $form->{AR}
253 CVar->add_custom_variables_to_report('module' => 'IC',
254 'trans_id_field' => 'parts_id',
255 'configs' => $cvar_configs_ic,
256 'column_defs' => \%column_defs,
257 'data' => $form->{AR}
260 my $num_visible_columns = scalar $report->get_visible_columns;
264 class => 'listrowempty',
265 colspan => $num_visible_columns,
269 # add sort and escape callback, this one we use for the add sub
270 $form->{callback} = $href .= "&sort=$form->{mainsort}";
272 # escape callback for href
273 $callback = $form->escape($href);
275 my @subtotal_columns = qw(qty weight sellprice sellprice_total lastcost lastcost_total marge_total marge_percent discount);
277 # sum of sellprice_total, lastcost_total and marge_total
278 # average of marge_percent
279 my @total_columns = qw(sellprice_total lastcost_total marge_total marge_percent );
281 my %totals = map { $_ => 0 } @total_columns;
282 my %subtotals1 = map { $_ => 0 } @subtotal_columns;
283 my %subtotals2 = map { $_ => 0 } @subtotal_columns;
288 my $all_units = AM->retrieve_all_units();
290 foreach my $ar (@{ $form->{AR} }) {
291 $basefactor = $all_units->{$ar->{unit}}->{factor} / $all_units->{$ar->{parts_unit}}->{factor};
292 $basefactor = 1 unless $basefactor;
294 $ar->{price_factor} = 1 unless $ar->{price_factor};
296 # calculate individual sellprice, discount is already accounted for in column sellprice in db
298 # The sellprice total can be calculated from sellprice or fxsellprice (the
299 # value that was actually entered in the sellprice field and is always
300 # stored seperately). However, for fxsellprice this method only works when
301 # the tax is not included, because otherwise fxsellprice includes the tax
302 # and there is no simple way to extract the tax rate of the article from
305 # Using fxsellprice is potentially more accurate (certainly for tax
306 # included), because we can use the same method as is used while the
307 # invoice is generated.
309 # sellprice however has already been converted to the net value (but
310 # rounded in the process, which leads to rounding errors when calculating
311 # the linetotal from the rounded sellprice in the report. These rounding
312 # errors can quickly amount to several cents when qty is large)
314 # For calculating sellprice_total from fxsellprice, you would use:
315 # sellprice_total_including_tax = qty * fxsellprice * (1-discount) / price_factor * exchangerate
316 # $ar->{sellprice_total_including_tax} = $form->round_amount( $ar->{qty} * ( $ar->{fxsellprice} * ( 1 - $ar->{discount} ) ) / $ar->{price_factor}, $form->{"decimalplaces"});
318 my $sellprice_orig = $ar->{sellprice};
319 my $qty_orig = $ar->{qty};
320 # adjust sellprice so it reflects the unit sellprice according to price_factor and basefactor
321 $ar->{sellprice} = $ar->{sellprice} / $ar->{price_factor} / $basefactor;
322 # for sellprice_total use the original amounts
323 $ar->{sellprice_total} = $form->round_amount( $qty_orig * $sellprice_orig / $ar->{price_factor}, $form->{"decimalplaces"});
325 my $lastcost_orig = $ar->{lastcost};
326 $ar->{lastcost} = $ar->{lastcost} / $ar->{price_factor} / $basefactor;
327 $ar->{lastcost_total} = $form->round_amount( $qty_orig * $lastcost_orig / $ar->{price_factor}, $form->{"decimalplaces"});
329 # marge_percent is recalculated, because the value in invoice used to be empty
330 $ar->{marge_percent} = $ar->{sellprice_total} ? (($ar->{sellprice_total}-$ar->{lastcost_total}) / $ar->{sellprice_total} * 100) : 0;
331 # also recalculate marge_total
332 $ar->{marge_total} = $ar->{sellprice_total} ? $ar->{sellprice_total}-$ar->{lastcost_total} : 0;
333 $ar->{discount} *= 100; # format discount value for output, 10% is stored as 0.1 in db
335 # adjust qty to reflect the qty of the base unit
336 $ar->{qty} *= $basefactor;
338 # now $ar->{sellprice} * $ar->{qty} should be the same as $qty_orig * $ar->{qty}
340 # weight is the still the weight per part, but here we want the total weight
341 $ar->{weight} *= $ar->{qty};
344 if ( $form->{l_headers_mainsort} eq "Y" && ( $idx == 1 or $ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx - 1]->{ $form->{'mainsort'} } )) {
346 # use $emptyname for mainsort header if mainsort is empty
347 data => $ar->{$form->{'mainsort'}} || $locale->text('empty'),
348 class => "listmainsortheader",
349 colspan => $num_visible_columns,
351 $report->add_data([ { description => $headerrow } ]);
353 # add empty row after main header
354 # my $emptyheaderrow->{description}->{data} = "";
355 # $emptyheaderrow->{description}->{class} = "listmainsortheader";
356 # my $emptyheaderrow_set = [ $emptyheaderrow ];
357 # $report->add_data($emptyheaderrow_set) if $form->{l_headers} eq "Y";
361 # special case: subsort headers only makes (aesthetical) sense if we show individual parts
363 or $ar->{ $form->{'subsort'} } ne $form->{AR}->[$idx - 1]->{ $form->{'subsort'} }
364 or $ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx - 1]->{ $form->{'mainsort'} })
365 && ($form->{l_headers_subsort} eq "Y")
369 # if subsort name is defined, use that name in header, otherwise use $emptyname
370 data => $ar->{$form->{'subsort'}} || $locale->text('empty'),
371 class => "listsubsortheader",
372 colspan => $num_visible_columns,
374 $report->add_data([ { description => $headerrow } ]);
377 map { $subtotals1{$_} += $ar->{$_};
378 $subtotals2{$_} += $ar->{$_};
381 map { $totals{$_} += $ar->{$_} } @total_columns;
383 if ( $subtotals1{qty} != 0 ) {
384 # calculate averages for subtotals1 and subtotals2
385 # credited positions reduce both total and qty and thus don't influence average prices
386 $subtotals1{sellprice} = $subtotals1{sellprice_total} / $subtotals1{qty};
387 $subtotals1{lastcost} = $subtotals1{lastcost_total} / $subtotals1{qty};
389 # qty is zero, so we have a special case where each position in subtotal
390 # group has a corresponding credit note so that the total qty is zero in
391 # this case we also want the total amounts to be zero, so overwrite them,
392 # rather than leaving the last value in sellprice/lastcost
394 $subtotals1{sellprice} = 0;
395 $subtotals1{lastcost} = 0;
398 if ( $subtotals2{qty} != 0 ) {
399 $subtotals2{sellprice} = $subtotals2{sellprice_total} / $subtotals2{qty};
400 $subtotals2{lastcost} = $subtotals2{lastcost_total} / $subtotals2{qty};
402 $subtotals2{sellprice} = 0;
403 $subtotals2{lastcost} = 0;
406 # marge percent as sums: (sum VK - sum Ertrag) / sum VK
407 $subtotals1{marge_percent} = $subtotals1{sellprice_total} ? (($subtotals1{sellprice_total} - $subtotals1{lastcost_total}) / $subtotals1{sellprice_total}) * 100 : 0;
408 $subtotals2{marge_percent} = $subtotals2{sellprice_total} ? (($subtotals2{sellprice_total} - $subtotals2{lastcost_total}) / $subtotals2{sellprice_total}) *100 : 0;
410 # total marge percent: (sum VK betrag - sum EK betrag) / sum VK betrag
411 # is recalculated after each position
412 $totals{marge_percent} = $totals{sellprice_total} ? ( ($totals{sellprice_total} - $totals{lastcost_total}) / $totals{sellprice_total} ) * 100 : 0;
414 map { $ar->{$_} = $form->format_amount(\%myconfig, $ar->{$_}, 2) } qw(marge_percent qty);
415 map { $ar->{$_} = $form->format_amount(\%myconfig, $ar->{$_}, 3) } qw(weight);
416 map { $ar->{$_} = $form->format_amount(\%myconfig, $ar->{$_}, $form->{"decimalplaces"} )} qw(lastcost sellprice sellprice_total lastcost_total marge_total);
418 # only show individual lines when l_parts is set, this is useful, if you
419 # only want to see subtotals and totals
421 if ($form->{l_parts}) {
423 map { ($_ => { data => $ar->{$_}, align => $column_alignment{$_} }) } @columns
426 $row{invnumber}->{link} = build_std_url("script=is.pl", 'action=edit') . "&id=" . E($ar->{id}) . "&callback=${callback}";
428 # use partdescription according to invoice in article mode
429 $row{description}->{data} = $ar->{invoice_description};
431 $report->add_data(\%row);
434 # choosing l_subtotal doesn't make a distinction between mainsort and subsort
435 # if l_subtotal_mainsort is not selected l_subtotal_subsort isn't run either
436 if ( ($form->{l_subtotal_mainsort} eq 'Y')
437 && ($form->{l_subtotal_subsort} eq 'Y')
438 && (($idx == (scalar @{ $form->{AR} } - 1)) # last element always has a subtotal
439 || ($ar->{ $form->{'subsort'} } ne $form->{AR}->[$idx + 1]->{ $form->{'subsort'} })
440 || ($ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx + 1]->{ $form->{'mainsort'} })
441 )) { # if value that is sorted by changes, print subtotal
443 $report->add_data(create_subtotal_row_invoice(\%subtotals2, \@columns, \%column_alignment, \@subtotal_columns, $form->{l_parts} ? 'listsubtotal' : undef, $ar->{ $form->{'subsort'} }));
444 $report->add_data({ %empty_row }) if $form->{l_parts} and $addemptylines;
447 # if last mainsort is reached or mainsort has changed, add mainsort subtotal and empty row
448 if ( ($form->{l_subtotal_mainsort} eq 'Y')
449 && ($form->{l_subtotal_mainsort} eq 'Y')
450 && ($form->{mainsort} ne $form->{subsort})
451 && (($idx == (scalar @{ $form->{AR} } - 1)) # last element always has a subtotal
452 || ($ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx + 1]->{ $form->{'mainsort'} })
453 )) { # if value that is sorted by changes, print subtotal
454 # subtotal is overridden if mainsort and subsort are equal, don't print
455 # subtotal line even if it is selected
456 $report->add_data(create_subtotal_row_invoice(\%subtotals1, \@columns, \%column_alignment, \@subtotal_columns, 'listsubtotal', $ar->{$form->{mainsort}}));
457 $report->add_data({ %empty_row }) if $addemptylines; # insert empty row after mainsort
462 if ( $form->{l_total} eq "Y" ) {
463 $report->add_separator();
464 $report->add_data(create_subtotal_row_invoice(\%totals, \@columns, \%column_alignment, \@total_columns, 'listtotal', 'l_total'))
467 $report->generate_with_headers();
468 $main::lxdebug->leave_sub();
471 sub create_subtotal_row_invoice {
472 $main::lxdebug->enter_sub();
474 my ($totals, $columns, $column_alignment, $subtotal_columns, $class, $name) = @_;
476 my $form = $main::form;
477 my %myconfig = %main::myconfig;
478 my $locale = $main::locale;
480 my $row = { map { $_ => { data => '', class => $class, align => $column_alignment->{$_}, } } @{ $columns } };
482 # set name as "empty" if no value is given, except if we are dealing with the
483 # absolute total, then just write "Total sum"
484 # here we assume that no name will be called 'l_total'
485 $name = $locale->text('empty') unless $name;
486 if ( $name eq 'l_total' ) {
487 $row->{description}->{data} = $locale->text('Total sum');
489 $row->{description}->{data} = $locale->text('Total') . ' ' . $name;
492 map { $row->{$_}->{data} = $form->format_amount(\%myconfig, $totals->{$_}, 2) } qw(marge_total marge_percent qty);
493 map { $row->{$_}->{data} = $form->format_amount(\%myconfig, $totals->{$_}, 3) } qw(weight);
494 map { $row->{$_}->{data} = $form->format_amount(\%myconfig, $totals->{$_}, $form->{decimalplaces}) } qw(lastcost sellprice sellprice_total lastcost_total);
497 map { $totals->{$_} = 0 } @{ $subtotal_columns };
499 $main::lxdebug->leave_sub();