1 package SL::DB::Helper::PriceTaxCalculator;
5 use parent qw(Exporter);
6 our @EXPORT = qw(calculate_prices_and_taxes);
9 use List::Util qw(sum min);
11 use SL::DB::PriceFactor;
14 sub calculate_prices_and_taxes {
15 my ($self, %params) = @_;
17 my %units_by_name = map { ( $_->name => $_ ) } @{ SL::DB::Manager::Unit->get_all };
18 my %price_factors_by_id = map { ( $_->id => $_ ) } @{ SL::DB::Manager::PriceFactor->get_all };
20 my %data = ( lastcost_total => 0,
22 last_incex_chart_id => undef,
23 units_by_name => \%units_by_name,
24 price_factors_by_id => \%price_factors_by_id,
29 assembly_items => [ ],
30 exchangerate => undef,
31 is_sales => $self->can('customer') && $self->customer,
32 is_invoice => (ref($self) =~ /Invoice/) || $params{invoice},
35 _get_exchangerate($self, \%data, %params);
38 $self->marge_total(0);
41 foreach my $item ($self->items) {
43 _calculate_item($self, $item, $idx, \%data, %params);
46 _calculate_amounts($self, \%data, %params);
48 return $self unless wantarray;
50 return map { ($_ => $data{$_}) } qw(taxes amounts amounts_cogs allocated exchangerate assembly_items);
53 sub _get_exchangerate {
54 my ($self, $data, %params) = @_;
56 if (($self->curr || '') ne SL::DB::Default->get_default_currency) {
57 $data->{exchangerate} = $::form->check_exchangerate(\%::myconfig, $self->curr, $self->transdate, $data->{is_sales} ? 'buy' : 'sell');
58 $data->{exchangerate} ||= $params{exchangerate};
60 $data->{exchangerate} ||= 1;
64 my ($self, $item, $idx, $data, %params) = @_;
66 my $part_unit = $data->{units_by_name}->{ $item->part->unit };
67 my $item_unit = $data->{units_by_name}->{ $item->unit };
69 croak("Undefined unit " . $item->part->unit) if !$part_unit;
70 croak("Undefined unit " . $item->unit) if !$item_unit;
72 $item->base_qty($item_unit->convert_to($item->qty, $part_unit));
73 $item->fxsellprice($item->sellprice) if $data->{is_invoice};
75 my $num_dec = _num_decimal_places($item->sellprice);
76 my $discount = _round($item->sellprice * ($item->discount || 0), $num_dec);
77 my $sellprice = _round($item->sellprice - $discount, $num_dec);
79 $item->price_factor( ! $item->price_factor_obj ? 1 : ($item->price_factor_obj->factor || 1));
80 $item->marge_price_factor(! $item->part->price_factor ? 1 : ($item->part->price_factor->factor || 1));
81 my $linetotal = _round($sellprice * $item->qty / $item->price_factor, 2) * $data->{exchangerate};
82 $linetotal = _round($linetotal, 2);
84 $data->{invoicediff} += $sellprice * $item->qty * $data->{exchangerate} / $item->price_factor - $linetotal if $self->taxincluded;
87 $item->marge_total( 0);
88 $item->marge_percent(0);
91 my $lastcost = ! ($item->lastcost * 1) ? ($item->part->lastcost || 0) : $item->lastcost;
93 $item->marge_total( $linetotal - $lastcost / $item->marge_price_factor);
94 $item->marge_percent($item->marge_total * 100 / $linetotal);
96 $self->marge_total( $self->marge_total + $item->marge_total);
97 $data->{lastcost_total} += $lastcost;
100 my $taxkey = $item->part->get_taxkey(date => $self->transdate, is_sales => $data->{is_sales}, taxzone => $self->taxzone_id);
101 my $tax_rate = $taxkey->tax->rate;
102 my $tax_amount = undef;
104 if ($self->taxincluded) {
105 $tax_amount = $linetotal * $tax_rate / ($tax_rate + 1);
106 $sellprice = $sellprice / ($tax_rate + 1);
109 $tax_amount = $linetotal * $tax_rate;
112 if ($taxkey->tax->chart_id) {
113 $data->{taxes}->{ $taxkey->tax->chart_id } ||= 0;
114 $data->{taxes}->{ $taxkey->tax->chart_id } += $tax_amount;
115 } elsif ($tax_amount) {
116 die "tax_amount != 0 but no chart_id for taxkey " . $taxkey->id . " tax " . $taxkey->tax->id;
119 $self->netamount($self->netamount + $sellprice * $item->qty / $item->price_factor);
121 my $chart = $item->part->get_chart(type => $data->{is_sales} ? 'income' : 'expense', taxzone => $self->taxzone_id);
122 $data->{amounts}->{ $chart->id } ||= { taxkey => $taxkey->taxkey_id, tax_id => $taxkey->tax_id, amount => 0 };
123 $data->{amounts}->{ $chart->id }->{amount} += $linetotal;
125 push @{ $data->{assembly_items} }, [];
126 if ($item->part->is_assembly) {
127 _calculate_assembly_item($self, $data, $item->part, $item->base_qty, $item->unit_obj->convert_to(1, $item->part->unit_obj));
128 } elsif ($item->part->is_part) {
129 if ($data->{is_invoice}) {
130 $item->allocated(_calculate_part_item($self, $data, $item->part, $item->base_qty, $item->unit_obj->convert_to(1, $item->part->unit_obj)));
134 $data->{last_incex_chart_id} = $chart->id if $data->{is_sales};
136 _dbg("CALCULATE! ${idx} i.qty " . $item->qty . " i.sellprice " . $item->sellprice . " sellprice $sellprice num_dec $num_dec taxamount $tax_amount " .
137 "i.linetotal $linetotal netamount " . $self->netamount . " marge_total " . $item->marge_total . " marge_percent " . $item->marge_percent);
140 sub _calculate_amounts {
141 my ($self, $data, %params) = @_;
144 foreach my $chart_id (keys %{ $data->{taxes} }) {
145 my $rounded = _round($data->{taxes}->{$chart_id} * $data->{exchangerate}, 2);
146 $tax_diff += $data->{taxes}->{$chart_id} * $data->{exchangerate} - $rounded if $self->taxincluded;
147 $data->{taxes}->{$chart_id} = $rounded;
150 my $amount = _round(($self->netamount + $tax_diff) * $data->{exchangerate}, 2);
151 my $diff = $amount - ($self->netamount + $tax_diff) * $data->{exchangerate};
152 my $netamount = $amount;
154 if ($self->taxincluded) {
155 $data->{invoicediff} += $diff;
156 $data->{amounts}->{ $data->{last_incex_chart_id} }->{amount} += $data->{invoicediff} if $data->{last_incex_chart_id};
159 _dbg("Sna " . $self->netamount . " idiff " . $data->{invoicediff} . " tdiff ${tax_diff}");
161 my $tax = sum values %{ $data->{taxes} };
162 $data->{arap_amount} = $netamount + $tax;
164 $self->netamount( $netamount);
165 $self->amount( $netamount + $tax);
166 $self->marge_percent($self->netamount ? ($self->netamount - $data->{lastcost_total}) * 100 / $self->netamount : 0);
169 sub _calculate_assembly_item {
170 my ($self, $data, $part, $total_qty, $base_factor) = @_;
172 return 0 if $::instance_conf->get_inventory_system eq 'periodic' || !$data->{is_invoice};
174 foreach my $assembly_entry (@{ $part->assemblies }) {
175 push @{ $data->{assembly_items}->[-1] }, { part => $assembly_entry->part,
176 qty => $total_qty * $assembly_entry->qty,
179 if ($assembly_entry->part->is_assembly) {
180 _calculate_assembly_item($self, $data, $assembly_entry->part, $total_qty * $assembly_entry->qty);
181 } elsif ($assembly_entry->part->is_part) {
182 my $allocated = _calculate_part_item($self, $data, $assembly_entry->part, $total_qty * $assembly_entry->qty);
183 $data->{assembly_items}->[-1]->[-1]->{allocated} = $allocated;
188 sub _calculate_part_item {
189 my ($self, $data, $part, $total_qty, $base_factor) = @_;
191 _dbg("cpsi tq " . $total_qty);
193 return 0 if $::instance_conf->get_inventory_system eq 'periodic' || !$data->{is_invoice} || !$total_qty;
197 my $remaining_qty = $total_qty;
198 my $expense_income_chart = $part->get_chart(type => $data->{is_sales} ? 'expense' : 'income', taxzone => $self->taxzone_id);
199 my $inventory_chart = $part->get_chart(type => 'inventory', taxzone => $self->taxzone_id);
201 my $iterator = SL::DB::Manager::InvoiceItem->get_all_iterator(query => [ and => [ parts_id => $part->id,
202 \'(base_qty + allocated) < 0' ] ]);
204 while (($remaining_qty > 0) && ($entry = $iterator->next)) {
205 my $qty = min($remaining_qty, $entry->base_qty * -1 - $entry->allocated - $data->{allocated}->{ $entry->id });
210 my $linetotal = _round(($entry->sellprice * $qty) / $base_factor, 2);
212 $data->{amounts_cogs}->{ $expense_income_chart->id } -= $linetotal;
213 $data->{amounts_cogs}->{ $inventory_chart->id } += $linetotal;
215 $data->{allocated}->{ $entry->id } ||= 0;
216 $data->{allocated}->{ $entry->id } += $qty;
217 $remaining_qty -= $qty;
222 return $remaining_qty - $total_qty;
226 return $::form->round_amount(@_);
229 sub _num_decimal_places {
230 return length( (split(/\./, '' . ($_[0] * 1), 2))[1] || '' );
234 # $::lxdebug->message(0, join(' ', @_));
246 SL::DB::Helper::PriceTaxCalculator - Mixin for calculating the prices,
247 amounts and taxes of orders, quotations, invoices
253 =item C<calculate_prices_and_taxes %params>
255 Calculates the prices, amounts and taxes for an order, a quotation or
258 The function assumes that the mixing package has a certain layout and
259 provides certain functions:
267 =item C<customer> or C<vendor>
269 Determines if the record is a sales or purchase record.
273 Accessor returning all line items for this record. The line items
274 themselves must again have a certain layout. Instances of
275 L<SL::DB::OrderItem> and L<SL::DB::InvoiceItem> are supported.
279 The following values are calculated and set for C<$self>: C<amount>,
280 C<netamount>, C<marge_percent>, C<marge_total>.
282 The following values are calculated and set for each line item:
283 C<base_qty>, C<price_factor>, C<marge_price_factor>, C<marge_total>,
286 The objects are not saved.
288 Returns C<$self> in scalar context.
290 In array context a hash with the following keys is returned:
296 A hash reference with the calculated taxes. The keys are chart IDs,
297 the values the calculated taxes.
301 A hash reference with the calculated amounts. The keys are chart IDs,
302 the values are hash references containing the two keys C<amount> and
305 =item C<amounts_cogs>
307 A hash reference with the calculated amounts for costs of goods
308 sold. The keys are chart IDs, the values the calculated amounts.
310 =item C<assembly_items>
312 An array reference with as many entries as there are items in the
313 record. Each entry is again an array reference of hash references with
314 the keys C<part> (an instance of L<SL::DB::Part>), C<qty> and
315 C<allocated>. Is only valid for invoices and can be used to populate
316 the C<invoice> table with entries for assemblies.
320 A hash reference. The keys are IDs of entries in the C<invoice>
321 table. The values are the new values for the entry's C<allocated>
322 column. Only valid for invoices.
324 =item C<exchangerate>
326 The exchangerate used for the calculation.
338 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>