PriceTaxCalculator: Doku-Fix
[kivitendo-erp.git] / SL / DB / Helper / PriceTaxCalculator.pm
index 73613f8..07ad5b1 100644 (file)
@@ -6,14 +6,21 @@ use parent qw(Exporter);
 our @EXPORT = qw(calculate_prices_and_taxes);
 
 use Carp;
-use List::Util qw(sum min);
-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) = @_;
 
+  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 };
 
@@ -30,6 +37,7 @@ sub calculate_prices_and_taxes {
                exchangerate        => undef,
                is_sales            => $self->can('customer') && $self->customer,
                is_invoice          => (ref($self) =~ /Invoice/) || $params{invoice},
+               items               => [ ],
              );
 
   _get_exchangerate($self, \%data, %params);
@@ -37,6 +45,8 @@ sub calculate_prices_and_taxes {
   $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++;
@@ -47,13 +57,13 @@ sub calculate_prices_and_taxes {
 
   return $self unless wantarray;
 
-  return map { ($_ => $data{$_}) } qw(taxes amounts amounts_cogs allocated exchangerate assembly_items);
+  return map { ($_ => $data{$_}) } qw(taxes amounts amounts_cogs allocated exchangerate assembly_items items);
 }
 
 sub _get_exchangerate {
   my ($self, $data, %params) = @_;
 
-  my $currency = $self->currency_id ? $self->currency->name || '' : '';
+  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};
@@ -64,41 +74,45 @@ sub _get_exchangerate {
 sub _calculate_item {
   my ($self, $item, $idx, $data, %params) = @_;
 
-  my $part_unit  = $data->{units_by_name}->{ $item->part->unit };
-  my $item_unit  = $data->{units_by_name}->{ $item->unit       };
+  my $part       = SL::DB::Part->load_cached($item->parts_id);
+  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 " . $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->fxsellprice($item->sellprice) if $data->{is_invoice};
 
-  my $num_dec   = _num_decimal_places($item->sellprice);
+  my $num_dec   = max 2, _num_decimal_places($item->sellprice);
   my $discount  = _round($item->sellprice * ($item->discount || 0), $num_dec);
   my $sellprice = _round($item->sellprice - $discount,              $num_dec);
 
   $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));
+  $item->marge_price_factor(! $part->price_factor ? 1 : ($part->price_factor->factor || 1));
   my $linetotal = _round($sellprice * $item->qty / $item->price_factor, 2) * $data->{exchangerate};
   $linetotal    = _round($linetotal,                                    2);
 
   $data->{invoicediff} += $sellprice * $item->qty * $data->{exchangerate} / $item->price_factor - $linetotal if $self->taxincluded;
 
+  my $linetotal_cost = 0;
+
   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 * 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);
-    $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;
 
@@ -119,21 +133,30 @@ sub _calculate_item {
 
   $self->netamount($self->netamount + $sellprice * $item->qty / $item->price_factor);
 
-  my $chart = $item->part->get_chart(type => $data->{is_sales} ? 'income' : 'expense', taxzone => $self->taxzone_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 ($item->part->is_assembly) {
-    _calculate_assembly_item($self, $data, $item->part, $item->base_qty, $item->unit_obj->convert_to(1, $item->part->unit_obj));
-  } elsif ($item->part->is_part) {
+  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, $item->part, $item->base_qty, $item->unit_obj->convert_to(1, $item->part->unit_obj)));
+      $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};
 
+  push @{ $data->{items} }, {
+    linetotal      => $linetotal,
+    linetotal_cost => $linetotal_cost,
+    sellprice      => $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);
 }
@@ -326,6 +349,24 @@ column. Only valid for invoices.
 
 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