PTC: Fehlerhafte ungerundete Berechnung von grossamount

[mfinanz.git] / SL / DB / Helper / PriceTaxCalculator.pm

diff --git a/SL/DB/Helper/PriceTaxCalculator.pm b/SL/DB/Helper/PriceTaxCalculator.pm
index 9706d0258847b4bf397d2192da4f9baa053b0c3b..80c80472857357e11d194433c830c27919f3dea0 100644 (file)
--- a/SL/DB/Helper/PriceTaxCalculator.pm
+++ b/SL/DB/Helper/PriceTaxCalculator.pm
@@ -3,99 +3,130 @@ package SL::DB::Helper::PriceTaxCalculator;
 use strict;
 
 use parent qw(Exporter);
 use strict;
 
 use parent qw(Exporter);

-our @EXPORT = qw(calculate_prices_and_taxes);
+our @EXPORT = qw(calculate_prices_and_taxes _calculate_item);

 
 use Carp;
 
 use Carp;

-use List::Util qw(sum);
-use SL::DB::Default;
-use SL::DB::PriceFactor;
-use SL::DB::Unit;
+use List::Util qw(sum min max);

 
 sub calculate_prices_and_taxes {
   my ($self, %params) = @_;
 
 
 sub calculate_prices_and_taxes {
   my ($self, %params) = @_;
 

-  my $is_sales            = $self->can('customer') && $self->customer;
-  my $is_invoice          = (ref($self) =~ /Invoice/) || $params{invoice};
+  require SL::DB::Chart;
+  require SL::DB::Currency;
+  require SL::DB::Default;
+  require SL::DB::InvoiceItem;
+  require SL::DB::Part;
+  require SL::DB::PriceFactor;
+  require SL::DB::Unit;
+
+  SL::DB::Part->load_cached(map { $_->parts_id } @{ $self->items }) if @{ $self->items || [] };

 
   my %units_by_name       = map { ( $_->name => $_ ) } @{ SL::DB::Manager::Unit->get_all        };
   my %price_factors_by_id = map { ( $_->id   => $_ ) } @{ SL::DB::Manager::PriceFactor->get_all };
 
   my %units_by_name       = map { ( $_->name => $_ ) } @{ SL::DB::Manager::Unit->get_all        };
   my %price_factors_by_id = map { ( $_->id   => $_ ) } @{ SL::DB::Manager::PriceFactor->get_all };

-  my %taxes_by_chart_id   = ();
-  my %amounts_by_chart_id = ();

 
   my %data = ( lastcost_total      => 0,
                invoicediff         => 0,
 
   my %data = ( lastcost_total      => 0,
                invoicediff         => 0,

+               last_incex_chart_id => undef,

                units_by_name       => \%units_by_name,
                price_factors_by_id => \%price_factors_by_id,
                units_by_name       => \%units_by_name,
                price_factors_by_id => \%price_factors_by_id,

-               taxes_by_chart_id   => \%taxes_by_chart_id,
-               amounts_by_chart_id => \%amounts_by_chart_id,
+               taxes               => { },
+               amounts             => { },
+               amounts_cogs        => { },
+               allocated           => { },
+               assembly_items      => [ ],

                exchangerate        => undef,
                exchangerate        => undef,

+               is_sales            => $self->can('customer') && $self->customer,
+               is_invoice          => (ref($self) =~ /Invoice/) || $params{invoice},
+               items               => [ ],

              );
 
              );
 

-  if (($self->curr || '') ne SL::DB::Default->get_default_currency) {
-    $data{exchangerate}   = $::form->check_exchangerate(\%::myconfig, $self->curr, $self->transdate, $is_sales ? 'buy' : 'sell');
-    $data{exchangerate} ||= $params{exchangerate};
-  }
-  $data{exchangerate} ||= 1;
+  # set exchangerate in $data>{exchangerate}
+  if ( ref($self) eq 'SL::DB::Order' ) {
+    # orders store amount in the order currency
+    $data{exchangerate} = 1;
+  } else {
+    # invoices store amount in the default currency
+    _get_exchangerate($self, \%data, %params);
+    # $data{exchangerate} = $self->exchangerate; # untested alternative for setting exchangerate
+  };

 
   $self->netamount(  0);
   $self->marge_total(0);
 
 
   $self->netamount(  0);
   $self->marge_total(0);
 

+  SL::DB::Manager::Chart->cache_taxkeys(date => $self->transdate);
+

   my $idx = 0;
   foreach my $item ($self->items) {
     $idx++;
   my $idx = 0;
   foreach my $item ($self->items) {
     $idx++;

-    _calculate_item($self, $item, $idx, \%data);
+    _calculate_item($self, $item, $idx, \%data, %params);

   }
 
   }
 

-  my $tax_sum = sum map { _round($_, 2) } values %taxes_by_chart_id;
-
-  $self->amount(       _round($self->netamount + $tax_sum, 2));
-  $self->netamount(    _round($self->netamount,            2));
-  $self->marge_percent($self->netamount ? ($self->netamount - $data{lastcost_total}) * 100 / $self->netamount : 0);
+  _calculate_amounts($self, \%data, %params);

 
   return $self unless wantarray;
 
   return $self unless wantarray;

-  return ( self    => $self,
-           taxes   => \%taxes_by_chart_id,
-           amounts => \%amounts_by_chart_id,
-         );
+
+  return map { ($_ => $data{$_}) } qw(taxes amounts amounts_cogs allocated exchangerate assembly_items items rounding);
+}
+
+sub _get_exchangerate {
+  my ($self, $data, %params) = @_;
+
+  my $currency = $self->currency_id ? SL::DB::Currency->load_cached($self->currency_id)->name || '' : '';
+  if ($currency ne SL::DB::Default->get_default_currency) {
+    $data->{exchangerate}   = $::form->check_exchangerate(\%::myconfig, $currency, $self->transdate, $data->{is_sales} ? 'buy' : 'sell');
+    $data->{exchangerate} ||= $params{exchangerate};
+  }
+  $data->{exchangerate} ||= 1;

 }
 
 sub _calculate_item {
 }
 
 sub _calculate_item {

-  my ($self, $item, $idx, $data) = @_;
+  my ($self, $item, $idx, $data, %params) = @_;
+
+  my $part       = SL::DB::Part->load_cached($item->parts_id);
+  return unless $part;

 
 

-  my $part_unit  = $data->{units_by_name}->{ $item->part->unit };
-  my $item_unit  = $data->{units_by_name}->{ $item->unit       };
+  my $part_unit  = $data->{units_by_name}->{ $part->unit };
+  my $item_unit  = $data->{units_by_name}->{ $item->unit };

 
 

-  croak("Undefined unit " . $item->part->unit) if !$part_unit;
-  croak("Undefined unit " . $item->unit)       if !$item_unit;
+  croak("Undefined unit " . $part->unit) if !$part_unit;
+  croak("Undefined unit " . $item->unit) if !$item_unit;

 
   $item->base_qty($item_unit->convert_to($item->qty, $part_unit));
 
   $item->base_qty($item_unit->convert_to($item->qty, $part_unit));

+  $item->fxsellprice($item->sellprice) if $data->{is_invoice};
+
+  my $num_dec   = max 2, _num_decimal_places($item->sellprice);

 
 

-  my $num_dec   = _num_decimal_places($item->sellprice);
-  my $discount  = _round($item->sellprice * ($item->discount || 0), $num_dec);
-  my $sellprice = _round($item->sellprice - $discount,              $num_dec);
+  $item->discount(0) if !$item->discount;
+
+  # don't include rounded discount into sellprice for calculation
+  # any time the sellprice is multiplied with qty discount has to be considered as part of the multiplication
+  my $sellprice = $item->sellprice;

 
   $item->price_factor(      ! $item->price_factor_obj   ? 1 : ($item->price_factor_obj->factor   || 1));
 
   $item->price_factor(      ! $item->price_factor_obj   ? 1 : ($item->price_factor_obj->factor   || 1));

-  $item->marge_price_factor(! $item->part->price_factor ? 1 : ($item->part->price_factor->factor || 1));
-  my $linetotal = _round($sellprice * $item->qty / $item->price_factor, 2) * $data->{exchangerate};
-  $linetotal    = _round($linetotal,                                    2);
+  $item->marge_price_factor(! $part->price_factor ? 1 : ($part->price_factor->factor || 1));
+  my $linetotal = _round($sellprice * (1 - $item->discount) * $item->qty / $item->price_factor, 2) * $data->{exchangerate};
+  $linetotal    = _round($linetotal,                                                            2);
+
+  $data->{invoicediff} += $sellprice * (1 - $item->discount) * $item->qty * $data->{exchangerate} / $item->price_factor - $linetotal if $self->taxincluded;

 
 

-  $data->{invoicediff} += $sellprice * $item->qty * $data->{exchangerate} / $item->price_factor - $linetotal;
+  my $linetotal_cost = 0;

 
   if (!$linetotal) {
     $item->marge_total(  0);
     $item->marge_percent(0);
 
   } else {
 
   if (!$linetotal) {
     $item->marge_total(  0);
     $item->marge_percent(0);
 
   } else {

-    my $lastcost = ! ($item->lastcost * 1) ? ($item->part->lastcost || 0) : $item->lastcost;
+    my $lastcost       = !(($item->lastcost // 0) * 1) ? ($part->lastcost || 0) : $item->lastcost;
+    $linetotal_cost    = _round($lastcost * $item->qty / $item->marge_price_factor, 2);

 
 

-    $item->marge_total(  $linetotal - $lastcost / $item->marge_price_factor);
+    $item->marge_total(  $linetotal - $linetotal_cost);

     $item->marge_percent($item->marge_total * 100 / $linetotal);
 
     $self->marge_total(  $self->marge_total + $item->marge_total);
     $item->marge_percent($item->marge_total * 100 / $linetotal);
 
     $self->marge_total(  $self->marge_total + $item->marge_total);

-    $data->{lastcost_total} += $lastcost;
+    $data->{lastcost_total} += $linetotal_cost;

   }
 
   }
 

-  my $taxkey     = $item->part->get_taxkey(date => $self->transdate, is_sales => $data->{is_sales}, taxzone => $self->taxzone_id);
+  my $taxkey     = $part->get_taxkey(date => $self->transdate, is_sales => $data->{is_sales}, taxzone => $self->taxzone_id);

   my $tax_rate   = $taxkey->tax->rate;
   my $tax_amount = undef;
 
   my $tax_rate   = $taxkey->tax->rate;
   my $tax_amount = undef;
 


@@ -107,24 +138,131 @@ sub _calculate_item {
     $tax_amount = $linetotal * $tax_rate;
   }
 
     $tax_amount = $linetotal * $tax_rate;
   }
 

-  $data->{taxes_by_chart_id}->{ $taxkey->chart_id } ||= 0;
-  $data->{taxes_by_chart_id}->{ $taxkey->chart_id }  += $tax_amount;
+  if ($taxkey->tax->chart_id) {
+    $data->{taxes}->{ $taxkey->tax->chart_id } ||= 0;
+    $data->{taxes}->{ $taxkey->tax->chart_id }  += $tax_amount;
+  } elsif ($tax_amount) {
+    die "tax_amount != 0 but no chart_id for taxkey " . $taxkey->id . " tax " . $taxkey->tax->id;
+  }
+
+  my $chart = $part->get_chart(type => $data->{is_sales} ? 'income' : 'expense', taxzone => $self->taxzone_id);
+  $data->{amounts}->{ $chart->id }           ||= { taxkey => $taxkey->taxkey_id, tax_id => $taxkey->tax_id, amount => 0 };
+  $data->{amounts}->{ $chart->id }->{amount}  += $linetotal;
+  $data->{amounts}->{ $chart->id }->{amount}  -= $tax_amount if $self->taxincluded;
+
+  push @{ $data->{assembly_items} }, [];
+  if ($part->is_assembly) {
+    _calculate_assembly_item($self, $data, $part, $item->base_qty, $item_unit->convert_to(1, $part_unit));
+  } elsif ($part->is_part) {
+    if ($data->{is_invoice}) {
+      $item->allocated(_calculate_part_item($self, $data, $part, $item->base_qty, $item_unit->convert_to(1, $part_unit)));
+    }
+  }
+
+  $data->{last_incex_chart_id} = $chart->id if $data->{is_sales};
+
+  my $item_sellprice = _round($sellprice * (1 - $item->discount), $num_dec);
+
+  push @{ $data->{items} }, {
+    linetotal      => $linetotal,
+    linetotal_cost => $linetotal_cost,
+    sellprice      => $item_sellprice,
+    tax_amount     => $tax_amount,
+    taxkey_id      => $taxkey->id,
+  };
+
+  _dbg("CALCULATE! ${idx} i.qty " . $item->qty . " i.sellprice " . $item->sellprice . " sellprice $sellprice num_dec $num_dec taxamount $tax_amount " .
+       "i.linetotal $linetotal netamount " . $self->netamount . " marge_total " . $item->marge_total . " marge_percent " . $item->marge_percent);
+}
+
+sub _calculate_amounts {
+  my ($self, $data, %params) = @_;
+
+  my $tax_diff = 0;
+  foreach my $chart_id (keys %{ $data->{taxes} }) {
+    my $rounded                  = _round($data->{taxes}->{$chart_id} * $data->{exchangerate}, 2);
+    $tax_diff                   += $data->{taxes}->{$chart_id} * $data->{exchangerate} - $rounded if $self->taxincluded;
+    $data->{taxes}->{$chart_id}  = $rounded;
+  }
+
+  $self->netamount(sum map { $_->{amount} } values %{ $data->{amounts} });
+
+  my $amount    = _round(($self->netamount + $tax_diff) * $data->{exchangerate}, 2);
+  my $diff      = $amount - ($self->netamount + $tax_diff) * $data->{exchangerate};
+  my $netamount = $amount;
+
+  if ($self->taxincluded) {
+    $data->{invoicediff}                                         += $diff;
+    $data->{amounts}->{ $data->{last_incex_chart_id} }->{amount} += $data->{invoicediff} if $data->{last_incex_chart_id};
+  }
+
+  _dbg("Sna " . $self->netamount . " idiff " . $data->{invoicediff} . " tdiff ${tax_diff}");
+
+  my $tax              = sum values %{ $data->{taxes} };
+  $amount              = $netamount + $tax;
+  my $grossamount      = _round($amount, 2, 1);
+  $data->{rounding}    = _round($grossamount - $amount, 2);
+  $data->{arap_amount} = $grossamount;
+
+  $self->netamount(    $netamount);
+  $self->amount(       $grossamount);
+  $self->marge_percent($self->netamount ? ($self->netamount - $data->{lastcost_total}) * 100 / $self->netamount : 0);
+}

 
 

-  $self->netamount($self->netamount + $sellprice * $item->qty / $item->price_factor);
+sub _calculate_assembly_item {
+  my ($self, $data, $part, $total_qty, $base_factor) = @_;

 
 

-  my $chart = $item->part->get_chart(type => $data->{is_sales} ? 'income' : 'expense', taxzone => $self->taxzone_id);
-  $data->{amounts_by_chart_id}->{$chart->id} += $linetotal;
+  return 0 if $::instance_conf->get_inventory_system eq 'periodic' || !$data->{is_invoice};

 
 

-  if ($data->{is_invoice}) {
-    if ($item->part->is_assembly) {
-      # process_assembly()...
-    } else {
-      # cogs...
+  foreach my $assembly_entry (@{ $part->assemblies }) {
+    push @{ $data->{assembly_items}->[-1] }, { part      => $assembly_entry->part,
+                                               qty       => $total_qty * $assembly_entry->qty,
+                                               allocated => 0 };
+
+    if ($assembly_entry->part->is_assembly) {
+      _calculate_assembly_item($self, $data, $assembly_entry->part, $total_qty * $assembly_entry->qty);
+    } elsif ($assembly_entry->part->is_part) {
+      my $allocated = _calculate_part_item($self, $data, $assembly_entry->part, $total_qty * $assembly_entry->qty);
+      $data->{assembly_items}->[-1]->[-1]->{allocated} = $allocated;

     }
   }
     }
   }

+}
+
+sub _calculate_part_item {
+  my ($self, $data, $part, $total_qty, $base_factor) = @_;
+
+  _dbg("cpsi tq " . $total_qty);
+
+  return 0 if $::instance_conf->get_inventory_system eq 'periodic' || !$data->{is_invoice} || !$total_qty;
+
+  my ($entry);
+  $base_factor           ||= 1;
+  my $remaining_qty        = $total_qty;
+  my $expense_income_chart = $part->get_chart(type => $data->{is_sales} ? 'expense' : 'income', taxzone => $self->taxzone_id);
+  my $inventory_chart      = $part->get_chart(type => 'inventory',                              taxzone => $self->taxzone_id);
+
+  my $iterator             = SL::DB::Manager::InvoiceItem->get_all_iterator(query => [ and => [ parts_id => $part->id,
+                                                                                                \'(base_qty + allocated) < 0' ] ]);
+
+  while (($remaining_qty > 0) && ($entry = $iterator->next)) {
+    my $qty = min($remaining_qty, $entry->base_qty * -1 - $entry->allocated - $data->{allocated}->{ $entry->id });
+    _dbg("qty $qty");
+
+    next unless $qty;

 
 

-  $::lxdebug->message(0, "CALCULATE! ${idx} i.qty " . $item->qty . " i.sellprice " . $item->sellprice . " sellprice $sellprice taxamount $tax_amount " .
-                      "i.linetotal $linetotal netamount " . $self->netamount . " marge_total " . $item->marge_total . " marge_percent " . $item->marge_percent);
+    my $linetotal = _round(($entry->sellprice * (1 - $entry->discount) * $qty) / $base_factor, 2);
+
+    $data->{amounts_cogs}->{ $expense_income_chart->id } -= $linetotal;
+    $data->{amounts_cogs}->{ $inventory_chart->id      } += $linetotal;
+
+    $data->{allocated}->{ $entry->id } ||= 0;
+    $data->{allocated}->{ $entry->id }  += $qty;
+    $remaining_qty                      -= $qty;
+  }
+
+  $iterator->finish;
+
+  return $remaining_qty - $total_qty;

 }
 
 sub _round {
 }
 
 sub _round {


@@ -132,7 +270,11 @@ sub _round {
 }
 
 sub _num_decimal_places {
 }
 
 sub _num_decimal_places {

-  return length( (split(/\./, '' . shift, 2))[1] || '' );
+  return length( (split(/\./, '' . ($_[0] * 1), 2))[1] || '' );
+}
+
+sub _dbg {
+  # $::lxdebug->message(0, join(' ', @_));

 }
 
 1;
 }
 
 1;


@@ -154,8 +296,10 @@ amounts and taxes of orders, quotations, invoices
 =item C<calculate_prices_and_taxes %params>
 
 Calculates the prices, amounts and taxes for an order, a quotation or
 =item C<calculate_prices_and_taxes %params>
 
 Calculates the prices, amounts and taxes for an order, a quotation or

-an invoice. The function assumes that the mixing package has a certain
-layout and provides certain functions:
+an invoice.
+
+The function assumes that the mixing package has a certain layout and
+provides certain functions:

 
 =over 2
 
 
 =over 2
 


@@ -190,10 +334,6 @@ In array context a hash with the following keys is returned:
 
 =over 2
 
 
 =over 2
 

-=item C<self>
-
-The object itself.
-

 =item C<taxes>
 
 A hash reference with the calculated taxes. The keys are chart IDs,
 =item C<taxes>
 
 A hash reference with the calculated taxes. The keys are chart IDs,


@@ -202,7 +342,49 @@ the values the calculated taxes.
 =item C<amounts>
 
 A hash reference with the calculated amounts. The keys are chart IDs,
 =item C<amounts>
 
 A hash reference with the calculated amounts. The keys are chart IDs,

-the values the calculated amounts.
+the values are hash references containing the two keys C<amount> and
+C<taxkey>.
+
+=item C<amounts_cogs>
+
+A hash reference with the calculated amounts for costs of goods
+sold. The keys are chart IDs, the values the calculated amounts.
+
+=item C<assembly_items>
+
+An array reference with as many entries as there are items in the
+record. Each entry is again an array reference of hash references with
+the keys C<part> (an instance of L<SL::DB::Part>), C<qty> and
+C<allocated>. Is only valid for invoices and can be used to populate
+the C<invoice> table with entries for assemblies.
+
+=item C<allocated>
+
+A hash reference. The keys are IDs of entries in the C<invoice>
+table. The values are the new values for the entry's C<allocated>
+column. Only valid for invoices.
+
+=item C<exchangerate>
+
+The exchangerate used for the calculation.
+
+=item C<items>
+
+An array reference. For each line item this array contains a hash ref
+entry with additional values that have been calculated for that item
+but that aren't stored in the item object itself. These include
+C<linetotal>, C<linetotal_cost>, C<sellprice>, C<tax_amount> and
+C<taxkey_id>.
+
+The items are stored in the same order the items are stored in the
+object that L</calculate_prices_and_taxes> has been called on.
+
+For example:
+
+  my $invoice     = SL::DB::Invoice->new(id => 12345)->load;
+  my %data        = $invoice->calculate_prices_and_taxes;
+
+  print "line total of second item: " . $data{items}->[1]->{linetotal};

 
 =back
 
 
 =back