PriceTaxCalculator: Doku-Fix

[kivitendo-erp.git] / SL / DB / Helper / PriceTaxCalculator.pm

diff --git a/SL/DB/Helper/PriceTaxCalculator.pm b/SL/DB/Helper/PriceTaxCalculator.pm
index a067bd4..07ad5b1 100644 (file)
--- a/SL/DB/Helper/PriceTaxCalculator.pm
+++ b/SL/DB/Helper/PriceTaxCalculator.pm
@@ -37,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);
@@ -56,7 +57,7 @@ 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 {
@@ -94,13 +95,15 @@ sub _calculate_item {
 
   $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) ? ($part->lastcost || 0) : $item->lastcost;
-    my $linetotal_cost = _round($lastcost * $item->qty / $item->marge_price_factor, 2);
+    $linetotal_cost    = _round($lastcost * $item->qty / $item->marge_price_factor, 2);
 
     $item->marge_total(  $linetotal - $linetotal_cost);
     $item->marge_percent($item->marge_total * 100 / $linetotal);
@@ -146,6 +149,14 @@ sub _calculate_item {
 
   $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);
 }
@@ -338,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