1 package SL::DB::Helper::Payment;
5 use parent qw(Exporter);
6 our @EXPORT = qw(pay_invoice);
7 our @EXPORT_OK = qw(skonto_date skonto_charts amount_less_skonto within_skonto_period percent_skonto reference_account reference_amount open_amount open_percent remaining_skonto_days skonto_amount check_skonto_configuration valid_skonto_amount get_payment_suggestions validate_payment_type open_sepa_transfer_amount get_payment_select_options_for_bank_transaction exchangerate forex);
9 "ALL" => [@EXPORT, @EXPORT_OK],
12 require SL::DB::Chart;
15 use SL::DATEV qw(:CONSTANTS);
16 use SL::Locale::String qw(t8);
17 use List::Util qw(sum);
18 use SL::DB::Exchangerate;
23 # Public functions not exported by default
27 my ($self, %params) = @_;
31 my $is_sales = ref($self) eq 'SL::DB::Invoice';
32 my $mult = $is_sales ? 1 : -1; # multiplier for getting the right sign depending on ar/ap
34 my $paid_amount = 0; # the amount that will be later added to $self->paid, should be in default currency
36 # default values if not set
37 $params{payment_type} = 'without_skonto' unless $params{payment_type};
38 validate_payment_type($params{payment_type});
40 # check for required parameters
41 Common::check_params(\%params, qw(chart_id transdate));
44 if (ref($params{transdate} eq 'DateTime')) {
45 $transdate_obj = $params{transdate};
47 $transdate_obj = $::locale->parse_date_to_object($params{transdate});
49 croak t8('Illegal date') unless ref $transdate_obj;
51 # check for closed period
52 my $closedto = $::locale->parse_date_to_object($::instance_conf->get_closedto);
53 if ( ref $closedto && $transdate_obj < $closedto ) {
54 croak t8('Cannot post payment for a closed period!');
57 # check for maximum number of future days
58 if ( $::instance_conf->get_max_future_booking_interval > 0 ) {
59 croak t8('Cannot post transaction above the maximum future booking date!') if $transdate_obj > DateTime->now->add( days => $::instance_conf->get_max_future_booking_interval );
62 # currency is either passed or use the invoice currency if it differs from the default currency
63 my ($exchangerate,$currency);
64 if ($params{currency} || $params{currency_id} || $self->currency_id != $::instance_conf->get_currency_id) {
65 if ($params{currency} || $params{currency_id} ) { # currency was specified
66 $currency = SL::DB::Manager::Currency->find_by(name => $params{currency}) || SL::DB::Manager::Currency->find_by(id => $params{currency_id});
67 } else { # use invoice currency
68 $currency = SL::DB::Manager::Currency->find_by(id => $self->currency_id);
70 die "no currency" unless $currency;
71 if ($currency->id == $::instance_conf->get_currency_id) {
74 my $rate = SL::DB::Manager::Exchangerate->find_by(currency_id => $currency->id,
75 transdate => $transdate_obj,
78 $exchangerate = $is_sales ? $rate->buy : $rate->sell;
80 die "No exchange rate for " . $transdate_obj->to_kivitendo;
83 } else { # no currency param given or currency is the same as default_currency
88 if ( $params{'payment_type'} eq 'without_skonto' ) {
89 croak "invalid amount for payment_type 'without_skonto': $params{'amount'}\n" unless abs($params{'amount'}) > 0;
92 # options with_skonto_pt and difference_as_skonto don't require the parameter
93 # amount, but if amount is passed, make sure it matches the expected value
94 if ( $params{'payment_type'} eq 'difference_as_skonto' ) {
95 croak "amount $params{amount} doesn't match open amount " . $self->open_amount . ", diff = " . ($params{amount}-$self->open_amount) if $params{amount} && abs($self->open_amount - $params{amount} ) > 0.0000001;
96 } elsif ( $params{'payment_type'} eq 'with_skonto_pt' ) {
97 croak "amount $params{amount} doesn't match amount less skonto: " . $self->amount_less_skonto . "\n" if $params{amount} && abs($self->amount_less_skonto - $params{amount} ) > 0.0000001;
98 croak "payment type with_skonto_pt can't be used if payments have already been made" if $self->paid != 0;
101 # absolute skonto amount for invoice, use as reference sum to see if the
102 # calculated skontos add up
103 # only needed for payment_term "with_skonto_pt"
105 my $skonto_amount_check = $self->skonto_amount; # variable should be zero after calculating all skonto
106 my $total_open_amount = $self->open_amount;
108 # account where money is paid to/from: bank account or cash
109 my $account_bank = SL::DB::Manager::Chart->find_by(id => $params{chart_id});
110 croak "can't find bank account with id " . $params{chart_id} unless ref $account_bank;
112 my $reference_account = $self->reference_account;
113 croak "can't find reference account (link = AR/AP) for invoice" unless ref $reference_account;
115 my $memo = $params{memo} // '';
116 my $source = $params{source} // '';
118 my $rounded_params_amount = _round( $params{amount} ); # / $exchangerate);
119 my $fx_gain_loss_amount = 0; # for fx_gain and fx_loss
122 $db->with_transaction(sub {
125 # all three payment type create 1 AR/AP booking (the paid part)
126 # difference_as_skonto creates n skonto bookings (1 for each tax type)
127 # with_skonto_pt creates 1 bank booking and n skonto bookings (1 for each tax type)
128 # without_skonto creates 1 bank booking
130 # as long as there is no automatic tax, payments are always booked with
133 unless ( $params{payment_type} eq 'difference_as_skonto' ) {
134 # cases with_skonto_pt and without_skonto
136 # for case with_skonto_pt we need to know the corrected amount at this
137 # stage if we are going to use $params{amount}
139 my $pay_amount = $rounded_params_amount;
140 $pay_amount = $self->amount_less_skonto if $params{payment_type} eq 'with_skonto_pt';
142 # bank account and AR/AP
143 $paid_amount += $pay_amount * $exchangerate;
145 my $amount = (-1 * $pay_amount) * $mult;
148 # total amount against bank, do we already know this by now?
149 $new_acc_trans = SL::DB::AccTransaction->new(trans_id => $self->id,
150 chart_id => $account_bank->id,
151 chart_link => $account_bank->link,
153 transdate => $transdate_obj,
156 project_id => $params{project_id} ? $params{project_id} : undef,
158 tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
159 $new_acc_trans->save;
161 # deal with fxtransaction
162 if ( $self->currency_id != $::instance_conf->get_currency_id ) {
163 my $fxamount = _round($amount - ($amount * $exchangerate));
164 $new_acc_trans = SL::DB::AccTransaction->new(trans_id => $self->id,
165 chart_id => $account_bank->id,
166 chart_link => $account_bank->link,
167 amount => $fxamount * -1,
168 transdate => $transdate_obj,
173 tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
174 $new_acc_trans->save;
175 # if invoice exchangerate differs from exchangerate of payment
176 # deal with fxloss and fxamount
177 if ($self->exchangerate and $self->exchangerate != 1 and $self->exchangerate != $exchangerate) {
178 my $fxgain_chart = SL::DB::Manager::Chart->find_by(id => $::instance_conf->get_fxgain_accno_id) || die "Can't determine fxgain chart";
179 my $fxloss_chart = SL::DB::Manager::Chart->find_by(id => $::instance_conf->get_fxloss_accno_id) || die "Can't determine fxloss chart";
180 my $gain_loss_amount = _round($amount * ($exchangerate - $self->exchangerate ) * -1,2);
181 my $gain_loss_chart = $gain_loss_amount > 0 ? $fxgain_chart : $fxloss_chart;
182 $fx_gain_loss_amount = $gain_loss_amount;
184 $new_acc_trans = SL::DB::AccTransaction->new(trans_id => $self->id,
185 chart_id => $gain_loss_chart->id,
186 chart_link => $gain_loss_chart->link,
187 amount => $gain_loss_amount,
188 transdate => $transdate_obj,
193 tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
194 $new_acc_trans->save;
200 if ( $params{payment_type} eq 'difference_as_skonto' or $params{payment_type} eq 'with_skonto_pt' ) {
202 my $total_skonto_amount;
203 if ( $params{payment_type} eq 'with_skonto_pt' ) {
204 $total_skonto_amount = $self->skonto_amount;
205 } elsif ( $params{payment_type} eq 'difference_as_skonto' ) {
206 $total_skonto_amount = $self->open_amount;
209 my @skonto_bookings = $self->skonto_charts($total_skonto_amount);
212 if ( $params{payment_type} eq 'difference_as_skonto' ) {
213 my $calculated_skonto_sum = sum map { $_->{skonto_amount} } @skonto_bookings;
214 croak "calculated skonto for difference_as_skonto = $calculated_skonto_sum doesn't add up open amount: " . $self->open_amount unless _round($calculated_skonto_sum) == _round($self->open_amount);
217 my $reference_amount = $total_skonto_amount;
219 # create an acc_trans entry for each result of $self->skonto_charts
220 foreach my $skonto_booking ( @skonto_bookings ) {
221 next unless $skonto_booking->{'chart_id'};
222 next unless $skonto_booking->{'skonto_amount'} != 0;
223 my $amount = -1 * $skonto_booking->{skonto_amount};
224 $new_acc_trans = SL::DB::AccTransaction->new(trans_id => $self->id,
225 chart_id => $skonto_booking->{'chart_id'},
226 chart_link => SL::DB::Manager::Chart->find_by(id => $skonto_booking->{'chart_id'})->link,
227 amount => $amount * $mult,
228 transdate => $transdate_obj,
229 source => $params{source},
231 tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
233 # the acc_trans entries are saved individually, not added to $self and then saved all at once
234 $new_acc_trans->save;
236 $reference_amount -= abs($amount);
237 $paid_amount += -1 * $amount * $exchangerate;
238 $skonto_amount_check -= $skonto_booking->{'skonto_amount'};
240 if ( $params{payment_type} eq 'difference_as_skonto' ) {
241 die "difference_as_skonto calculated incorrectly, sum of calculated payments doesn't add up to open amount $total_open_amount, reference_amount = $reference_amount\n" unless _round($reference_amount) == 0;
248 if ( $params{payment_type} eq 'difference_as_skonto' ) {
249 $arap_amount = $total_open_amount;
250 } elsif ( $params{payment_type} eq 'without_skonto' ) {
251 $arap_amount = $rounded_params_amount;
252 } elsif ( $params{payment_type} eq 'with_skonto_pt' ) {
253 # this should be amount + sum(amount+skonto), but while we only allow
254 # with_skonto_pt for completely unpaid invoices we just use the value
256 $arap_amount = $total_open_amount;
259 # regardless of payment_type there is always only exactly one arap booking
260 # TODO: compare $arap_amount to running total
261 my $arap_booking= SL::DB::AccTransaction->new(trans_id => $self->id,
262 chart_id => $reference_account->id,
263 chart_link => $reference_account->link,
264 amount => _round($arap_amount * $mult * $exchangerate - $fx_gain_loss_amount),
265 transdate => $transdate_obj,
266 source => '', #$params{source},
268 tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
271 $fx_gain_loss_amount *= -1 if $self->is_sales;
272 $self->paid($self->paid + _round($paid_amount) + $fx_gain_loss_amount) if $paid_amount;
273 $self->datepaid($transdate_obj);
276 # make sure transactions will be reloaded the next time $self->transactions
277 # is called, as pay_invoice saves the acc_trans objects individually rather
278 # than adding them to the transaction relation array.
279 $self->forget_related('transactions');
283 if ( ( $self->invoice && $::instance_conf->get_datev_check_on_sales_invoice ) ||
284 ( !$self->invoice && $::instance_conf->get_datev_check_on_ar_transaction )) {
288 if ( ( $self->invoice && $::instance_conf->get_datev_check_on_purchase_invoice ) ||
289 ( !$self->invoice && $::instance_conf->get_datev_check_on_ap_transaction )) {
294 if ( $datev_check ) {
296 my $datev = SL::DATEV->new(
298 trans_id => $self->{id},
301 $datev->generate_datev_data;
303 if ($datev->errors) {
304 # this exception should be caught by with_transaction, which handles the rollback
305 die join "\n", $::locale->text('DATEV check returned errors:'), $datev->errors;
311 }) || die t8('error while paying invoice #1 : ', $self->invnumber) . $db->error . "\n";
320 my $is_sales = ref($self) eq 'SL::DB::Invoice';
325 return undef unless ref $self->payment_terms;
326 return undef unless $self->payment_terms->terms_skonto > 0;
327 $skonto_date = DateTime->from_object(object => $self->transdate)->add(days => $self->payment_terms->terms_skonto);
329 return undef unless ref $self->vendor->payment_terms;
330 return undef unless $self->vendor->payment_terms->terms_skonto > 0;
331 $skonto_date = DateTime->from_object(object => $self->transdate)->add(days => $self->vendor->payment_terms->terms_skonto);
337 sub reference_account {
340 my $is_sales = ref($self) eq 'SL::DB::Invoice';
342 require SL::DB::Manager::AccTransaction;
344 my $link_filter = $is_sales ? 'AR' : 'AP';
346 my $acc_trans = SL::DB::Manager::AccTransaction->find_by(
347 trans_id => $self->id,
348 SL::DB::Manager::AccTransaction->chart_link_filter("$link_filter")
351 return undef unless ref $acc_trans;
353 my $reference_account = SL::DB::Manager::Chart->find_by(id => $acc_trans->chart_id);
355 return $reference_account;
358 sub reference_amount {
361 my $is_sales = ref($self) eq 'SL::DB::Invoice';
363 require SL::DB::Manager::AccTransaction;
365 my $link_filter = $is_sales ? 'AR' : 'AP';
367 my $acc_trans = SL::DB::Manager::AccTransaction->find_by(
368 trans_id => $self->id,
369 SL::DB::Manager::AccTransaction->chart_link_filter("$link_filter")
372 return undef unless ref $acc_trans;
374 # this should be the same as $self->amount
375 return $acc_trans->amount;
382 # in the future maybe calculate this from acc_trans
384 # if the difference is 0.01 Cent this may end up as 0.009999999999998
385 # numerically, so round this value when checking for cent threshold >= 0.01
387 return ($self->amount // 0) - ($self->paid // 0);
393 return 0 if $self->amount == 0;
395 if ( $self->open_amount < 0 ) {
396 # overpaid, currently treated identically
397 $open_percent = $self->open_amount * 100 / $self->amount;
399 $open_percent = $self->open_amount * 100 / $self->amount;
402 return _round($open_percent) || 0;
408 return $self->amount - $self->amount_less_skonto;
411 sub remaining_skonto_days {
414 return undef unless ref $self->skonto_date;
416 my $dur = DateTime::Duration->new($self->skonto_date - DateTime->today);
417 return $dur->delta_days();
424 my $is_sales = ref($self) eq 'SL::DB::Invoice';
426 my $percent_skonto = 0;
429 return undef unless ref $self->payment_terms;
430 return undef unless $self->payment_terms->percent_skonto > 0;
431 $percent_skonto = $self->payment_terms->percent_skonto;
433 return undef unless ref $self->vendor->payment_terms;
434 return undef unless $self->vendor->payment_terms->terms_skonto > 0;
435 $percent_skonto = $self->vendor->payment_terms->percent_skonto;
438 return $percent_skonto;
441 sub amount_less_skonto {
442 # amount that has to be paid if skonto applies, always return positive rounded values
443 # the result is rounded so we can directly compare it with the user input
446 my $is_sales = ref($self) eq 'SL::DB::Invoice';
448 my $percent_skonto = $self->percent_skonto || 0;
450 return _round($self->amount - ( $self->amount * $percent_skonto) );
454 sub check_skonto_configuration {
457 my $is_sales = ref($self) eq 'SL::DB::Invoice';
459 my $skonto_configured = 1; # default is assume skonto works
461 # my $transactions = $self->transactions;
462 foreach my $transaction (@{ $self->transactions }) {
463 # find all transactions with an AR_amount or AP_amount link
464 my $tax = SL::DB::Manager::Tax->get_first( where => [taxkey => $transaction->taxkey, id => $transaction->tax_id ]);
465 croak "no tax for taxkey " . $transaction->{taxkey} unless ref $tax;
467 $transaction->{chartlinks} = { map { $_ => 1 } split(m/:/, $transaction->chart_link) };
468 if ( $is_sales && $transaction->{chartlinks}->{AR_amount} ) {
469 $skonto_configured = 0 unless $tax->skonto_sales_chart_id;
470 } elsif ( !$is_sales && $transaction->{chartlinks}->{AP_amount}) {
471 $skonto_configured = 0 unless $tax->skonto_purchase_chart_id;
475 return $skonto_configured;
478 sub open_sepa_transfer_amount {
481 my ($vc, $key, $type);
482 if ( ref($self) eq 'SL::DB::Invoice' ) {
492 my $sql = qq|SELECT SUM(sei.amount) AS amount FROM sepa_export_items sei | .
493 qq| LEFT JOIN sepa_export se ON (sei.sepa_export_id = se.id) | .
494 qq| WHERE $key = ? AND NOT se.closed AND (se.vc = '$vc') |;
496 my ($open_sepa_amount) = $self->db->dbh->selectrow_array($sql, undef, $self->id);
498 return $open_sepa_amount || 0;
506 # TODO: use param for amount, may also want to calculate skonto_amounts by
507 # passing percentage in the future
509 my $amount = shift || $self->skonto_amount;
511 croak "no amount passed to skonto_charts" unless abs(_round($amount)) >= 0.01;
513 # TODO: check whether there are negative values in invoice / acc_trans ... credited items
515 # don't check whether skonto applies, because user may want to override this
516 # return undef unless $self->percent_skonto; # for is_sales
517 # return undef unless $self->vendor->payment_terms->percent_skonto; # for purchase
519 my $is_sales = ref($self) eq 'SL::DB::Invoice';
521 my $mult = $is_sales ? 1 : -1; # multiplier for getting the right sign
523 my @skonto_charts; # resulting array with all income/expense accounts that have to be corrected
525 # calculate effective skonto (percentage) in difference_as_skonto mode
526 # only works if there are no negative acc_trans values
527 my $effective_skonto_rate = $amount ? $amount / $self->amount : 0;
530 my $total_skonto_amount = 0;
531 my $total_rounding_error = 0;
533 my $reference_ARAP_amount = 0;
535 # my $transactions = $self->transactions;
536 foreach my $transaction (@{ $self->transactions }) {
537 # find all transactions with an AR_amount or AP_amount link
538 $transaction->{chartlinks} = { map { $_ => 1 } split(m/:/, $transaction->{chart_link}) };
539 # second condition is that we can determine an automatic Skonto account for each AR_amount entry
541 if ( ( $is_sales && $transaction->{chartlinks}->{AR_amount} ) or ( !$is_sales && $transaction->{chartlinks}->{AP_amount}) ) {
542 # $reference_ARAP_amount += $transaction->{amount} * $mult;
544 # quick hack that works around problem of non-unique tax keys in SKR04
545 # ? use tax_id in acc_trans
546 my $tax = SL::DB::Manager::Tax->get_first( where => [id => $transaction->{tax_id}]);
547 croak "no tax for taxkey " . $transaction->{taxkey} unless ref $tax;
550 die t8('no skonto_chart configured for taxkey #1 : #2 : #3', $transaction->{taxkey} , $tax->taxdescription , $tax->rate*100) unless ref $tax->skonto_sales_chart;
552 die t8('no skonto_chart configured for taxkey #1 : #2 : #3', $transaction->{taxkey} , $tax->taxdescription , $tax->rate*100) unless ref $tax->skonto_purchase_chart;
555 my $skonto_amount_unrounded;
557 my $skonto_percent_abs = $self->amount ? abs($transaction->amount * (1 + $tax->rate) * 100 / $self->amount) : 0;
559 my $transaction_amount = abs($transaction->{amount} * (1 + $tax->rate));
560 my $transaction_skonto_percent = abs($transaction_amount/$self->amount); # abs($transaction->{amount} * (1 + $tax->rate));
563 $skonto_amount_unrounded = abs($amount * $transaction_skonto_percent);
564 my $skonto_amount_rounded = _round($skonto_amount_unrounded);
565 my $rounding_error = $skonto_amount_unrounded - $skonto_amount_rounded;
566 my $rounded_rounding_error = _round($rounding_error);
568 $total_rounding_error += $rounding_error;
569 $total_skonto_amount += $skonto_amount_rounded;
572 # skonto_percent_abs: relative part of amount + tax to the total invoice amount
573 'skonto_percent_abs' => $skonto_percent_abs,
574 'chart_id' => $is_sales ? $tax->skonto_sales_chart->id : $tax->skonto_purchase_chart->id,
575 'skonto_amount' => $skonto_amount_rounded,
576 # 'rounding_error' => $rounding_error,
577 # 'rounded_rounding_error' => $rounded_rounding_error,
580 push @skonto_charts, $rec;
584 # if the rounded sum of all rounding_errors reaches 0.01 this sum is
585 # subtracted from the largest skonto_amount
586 my $rounded_total_rounding_error = abs(_round($total_rounding_error));
588 if ( $rounded_total_rounding_error > 0 ) {
589 my $highest_amount_pos = 0;
590 my $highest_amount = 0;
592 foreach my $ref ( @skonto_charts ) {
594 if ( $ref->{skonto_amount} > $highest_amount ) {
595 $highest_amount = $ref->{skonto_amount};
596 $highest_amount_pos = $i;
599 $skonto_charts[$i]->{skonto_amount} -= $rounded_total_rounding_error;
602 return @skonto_charts;
606 sub within_skonto_period {
608 my $dateref = shift || DateTime->now->truncate( to => 'day' );
610 return undef unless ref $dateref eq 'DateTime';
611 return 0 unless $self->skonto_date;
613 # return 1 if requested date (or today) is inside skonto period
614 # this will also return 1 if date is before the invoice date
615 return $dateref <= $self->skonto_date;
618 sub valid_skonto_amount {
620 my $amount = shift || 0;
621 my $max_skonto_percent = 0.10;
623 return 0 unless $amount > 0;
625 # does this work for other currencies?
626 return ($self->amount*$max_skonto_percent) > $amount;
629 sub get_payment_select_options_for_bank_transaction {
630 my ($self, $bt_id, %params) = @_;
632 my $bt = SL::DB::Manager::BankTransaction->find_by( id => $bt_id );
635 my $open_amount = $self->open_amount;
636 #$main::lxdebug->message(LXDebug->DEBUG2(),"skonto_date=".$self->skonto_date." open amount=".$open_amount);
638 if ( $open_amount && # invoice amount not 0
639 $self->skonto_date && # check whether skonto applies
640 ( abs(abs($self->amount_less_skonto) - abs($bt->amount)) < 0.01 ||
641 ( abs($self->amount_less_skonto) < abs($bt->amount) )) &&
642 $self->check_skonto_configuration) {
643 if ( $self->within_skonto_period($bt->transdate) ) {
644 push(@options, { payment_type => 'without_skonto', display => t8('without skonto') });
645 push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt'), selected => 1 });
647 push(@options, { payment_type => 'without_skonto', display => t8('without skonto') , selected => 1 });
648 push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt')});
659 return 1 if $self->currency_id == $::instance_conf->get_currency_id;
661 die "transdate isn't a DateTime object:" . ref($self->transdate) unless ref($self->transdate) eq 'DateTime';
662 my $rate = SL::DB::Manager::Exchangerate->find_by(currency_id => $self->currency_id,
663 transdate => $self->transdate,
665 return undef unless $rate;
667 return $self->is_sales ? $rate->buy : $rate->sell; # also undef if not defined
670 sub get_payment_suggestions {
672 my ($self, %params) = @_;
674 my $open_amount = $self->open_amount;
675 $open_amount -= $self->open_sepa_transfer_amount if $params{sepa};
677 $self->{invoice_amount_suggestion} = $open_amount;
678 undef $self->{payment_select_options};
679 push(@{$self->{payment_select_options}} , { payment_type => 'without_skonto', display => t8('without skonto') });
680 if ( $self->within_skonto_period ) {
681 # If there have been no payments yet suggest amount_less_skonto, otherwise the open amount
682 if ( $open_amount && # invoice amount not 0
683 $open_amount == $self->amount && # no payments yet, or sum of payments and sepa export amounts is zero
684 $self->check_skonto_configuration) {
685 $self->{invoice_amount_suggestion} = $self->amount_less_skonto;
686 push(@{$self->{payment_select_options}} , { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt') , selected => 1 });
688 if ( ( $self->valid_skonto_amount($self->open_amount) || $self->valid_skonto_amount($open_amount) ) and not $params{sepa} ) {
689 $self->{invoice_amount_suggestion} = $open_amount;
690 # only suggest difference_as_skonto if open_amount exactly matches skonto_amount
691 # AND we aren't in SEPA mode
693 $selected = 1 if _round($open_amount) == _round($self->skonto_amount);
694 push(@{$self->{payment_select_options}} , { payment_type => 'difference_as_skonto', display => t8('difference as skonto') , selected => $selected });
698 # invoice was configured with skonto, but skonto date has passed, or no skonto available
699 $self->{invoice_amount_suggestion} = $open_amount;
700 # difference_as_skonto doesn't make any sense for SEPA transfer, as this doesn't cause any actual payment
701 if ( $self->valid_skonto_amount($self->open_amount) && not $params{sepa} ) {
702 push(@{$self->{payment_select_options}} , { payment_type => 'difference_as_skonto', display => t8('difference as skonto') , selected => 0 });
708 # locales for payment type
710 # $main::locale->text('without_skonto')
711 # $main::locale->text('with_skonto_pt')
712 # $main::locale->text('difference_as_skonto')
715 sub validate_payment_type {
716 my $payment_type = shift;
718 my %allowed_payment_types = map { $_ => 1 } qw(without_skonto with_skonto_pt difference_as_skonto);
719 croak "illegal payment type: $payment_type, must be one of: " . join(' ', keys %allowed_payment_types) unless $allowed_payment_types{ $payment_type };
726 $self->currency_id == $::instance_conf->get_currency_id ? return 0 : return 1;
732 return $::form->round_amount($value, 2);
743 SL::DB::Helper::Payment Mixin providing helper methods for paying C<Invoice>
744 and C<PurchaseInvoice> objects and using skonto
748 In addition to actually causing a payment via pay_invoice this helper contains
749 many methods that help in determining information about the status of the
750 invoice, such as the remaining open amount, whether skonto applies, until which
751 date skonto applies, the skonto amount and relative percentages, what to do
754 To prevent duplicate code this was all added in this mixin rather than directly
755 in SL::DB::Invoice and SL::DB::PurchaseInvoice.
759 =item C<pay_invoice %params>
761 Create a payment booking for an existing invoice object (type ar/ap/is/ir) via
762 a configured bank account.
764 This function deals with all the acc_trans entries and also updates paid and datepaid.
768 my $ap = SL::DB::Manager::PurchaseInvoice->find_by( invnumber => '1');
769 my $bank = SL::DB::Manager::BankAccount->find_by( name => 'Bank');
770 $ap->pay_invoice(chart_id => $bank->chart_id,
771 amount => $ap->open_amount,
772 transdate => DateTime->now->to_kivitendo,
775 payment_type => 'without_skonto', # default if not specified
780 $ap->pay_invoice(chart_id => $bank->chart_id,
781 amount => $ap->amount, # doesn't need to be specified
782 transdate => DateTime->now->to_kivitendo,
785 payment_type => 'with_skonto',
788 or in a certain currency:
789 $ap->pay_invoice(chart_id => $bank->chart_id,
792 transdate => DateTime->now->to_kivitendo,
795 payment_type => 'with_skonto_pt',
798 Allowed payment types are:
799 without_skonto with_skonto_pt difference_as_skonto
801 The option C<payment_type> allows for a basic skonto mechanism.
803 C<without_skonto> is the default mode, "amount" is paid to the account in
804 chart_id. This can also be used for partial payments and corrections via
807 C<with_skonto_pt> can't be used for partial payments. When used on unpaid
808 invoices the whole amount is paid, with the skonto part automatically being
809 booked according to the skonto chart configured in the tax settings for each
810 tax key. If an amount is passed it is ignored and the actual configured skonto
813 C<difference_as_skonto> can only be used after partial payments have been made,
814 the whole specified amount is booked according to the skonto charts configured
815 in the tax settings for each tax key.
817 So passing amount doesn't have any effect for the cases C<with_skonto_pt> and
818 C<difference_as_skonto>, as all necessary values are taken from the stored
821 The skonto modes automatically calculate the relative amounts for a mix of
822 taxes, e.g. items with 7% and 19% in one invoice. There is a helper method
823 skonto_charts, which calculates the relative percentages according to the
824 amounts in acc_trans (which are grouped by tax).
826 There is currently no way of excluding certain items in an invoice from having
827 skonto applied to them. If this feature was added to parts the calculation
828 method of relative skonto would have to be completely rewritten using the
829 invoice items rather than acc_trans.
831 The skonto modes also still don't automatically correct the tax, this still has
832 to be done manually. Therefore all payments generated by pay_invoice have
835 There is currently no way to directly pay an invoice via this method if the
836 effective skonto differs from the skonto according to the payment terms
837 configured for the invoice/vendor.
839 In this case one has to pay in two steps: first the actual paid amount via
840 "without skonto", and then the remainder via "difference_as_skonto". The user
841 has to there actively decide whether to accept the differing skonto.
843 Because of the way skonto_charts works the calculation doesn't work if there
844 are negative values in acc_trans. E.g. one invoice with a positive value for
845 19% tax and a negative value for the acc_trans line with 7%
847 Skonto doesn't/shouldn't apply if the invoice contains credited items.
849 If no amount is given the whole open amout is paid.
851 If neither currency or currency_id are given as params, the currency of the
852 invoice is assumed to be the payment currency.
854 =item C<reference_account>
856 Returns a chart object which is the chart of the invoice with link AR or AP.
858 Example (1200 is the AR account for SKR04):
859 my $invoice = invoice(invnumber => '144');
860 $invoice->reference_account->accno
863 =item C<percent_skonto>
865 Returns the configured skonto percentage of the payment terms of an invoice,
866 e.g. 0.02 for 2%. Payment terms come from invoice settings for ar, from vendor
869 =item C<amount_less_skonto>
871 If the invoice has a payment term (via ar for sales, via vendor for purchase),
872 calculate the amount to be paid in the case of skonto. This doesn't check,
873 whether skonto applies (i.e. skonto doesn't wasn't exceeded), it just subtracts
874 the configured percentage (e.g. 2%) from the total amount.
876 The returned value is rounded to two decimals.
880 The date up to which skonto may be taken. This is calculated from the invoice
881 date + the number of days configured in the payment terms.
883 This method can also be used to determine whether skonto applies for the
884 invoice, as it returns undef if there is no payment term or skonto days is set
887 =item C<within_skonto_period [DATE]>
891 Checks whether the invoice has payment terms configured, and whether the date
892 is within the skonto max date. If no date is passed the current date is used.
894 You can also pass a dateref object as a parameter to check whether skonto
895 applies for that date rather than the current date.
897 =item C<valid_skonto_amount>
899 Takes an amount as an argument and checks whether the amount is less than 10%
900 of the total amount of the invoice. The value of 10% is currently hardcoded in
901 the method. This method is currently used to check whether to offer the payment
902 option "difference as skonto".
905 if ( $invoice->valid_skonto_amount($invoice->open_amount) ) {
909 =item C<skonto_charts [$amount]>
911 Returns a list of chart_ids and some calculated numbers that can be used for
912 paying the invoice with skonto. This function will automatically calculate the
913 relative skonto amounts even if the invoice contains several types of taxes
917 my $invoice = SL::DB::Manager::Invoice->find_by(invnumber => '211');
918 my @skonto_charts = $invoice->skonto_charts;
920 or with the total skonto amount as an argument:
921 my @skonto_charts = $invoice->skonto_charts($invoice->open_amount);
923 The following values are generated for each chart:
929 The chart id of the skonto amount to be booked.
931 =item C<skonto_amount>
933 The total amount to be paid to the account
935 =item C<skonto_percent>
937 The relative percentage of that skonto chart. This can be useful if the actual
938 ekonto that is paid deviates from the granted skonto, e.g. customer effectively
939 pays 2.6% skonto instead of 2%, and we accept this. Then we can still calculate
940 the relative skonto amounts for different taxes based on the absolute
941 percentages. Used for case C<difference_as_skonto>.
943 =item C<skonto_percent_abs>
945 The absolute percentage of that skonto chart in relation to the total amount.
946 Used to calculate skonto_amount for case C<with_skonto_pt>.
950 If the invoice contains several types of taxes then skonto_charts can be used
951 to calculate the relative amounts.
953 Example in console of an invoice with 100 Euro at 7% and 100 Euro at 19% with
956 my $invoice = invoice(invnumber => '144');
959 $invoice->payment_terms->percent_skonto
961 $invoice->skonto_charts
962 pp $invoice->skonto_charts
965 # 'skonto_amount' => '2.14',
966 # 'skonto_percent' => '47.3451327433627'
970 # 'skonto_amount' => '2.38',
971 # 'skonto_percent' => '52.654867256637'
974 C<skonto_charts> always returns positive values (abs) for C<skonto_amount> and
977 C<skonto_charts> generates one entry for each acc_trans entry. ar and ap
978 bookings only have one acc_trans entry for each taxkey (e.g. 7% and 19%). This
979 is because all the items are grouped according to the Buchungsgruppen mechanism
980 and the totals are written to acc_trans. For is and ir it is possible to have
981 several acc_trans entries with the same tax. In this case skonto_charts
982 generates a skonto booking for each acc_trans income/expense entry.
984 In the future this function may also be used to calculate the corrections for
989 Unrounded total open amount of invoice (amount - paid).
990 Doesn't take into account pending SEPA transfers.
992 =item C<open_percent>
994 Percentage of the invoice that is still unpaid, e.g. 100,00 if no payments have
995 been made yet, 0,00 if fully paid.
997 =item C<remaining_skonto_days>
999 How many days skonto can still be taken, calculated from current day. Returns 0
1000 if current day is the max skonto date, and negative number if skonto date has
1003 Returns undef if skonto is not configured for that invoice.
1005 =item C<get_payment_suggestions %params>
1007 Creates data intended for an L.select_tag dropdown that can be used in a
1008 template. Depending on the rules it will choose from the options
1009 without_skonto, with_skonto_pt and difference_as_skonto, and select the most
1012 If the parameter "sepa" is passed, the SEPA export payments that haven't been
1013 executed yet are considered when determining the open amount of the invoice.
1015 The current rules are:
1019 =item * without_skonto is always an option
1021 =item * with_skonto_pt is only offered if there haven't been any payments yet and the current date is within the skonto period.
1023 =item * difference_as_skonto is only offered if there have already been payments made and the open amount is smaller than 10% of the total amount.
1025 with_skonto_pt will only be offered, if all the AR_amount/AP_amount have a
1026 taxkey with a configured skonto chart
1030 It will also fill $self->{invoice_amount_suggestion} with either the open
1031 amount, or if with_skonto_pt is selected, with amount_less_skonto, so the
1032 template can fill the input with the likely amount.
1035 my $ar = invoice( invnumber => '257');
1036 $ar->get_payment_suggestions;
1037 print $ar->{invoice_amount_suggestion} . "\n";
1039 pp $ar->{payment_select_options}
1042 # 'display' => 'ohne Skonto',
1043 # 'payment_type' => 'without_skonto'
1046 # 'display' => 'mit Skonto nach ZB',
1047 # 'payment_type' => 'with_skonto_pt',
1052 The resulting array $ar->{payment_select_options} can be used in a template
1053 select_tag using value_key and title_key:
1055 [% L.select_tag('payment_type_' _ loop.count, invoice.payment_select_options, value_key => 'payment_type', title_key => 'display', id => 'payment_type_' _ loop.count) %]
1057 It would probably make sense to have different rules for the pre-selected items
1058 for sales and purchase, and to also make these rules configurable in the
1059 defaults. E.g. when creating a SEPA bank transfer for vendor invoices a company
1060 might always want to pay quickly making use of skonto, while another company
1061 might always want to pay as late as possible.
1063 =item C<get_payment_select_options_for_bank_transaction $banktransaction_id %params>
1065 Make suggestion for a skonto payment type by returning an HTML blob of the options
1066 of a HTML drop-down select with the most likely option preselected.
1068 This is a helper function for BankTransaction/ajax_payment_suggestion.
1070 We are working with an existing payment, so difference_as_skonto never makes sense.
1072 If skonto is possible (skonto_date exists), add two possibilities:
1073 without_skonto and with_skonto_pt if payment date is within skonto_date,
1074 preselect with_skonto_pt, otherwise preselect without skonto.
1076 =item C<exchangerate>
1078 Returns 1 immediately if the record uses the default currency.
1080 Returns the exchangerate in database format for the invoice according to that
1081 invoice's transdate, returning 'buy' for sales, 'sell' for purchases.
1083 If no exchangerate can be found for that day undef is returned.
1087 Returns 1 if record uses a different currency, 0 if the default currency is used.
1091 =head1 TODO AND CAVEATS
1097 when looking at open amount, maybe consider that there may already be queued
1098 amounts in SEPA Export
1104 G. Richardson E<lt>grichardson@kivitendo-premium.de<gt>