Neue Methoden um Debitorenbuchungen zu erstellen
[kivitendo-erp.git] / SL / DB / Helper / PriceTaxCalculator.pm
index 026322d..44c6511 100644 (file)
@@ -3,10 +3,10 @@ package SL::DB::Helper::PriceTaxCalculator;
 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 List::Util qw(sum min);
+use List::Util qw(sum min max);
 
 sub calculate_prices_and_taxes {
   my ($self, %params) = @_;
@@ -19,7 +19,7 @@ sub calculate_prices_and_taxes {
   require SL::DB::PriceFactor;
   require SL::DB::Unit;
 
-  SL::DB::Part->load_cached(map { $_->parts_id } @{ $self->items });
+  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 };
@@ -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 {
@@ -74,6 +75,8 @@ sub _calculate_item {
   my ($self, $item, $idx, $data, %params) = @_;
 
   my $part       = SL::DB::Part->load_cached($item->parts_id);
+  return unless $item->part;
+
   my $part_unit  = $data->{units_by_name}->{ $part->unit };
   my $item_unit  = $data->{units_by_name}->{ $item->unit };
 
@@ -83,14 +86,7 @@ sub _calculate_item {
   $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) || 2;
-  #  ^ we need at least 2 decimal places                   ^
-  # my test case 43.00 € with 0 decimal places and 0.5 discount ->
-  # : sellprice before:43.00000
-  # : num dec   before:0
-  # : discount / sellprice ratio:  22  /  21
-  # : discount = 43 * 0.5 _round(21.5, 0) = 22
-  # TODO write a test case
+  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);
 
@@ -101,13 +97,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);
@@ -153,6 +151,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);
 }
@@ -345,6 +351,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