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 and optional params depending on payment_type
41 Common::check_params(\%params, qw(chart_id transdate));
42 if ( $params{'payment_type'} eq 'without_skonto' && abs($params{'amount'}) < 0) {
43 croak "invalid amount for payment_type 'without_skonto': $params{'amount'}\n";
45 if ($params{'payment_type'} eq 'free_skonto') {
46 # we dont like too much automagic for this payment type.
47 # we force caller input for amount and skonto amount
48 Common::check_params(\%params, qw(amount skonto_amount));
49 # secondly we dont want to handle credit notes and purchase credit notes
50 croak("Cannot use 'free skonto' for credit or debit notes") if ($params{amount} <= 0 || $params{skonto_amount} <= 0);
51 # both amount have to be rounded
52 $params{skonto_amount} = _round($params{skonto_amount});
53 $params{amount} = _round($params{amount});
54 # lastly skonto_amount has to be smaller than the open invoice amount or payment amount ;-)
55 if ($params{skonto_amount} > abs($self->open_amount) || $params{skonto_amount} > $params{amount}) {
56 croak("Skonto amount higher than the payment or invoice amount");
61 if (ref($params{transdate}) eq 'DateTime') {
62 $transdate_obj = $params{transdate};
64 $transdate_obj = $::locale->parse_date_to_object($params{transdate});
66 croak t8('Illegal date') unless ref $transdate_obj;
68 # check for closed period
69 my $closedto = $::locale->parse_date_to_object($::instance_conf->get_closedto);
70 if ( ref $closedto && $transdate_obj < $closedto ) {
71 croak t8('Cannot post payment for a closed period!');
74 # check for maximum number of future days
75 if ( $::instance_conf->get_max_future_booking_interval > 0 ) {
76 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 );
79 # currency is either passed or use the invoice currency if it differs from the default currency
80 my ($exchangerate,$currency);
81 if ($params{currency} || $params{currency_id} || $self->currency_id != $::instance_conf->get_currency_id) {
82 if ($params{currency} || $params{currency_id} ) { # currency was specified
83 $currency = SL::DB::Manager::Currency->find_by(name => $params{currency}) || SL::DB::Manager::Currency->find_by(id => $params{currency_id});
84 } else { # use invoice currency
85 $currency = SL::DB::Manager::Currency->find_by(id => $self->currency_id);
87 die "no currency" unless $currency;
88 if ($currency->id == $::instance_conf->get_currency_id) {
91 my $rate = SL::DB::Manager::Exchangerate->find_by(currency_id => $currency->id,
92 transdate => $transdate_obj,
95 $exchangerate = $is_sales ? $rate->buy : $rate->sell;
97 die "No exchange rate for " . $transdate_obj->to_kivitendo;
100 } else { # no currency param given or currency is the same as default_currency
104 # options with_skonto_pt and difference_as_skonto don't require the parameter
105 # amount, but if amount is passed, make sure it matches the expected value
106 if ( $params{'payment_type'} eq 'difference_as_skonto' ) {
107 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;
108 } elsif ( $params{'payment_type'} eq 'with_skonto_pt' ) {
109 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;
110 croak "payment type with_skonto_pt can't be used if payments have already been made" if $self->paid != 0;
113 # absolute skonto amount for invoice, use as reference sum to see if the
114 # calculated skontos add up
115 # only needed for payment_term "with_skonto_pt"
117 my $skonto_amount_check = $self->skonto_amount; # variable should be zero after calculating all skonto
118 my $total_open_amount = $self->open_amount;
120 # account where money is paid to/from: bank account or cash
121 my $account_bank = SL::DB::Manager::Chart->find_by(id => $params{chart_id});
122 croak "can't find bank account with id " . $params{chart_id} unless ref $account_bank;
124 my $reference_account = $self->reference_account;
125 croak "can't find reference account (link = AR/AP) for invoice" unless ref $reference_account;
127 my $memo = $params{memo} // '';
128 my $source = $params{source} // '';
130 my $rounded_params_amount = _round( $params{amount} ); # / $exchangerate);
131 my $fx_gain_loss_amount = 0; # for fx_gain and fx_loss
134 $db->with_transaction(sub {
137 # all three payment type create 1 AR/AP booking (the paid part)
138 # difference_as_skonto creates n skonto bookings (1 for each buchungsgruppe type)
139 # with_skonto_pt creates 1 bank booking and n skonto bookings (1 for each buchungsgruppe type)
140 # without_skonto creates 1 bank booking
142 # as long as there is no automatic tax, payments are always booked with
145 unless ( $params{payment_type} eq 'difference_as_skonto' ) {
146 # cases with_skonto_pt, free_skonto and without_skonto
148 # for case with_skonto_pt we need to know the corrected amount at this
149 # stage if we are going to use $params{amount}
151 my $pay_amount = $rounded_params_amount;
152 $pay_amount = $self->amount_less_skonto if $params{payment_type} eq 'with_skonto_pt';
154 # bank account and AR/AP
155 $paid_amount += $pay_amount * $exchangerate;
157 my $amount = (-1 * $pay_amount) * $mult;
160 # total amount against bank, do we already know this by now?
161 $new_acc_trans = SL::DB::AccTransaction->new(trans_id => $self->id,
162 chart_id => $account_bank->id,
163 chart_link => $account_bank->link,
165 transdate => $transdate_obj,
168 project_id => $params{project_id} ? $params{project_id} : undef,
170 tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
171 $new_acc_trans->save;
173 push @new_acc_ids, $new_acc_trans->acc_trans_id;
174 # deal with fxtransaction
175 if ( $self->currency_id != $::instance_conf->get_currency_id ) {
176 my $fxamount = _round($amount - ($amount * $exchangerate));
177 $new_acc_trans = SL::DB::AccTransaction->new(trans_id => $self->id,
178 chart_id => $account_bank->id,
179 chart_link => $account_bank->link,
180 amount => $fxamount * -1,
181 transdate => $transdate_obj,
186 tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
187 $new_acc_trans->save;
188 push @new_acc_ids, $new_acc_trans->acc_trans_id;
189 # if invoice exchangerate differs from exchangerate of payment
190 # deal with fxloss and fxamount
191 if ($self->exchangerate and $self->exchangerate != 1 and $self->exchangerate != $exchangerate) {
192 my $fxgain_chart = SL::DB::Manager::Chart->find_by(id => $::instance_conf->get_fxgain_accno_id) || die "Can't determine fxgain chart";
193 my $fxloss_chart = SL::DB::Manager::Chart->find_by(id => $::instance_conf->get_fxloss_accno_id) || die "Can't determine fxloss chart";
194 my $gain_loss_amount = _round($amount * ($exchangerate - $self->exchangerate ) * -1,2);
195 my $gain_loss_chart = $gain_loss_amount > 0 ? $fxgain_chart : $fxloss_chart;
196 $fx_gain_loss_amount = $gain_loss_amount;
198 $new_acc_trans = SL::DB::AccTransaction->new(trans_id => $self->id,
199 chart_id => $gain_loss_chart->id,
200 chart_link => $gain_loss_chart->link,
201 amount => $gain_loss_amount,
202 transdate => $transdate_obj,
207 tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
208 $new_acc_trans->save;
209 push @new_acc_ids, $new_acc_trans->acc_trans_id;
214 # better everything except without_skonto
215 if ($params{payment_type} eq 'difference_as_skonto' or $params{payment_type} eq 'with_skonto_pt'
216 or $params{payment_type} eq 'free_skonto' ) {
218 my $total_skonto_amount;
219 if ( $params{payment_type} eq 'with_skonto_pt' ) {
220 $total_skonto_amount = $self->skonto_amount;
221 } elsif ( $params{payment_type} eq 'difference_as_skonto' ) {
222 $total_skonto_amount = $self->open_amount;
223 } elsif ( $params{payment_type} eq 'free_skonto') {
224 $total_skonto_amount = $params{skonto_amount};
226 my @skonto_bookings = $self->skonto_charts($total_skonto_amount);
229 if ( $params{payment_type} eq 'difference_as_skonto' ) {
230 my $calculated_skonto_sum = sum map { $_->{skonto_amount} } @skonto_bookings;
231 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);
234 my $reference_amount = $total_skonto_amount;
236 # create an acc_trans entry for each result of $self->skonto_charts
237 foreach my $skonto_booking ( @skonto_bookings ) {
238 next unless $skonto_booking->{'chart_id'};
239 next unless $skonto_booking->{'skonto_amount'} != 0;
240 my $amount = -1 * $skonto_booking->{skonto_amount};
241 $new_acc_trans = SL::DB::AccTransaction->new(trans_id => $self->id,
242 chart_id => $skonto_booking->{'chart_id'},
243 chart_link => SL::DB::Manager::Chart->find_by(id => $skonto_booking->{'chart_id'})->link,
244 amount => $amount * $mult,
245 transdate => $transdate_obj,
246 source => $params{source},
248 tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
250 # the acc_trans entries are saved individually, not added to $self and then saved all at once
251 $new_acc_trans->save;
252 push @new_acc_ids, $new_acc_trans->acc_trans_id;
254 $reference_amount -= abs($amount);
255 $paid_amount += -1 * $amount * $exchangerate;
256 $skonto_amount_check -= $skonto_booking->{'skonto_amount'};
258 if ( $params{payment_type} eq 'difference_as_skonto' ) {
259 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;
265 if ( $params{payment_type} eq 'difference_as_skonto' ) {
266 $arap_amount = $total_open_amount;
267 } elsif ( $params{payment_type} eq 'without_skonto' ) {
268 $arap_amount = $rounded_params_amount;
269 } elsif ( $params{payment_type} eq 'with_skonto_pt' ) {
270 # this should be amount + sum(amount+skonto), but while we only allow
271 # with_skonto_pt for completely unpaid invoices we just use the value
273 $arap_amount = $total_open_amount;
274 } elsif ( $params{payment_type} eq 'free_skonto' ) {
275 # we forced positive values and forced rounding at the beginning
276 # therefore the above comment can be safely applied for this payment type
277 $arap_amount = $params{amount} + $params{skonto_amount};
280 # regardless of payment_type there is always only exactly one arap booking
281 # TODO: compare $arap_amount to running total
282 my $arap_booking= SL::DB::AccTransaction->new(trans_id => $self->id,
283 chart_id => $reference_account->id,
284 chart_link => $reference_account->link,
285 amount => _round($arap_amount * $mult * $exchangerate - $fx_gain_loss_amount),
286 transdate => $transdate_obj,
287 source => '', #$params{source},
289 tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
291 push @new_acc_ids, $arap_booking->acc_trans_id;
293 $fx_gain_loss_amount *= -1 if $self->is_sales;
294 $self->paid($self->paid + _round($paid_amount) + $fx_gain_loss_amount) if $paid_amount;
295 $self->datepaid($transdate_obj);
298 # make sure transactions will be reloaded the next time $self->transactions
299 # is called, as pay_invoice saves the acc_trans objects individually rather
300 # than adding them to the transaction relation array.
301 $self->forget_related('transactions');
305 if ( ( $self->invoice && $::instance_conf->get_datev_check_on_sales_invoice ) ||
306 ( !$self->invoice && $::instance_conf->get_datev_check_on_ar_transaction )) {
310 if ( ( $self->invoice && $::instance_conf->get_datev_check_on_purchase_invoice ) ||
311 ( !$self->invoice && $::instance_conf->get_datev_check_on_ap_transaction )) {
316 if ( $datev_check ) {
318 my $datev = SL::DATEV->new(
320 trans_id => $self->{id},
323 $datev->generate_datev_data;
325 if ($datev->errors) {
326 # this exception should be caught by with_transaction, which handles the rollback
327 die join "\n", $::locale->text('DATEV check returned errors:'), $datev->errors;
333 }) || die t8('error while paying invoice #1 : ', $self->invnumber) . $db->error . "\n";
334 return wantarray ? @new_acc_ids : 1;
341 my $is_sales = ref($self) eq 'SL::DB::Invoice';
346 return undef unless ref $self->payment_terms;
347 return undef unless $self->payment_terms->terms_skonto > 0;
348 $skonto_date = DateTime->from_object(object => $self->transdate)->add(days => $self->payment_terms->terms_skonto);
350 return undef unless ref $self->vendor->payment_terms;
351 return undef unless $self->vendor->payment_terms->terms_skonto > 0;
352 $skonto_date = DateTime->from_object(object => $self->transdate)->add(days => $self->vendor->payment_terms->terms_skonto);
358 sub reference_account {
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 my $reference_account = SL::DB::Manager::Chart->find_by(id => $acc_trans->chart_id);
376 return $reference_account;
379 sub reference_amount {
382 my $is_sales = ref($self) eq 'SL::DB::Invoice';
384 require SL::DB::Manager::AccTransaction;
386 my $link_filter = $is_sales ? 'AR' : 'AP';
388 my $acc_trans = SL::DB::Manager::AccTransaction->find_by(
389 trans_id => $self->id,
390 SL::DB::Manager::AccTransaction->chart_link_filter("$link_filter")
393 return undef unless ref $acc_trans;
395 # this should be the same as $self->amount
396 return $acc_trans->amount;
403 # in the future maybe calculate this from acc_trans
405 # if the difference is 0.01 Cent this may end up as 0.009999999999998
406 # numerically, so round this value when checking for cent threshold >= 0.01
408 return ($self->amount // 0) - ($self->paid // 0);
414 return 0 if $self->amount == 0;
416 if ( $self->open_amount < 0 ) {
417 # overpaid, currently treated identically
418 $open_percent = $self->open_amount * 100 / $self->amount;
420 $open_percent = $self->open_amount * 100 / $self->amount;
423 return _round($open_percent) || 0;
429 return $self->amount - $self->amount_less_skonto;
432 sub remaining_skonto_days {
435 return undef unless ref $self->skonto_date;
437 my $dur = DateTime::Duration->new($self->skonto_date - DateTime->today);
438 return $dur->delta_days();
445 my $is_sales = ref($self) eq 'SL::DB::Invoice';
447 my $percent_skonto = 0;
450 return undef unless ref $self->payment_terms;
451 return undef unless $self->payment_terms->percent_skonto > 0;
452 $percent_skonto = $self->payment_terms->percent_skonto;
454 return undef unless ref $self->vendor->payment_terms;
455 return undef unless $self->vendor->payment_terms->terms_skonto > 0;
456 $percent_skonto = $self->vendor->payment_terms->percent_skonto;
459 return $percent_skonto;
462 sub amount_less_skonto {
463 # amount that has to be paid if skonto applies, always return positive rounded values
464 # no, rare case, but credit_notes and negative ap have negative amounts
465 # and therefore this comment may be misguiding
466 # the result is rounded so we can directly compare it with the user input
469 my $percent_skonto = $self->percent_skonto || 0;
471 return _round($self->amount - ( $self->amount * $percent_skonto) );
475 sub check_skonto_configuration {
478 my $is_sales = ref($self) eq 'SL::DB::Invoice';
480 my $skonto_configured = 1; # default is assume skonto works
482 # my $transactions = $self->transactions;
483 foreach my $transaction (@{ $self->transactions }) {
484 # find all transactions with an AR_amount or AP_amount link
485 my $tax = SL::DB::Manager::Tax->get_first( where => [taxkey => $transaction->taxkey, id => $transaction->tax_id ]);
487 # acc_trans entries for the taxes (chart_link == A[RP]_tax) often
488 # have combinations of taxkey & tax_id that don't exist in
489 # tax. Those must be skipped.
490 next if !$tax && ($transaction->chart_link !~ m{A[RP]_amount});
492 croak "no tax for taxkey " . $transaction->{taxkey} unless ref $tax;
494 $transaction->{chartlinks} = { map { $_ => 1 } split(m/:/, $transaction->chart_link) };
495 if ( $is_sales && $transaction->{chartlinks}->{AR_amount} ) {
496 $skonto_configured = 0 unless $tax->skonto_sales_chart_id;
497 } elsif ( !$is_sales && $transaction->{chartlinks}->{AP_amount}) {
498 $skonto_configured = 0 unless $tax->skonto_purchase_chart_id;
502 return $skonto_configured;
505 sub open_sepa_transfer_amount {
508 my ($vc, $key, $type);
509 if ( ref($self) eq 'SL::DB::Invoice' ) {
519 my $sql = qq|SELECT SUM(sei.amount) AS amount FROM sepa_export_items sei | .
520 qq| LEFT JOIN sepa_export se ON (sei.sepa_export_id = se.id) | .
521 qq| WHERE $key = ? AND NOT se.closed AND (se.vc = '$vc') |;
523 my ($open_sepa_amount) = $self->db->dbh->selectrow_array($sql, undef, $self->id);
525 return $open_sepa_amount || 0;
533 # TODO: use param for amount, may also want to calculate skonto_amounts by
534 # passing percentage in the future
536 my $amount = shift || $self->skonto_amount;
538 croak "no amount passed to skonto_charts" unless abs(_round($amount)) >= 0.01;
540 # TODO: check whether there are negative values in invoice / acc_trans ... credited items
542 # don't check whether skonto applies, because user may want to override this
543 # return undef unless $self->percent_skonto; # for is_sales
544 # return undef unless $self->vendor->payment_terms->percent_skonto; # for purchase
546 my $is_sales = ref($self) eq 'SL::DB::Invoice';
548 my $mult = $is_sales ? 1 : -1; # multiplier for getting the right sign
550 my @skonto_charts; # resulting array with all income/expense accounts that have to be corrected
552 # calculate effective skonto (percentage) in difference_as_skonto mode
553 # only works if there are no negative acc_trans values
554 my $effective_skonto_rate = $amount ? $amount / $self->amount : 0;
557 my $total_skonto_amount = 0;
558 my $total_rounding_error = 0;
560 my $reference_ARAP_amount = 0;
562 # my $transactions = $self->transactions;
563 foreach my $transaction (@{ $self->transactions }) {
564 # find all transactions with an AR_amount or AP_amount link
565 $transaction->{chartlinks} = { map { $_ => 1 } split(m/:/, $transaction->{chart_link}) };
566 # second condition is that we can determine an automatic Skonto account for each AR_amount entry
568 if ( ( $is_sales && $transaction->{chartlinks}->{AR_amount} ) or ( !$is_sales && $transaction->{chartlinks}->{AP_amount}) ) {
569 # $reference_ARAP_amount += $transaction->{amount} * $mult;
571 # quick hack that works around problem of non-unique tax keys in SKR04
572 # ? use tax_id in acc_trans
573 my $tax = SL::DB::Manager::Tax->get_first( where => [id => $transaction->{tax_id}]);
574 croak "no tax for taxkey " . $transaction->{taxkey} unless ref $tax;
577 die t8('no skonto_chart configured for taxkey #1 : #2 : #3', $transaction->{taxkey} , $tax->taxdescription , $tax->rate*100) unless ref $tax->skonto_sales_chart;
579 die t8('no skonto_chart configured for taxkey #1 : #2 : #3', $transaction->{taxkey} , $tax->taxdescription , $tax->rate*100) unless ref $tax->skonto_purchase_chart;
582 my $skonto_amount_unrounded;
584 my $skonto_percent_abs = $self->amount ? abs($transaction->amount * (1 + $tax->rate) * 100 / $self->amount) : 0;
586 my $transaction_amount = abs($transaction->{amount} * (1 + $tax->rate));
587 my $transaction_skonto_percent = abs($transaction_amount/$self->amount); # abs($transaction->{amount} * (1 + $tax->rate));
590 $skonto_amount_unrounded = abs($amount * $transaction_skonto_percent);
591 my $skonto_amount_rounded = _round($skonto_amount_unrounded);
592 my $rounding_error = $skonto_amount_unrounded - $skonto_amount_rounded;
593 my $rounded_rounding_error = _round($rounding_error);
595 $total_rounding_error += $rounding_error;
596 $total_skonto_amount += $skonto_amount_rounded;
599 # skonto_percent_abs: relative part of amount + tax to the total invoice amount
600 'skonto_percent_abs' => $skonto_percent_abs,
601 'chart_id' => $is_sales ? $tax->skonto_sales_chart->id : $tax->skonto_purchase_chart->id,
602 'skonto_amount' => $skonto_amount_rounded,
603 # 'rounding_error' => $rounding_error,
604 # 'rounded_rounding_error' => $rounded_rounding_error,
607 push @skonto_charts, $rec;
611 # if the rounded sum of all rounding_errors reaches 0.01 this sum is
612 # subtracted from the largest skonto_amount
613 my $rounded_total_rounding_error = abs(_round($total_rounding_error));
615 if ( $rounded_total_rounding_error > 0 ) {
616 my $highest_amount_pos = 0;
617 my $highest_amount = 0;
619 foreach my $ref ( @skonto_charts ) {
621 if ( $ref->{skonto_amount} > $highest_amount ) {
622 $highest_amount = $ref->{skonto_amount};
623 $highest_amount_pos = $i;
626 $skonto_charts[$i]->{skonto_amount} -= $rounded_total_rounding_error;
629 return @skonto_charts;
633 sub within_skonto_period {
635 my $dateref = shift || DateTime->now->truncate( to => 'day' );
637 return undef unless ref $dateref eq 'DateTime';
638 return 0 unless $self->skonto_date;
640 # return 1 if requested date (or today) is inside skonto period
641 # this will also return 1 if date is before the invoice date
642 return $dateref <= $self->skonto_date;
645 sub valid_skonto_amount {
647 my $amount = shift || 0;
648 my $max_skonto_percent = 0.10;
650 return 0 unless $amount > 0;
652 # does this work for other currencies?
653 return ($self->amount*$max_skonto_percent) > $amount;
656 sub get_payment_select_options_for_bank_transaction {
657 my ($self, $bt_id, %params) = @_;
660 # CAVEAT template code expects with_skonto_pt at position 1 for visual help
661 # due to skonto_charts, we cannot offer skonto for credit notes and neg ap
662 my $skontoable = $self->amount > 0 ? 1 : 0;
664 if(!$self->skonto_date) {
665 push(@options, { payment_type => 'without_skonto', display => t8('without skonto'), selected => 1 });
666 # wrong call to presenter or not implemented? disabled option is ignored
667 # push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt'), disabled => 1 });
668 push(@options, { payment_type => 'free_skonto', display => t8('free skonto') }) if $skontoable;
671 # valid skonto date, check if skonto is preferred
672 my $bt = SL::DB::BankTransaction->new(id => $bt_id)->load;
673 if ($self->skonto_date && $self->within_skonto_period($bt->transdate)) {
674 push(@options, { payment_type => 'without_skonto', display => t8('without skonto') });
675 push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt'), selected => 1 }) if $skontoable;
677 push(@options, { payment_type => 'without_skonto', display => t8('without skonto') , selected => 1 });
678 push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt')}) if $skontoable;
680 push(@options, { payment_type => 'free_skonto', display => t8('free skonto') }) if $skontoable;
687 return 1 if $self->currency_id == $::instance_conf->get_currency_id;
689 die "transdate isn't a DateTime object:" . ref($self->transdate) unless ref($self->transdate) eq 'DateTime';
690 my $rate = SL::DB::Manager::Exchangerate->find_by(currency_id => $self->currency_id,
691 transdate => $self->transdate,
693 return undef unless $rate;
695 return $self->is_sales ? $rate->buy : $rate->sell; # also undef if not defined
698 sub get_payment_suggestions {
700 my ($self, %params) = @_;
702 my $open_amount = $self->open_amount;
703 $open_amount -= $self->open_sepa_transfer_amount if $params{sepa};
705 $self->{invoice_amount_suggestion} = $open_amount;
706 undef $self->{payment_select_options};
707 push(@{$self->{payment_select_options}} , { payment_type => 'without_skonto', display => t8('without skonto') });
708 if ( $self->within_skonto_period ) {
709 # If there have been no payments yet suggest amount_less_skonto, otherwise the open amount
710 if ( $open_amount && # invoice amount not 0
711 $open_amount == $self->amount && # no payments yet, or sum of payments and sepa export amounts is zero
712 $self->check_skonto_configuration) {
713 $self->{invoice_amount_suggestion} = $self->amount_less_skonto;
714 push(@{$self->{payment_select_options}} , { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt') , selected => 1 });
716 if ( ( $self->valid_skonto_amount($self->open_amount) || $self->valid_skonto_amount($open_amount) ) and not $params{sepa} ) {
717 $self->{invoice_amount_suggestion} = $open_amount;
718 # only suggest difference_as_skonto if open_amount exactly matches skonto_amount
719 # AND we aren't in SEPA mode
721 $selected = 1 if _round($open_amount) == _round($self->skonto_amount);
722 push(@{$self->{payment_select_options}} , { payment_type => 'difference_as_skonto', display => t8('difference as skonto') , selected => $selected });
726 # invoice was configured with skonto, but skonto date has passed, or no skonto available
727 $self->{invoice_amount_suggestion} = $open_amount;
728 # difference_as_skonto doesn't make any sense for SEPA transfer, as this doesn't cause any actual payment
729 if ( $self->valid_skonto_amount($self->open_amount) && not $params{sepa} ) {
730 push(@{$self->{payment_select_options}} , { payment_type => 'difference_as_skonto', display => t8('difference as skonto') , selected => 0 });
736 # locales for payment type
738 # $main::locale->text('without_skonto')
739 # $main::locale->text('with_skonto_pt')
740 # $main::locale->text('difference_as_skonto')
743 sub validate_payment_type {
744 my $payment_type = shift;
746 my %allowed_payment_types = map { $_ => 1 } qw(without_skonto with_skonto_pt difference_as_skonto free_skonto);
747 croak "illegal payment type: $payment_type, must be one of: " . join(' ', keys %allowed_payment_types) unless $allowed_payment_types{ $payment_type };
754 $self->currency_id == $::instance_conf->get_currency_id ? return 0 : return 1;
760 return $::form->round_amount($value, 2);
771 SL::DB::Helper::Payment Mixin providing helper methods for paying C<Invoice>
772 and C<PurchaseInvoice> objects and using skonto
776 In addition to actually causing a payment via pay_invoice this helper contains
777 many methods that help in determining information about the status of the
778 invoice, such as the remaining open amount, whether skonto applies, until which
779 date skonto applies, the skonto amount and relative percentages, what to do
782 To prevent duplicate code this was all added in this mixin rather than directly
783 in SL::DB::Invoice and SL::DB::PurchaseInvoice.
787 =item C<pay_invoice %params>
789 Create a payment booking for an existing invoice object (type ar/ap/is/ir) via
790 a configured bank account.
792 This function deals with all the acc_trans entries and also updates paid and datepaid.
793 The params C<transdate> and C<chart_id> are mandantory.
794 If the default payment ('without_skonto') is used the param amount is also
796 If the payment type ('free_skonto') is used the number params skonto_amount and amount
797 are as well mandantory and need to be positive. Furthermore the skonto amount has
798 to be lower than the payment or open invoice amount.
800 Transdate can either be a date object or a date string.
801 Chart_id is the id of the payment booking chart.
802 Amount is either a postive or negative number, but never 0.
807 my $ap = SL::DB::Manager::PurchaseInvoice->find_by( invnumber => '1');
808 my $bank = SL::DB::Manager::BankAccount->find_by( name => 'Bank');
809 $ap->pay_invoice(chart_id => $bank->chart_id,
810 amount => $ap->open_amount,
811 transdate => DateTime->now->to_kivitendo,
814 payment_type => 'without_skonto', # default if not specified
819 $ap->pay_invoice(chart_id => $bank->chart_id,
820 amount => $ap->amount, # doesn't need to be specified
821 transdate => DateTime->now->to_kivitendo,
824 payment_type => 'with_skonto',
827 or in a certain currency:
828 $ap->pay_invoice(chart_id => $bank->chart_id,
831 transdate => DateTime->now->to_kivitendo,
834 payment_type => 'with_skonto_pt',
837 Allowed payment types are:
838 without_skonto with_skonto_pt difference_as_skonto
840 The option C<payment_type> allows for a basic skonto mechanism.
842 C<without_skonto> is the default mode, "amount" is paid to the account in
843 chart_id. This can also be used for partial payments and corrections via
846 C<with_skonto_pt> can't be used for partial payments. When used on unpaid
847 invoices the whole amount is paid, with the skonto part automatically being
848 booked according to the skonto chart configured in the tax settings for each
849 tax key. If an amount is passed it is ignored and the actual configured skonto
852 C<difference_as_skonto> can only be used after partial payments have been made,
853 the whole specified amount is booked according to the skonto charts configured
854 in the tax settings for each tax key.
856 So passing amount doesn't have any effect for the cases C<with_skonto_pt> and
857 C<difference_as_skonto>, as all necessary values are taken from the stored
860 The skonto modes automatically calculate the relative amounts for a mix of
861 taxes, e.g. items with 7% and 19% in one invoice. There is a helper method
862 skonto_charts, which calculates the relative percentages according to the
863 amounts in acc_trans (which are grouped by tax).
865 There is currently no way of excluding certain items in an invoice from having
866 skonto applied to them. If this feature was added to parts the calculation
867 method of relative skonto would have to be completely rewritten using the
868 invoice items rather than acc_trans.
870 The skonto modes also still don't automatically correct the tax, this still has
871 to be done manually. Therefore all payments generated by pay_invoice have
874 There is currently no way to directly pay an invoice via this method if the
875 effective skonto differs from the skonto according to the payment terms
876 configured for the invoice/vendor.
878 In this case one has to pay in two steps: first the actual paid amount via
879 "without skonto", and then the remainder via "difference_as_skonto". The user
880 has to there actively decide whether to accept the differing skonto.
882 Because of the way skonto_charts works the calculation doesn't work if there
883 are negative values in acc_trans. E.g. one invoice with a positive value for
884 19% tax and a negative value for the acc_trans line with 7%
886 Skonto doesn't/shouldn't apply if the invoice contains credited items.
888 If no amount is given the whole open amout is paid.
890 If neither currency or currency_id are given as params, the currency of the
891 invoice is assumed to be the payment currency.
893 If successful the return value will be 1 in scalar context or in list context
894 the two ids (acc_trans_id) of the newly created bookings.
896 =item C<reference_account>
898 Returns a chart object which is the chart of the invoice with link AR or AP.
900 Example (1200 is the AR account for SKR04):
901 my $invoice = invoice(invnumber => '144');
902 $invoice->reference_account->accno
905 =item C<percent_skonto>
907 Returns the configured skonto percentage of the payment terms of an invoice,
908 e.g. 0.02 for 2%. Payment terms come from invoice settings for ar, from vendor
911 =item C<amount_less_skonto>
913 If the invoice has a payment term (via ar for sales, via vendor for purchase),
914 calculate the amount to be paid in the case of skonto. This doesn't check,
915 whether skonto applies (i.e. skonto doesn't wasn't exceeded), it just subtracts
916 the configured percentage (e.g. 2%) from the total amount.
918 The returned value is rounded to two decimals.
922 The date up to which skonto may be taken. This is calculated from the invoice
923 date + the number of days configured in the payment terms.
925 This method can also be used to determine whether skonto applies for the
926 invoice, as it returns undef if there is no payment term or skonto days is set
929 =item C<within_skonto_period [DATE]>
933 Checks whether the invoice has payment terms configured, and whether the date
934 is within the skonto max date. If no date is passed the current date is used.
936 You can also pass a dateref object as a parameter to check whether skonto
937 applies for that date rather than the current date.
939 =item C<valid_skonto_amount>
941 Takes an amount as an argument and checks whether the amount is less than 10%
942 of the total amount of the invoice. The value of 10% is currently hardcoded in
943 the method. This method is currently used to check whether to offer the payment
944 option "difference as skonto".
947 if ( $invoice->valid_skonto_amount($invoice->open_amount) ) {
951 =item C<skonto_charts [$amount]>
953 Returns a list of chart_ids and some calculated numbers that can be used for
954 paying the invoice with skonto. This function will automatically calculate the
955 relative skonto amounts even if the invoice contains several types of taxes
959 my $invoice = SL::DB::Manager::Invoice->find_by(invnumber => '211');
960 my @skonto_charts = $invoice->skonto_charts;
962 or with the total skonto amount as an argument:
963 my @skonto_charts = $invoice->skonto_charts($invoice->open_amount);
965 The following values are generated for each chart:
971 The chart id of the skonto amount to be booked.
973 =item C<skonto_amount>
975 The total amount to be paid to the account
977 =item C<skonto_percent>
979 The relative percentage of that skonto chart. This can be useful if the actual
980 ekonto that is paid deviates from the granted skonto, e.g. customer effectively
981 pays 2.6% skonto instead of 2%, and we accept this. Then we can still calculate
982 the relative skonto amounts for different taxes based on the absolute
983 percentages. Used for case C<difference_as_skonto>.
985 =item C<skonto_percent_abs>
987 The absolute percentage of that skonto chart in relation to the total amount.
988 Used to calculate skonto_amount for case C<with_skonto_pt>.
992 If the invoice contains several types of taxes then skonto_charts can be used
993 to calculate the relative amounts.
995 Example in console of an invoice with 100 Euro at 7% and 100 Euro at 19% with
998 my $invoice = invoice(invnumber => '144');
1001 $invoice->payment_terms->percent_skonto
1003 $invoice->skonto_charts
1004 pp $invoice->skonto_charts
1006 # 'chart_id' => 128,
1007 # 'skonto_amount' => '2.14',
1008 # 'skonto_percent' => '47.3451327433627'
1011 # 'chart_id' => 130,
1012 # 'skonto_amount' => '2.38',
1013 # 'skonto_percent' => '52.654867256637'
1016 C<skonto_charts> always returns positive values (abs) for C<skonto_amount> and
1019 C<skonto_charts> generates one entry for each acc_trans entry. ar and ap
1020 bookings only have one acc_trans entry for each taxkey (e.g. 7% and 19%). This
1021 is because all the items are grouped according to the Buchungsgruppen mechanism
1022 and the totals are written to acc_trans. For is and ir it is possible to have
1023 several acc_trans entries with the same tax. In this case skonto_charts
1024 generates a skonto booking for each acc_trans income/expense entry.
1026 In the future this function may also be used to calculate the corrections for
1029 =item C<open_amount>
1031 Unrounded total open amount of invoice (amount - paid).
1032 Doesn't take into account pending SEPA transfers.
1034 =item C<open_percent>
1036 Percentage of the invoice that is still unpaid, e.g. 100,00 if no payments have
1037 been made yet, 0,00 if fully paid.
1039 =item C<remaining_skonto_days>
1041 How many days skonto can still be taken, calculated from current day. Returns 0
1042 if current day is the max skonto date, and negative number if skonto date has
1045 Returns undef if skonto is not configured for that invoice.
1047 =item C<get_payment_suggestions %params>
1049 Creates data intended for an L.select_tag dropdown that can be used in a
1050 template. Depending on the rules it will choose from the options
1051 without_skonto, with_skonto_pt and difference_as_skonto, and select the most
1054 If the parameter "sepa" is passed, the SEPA export payments that haven't been
1055 executed yet are considered when determining the open amount of the invoice.
1057 The current rules are:
1061 =item * without_skonto is always an option
1063 =item * with_skonto_pt is only offered if there haven't been any payments yet and the current date is within the skonto period.
1065 =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.
1067 with_skonto_pt will only be offered, if all the AR_amount/AP_amount have a
1068 taxkey with a configured skonto chart
1072 It will also fill $self->{invoice_amount_suggestion} with either the open
1073 amount, or if with_skonto_pt is selected, with amount_less_skonto, so the
1074 template can fill the input with the likely amount.
1077 my $ar = invoice( invnumber => '257');
1078 $ar->get_payment_suggestions;
1079 print $ar->{invoice_amount_suggestion} . "\n";
1081 pp $ar->{payment_select_options}
1084 # 'display' => 'ohne Skonto',
1085 # 'payment_type' => 'without_skonto'
1088 # 'display' => 'mit Skonto nach ZB',
1089 # 'payment_type' => 'with_skonto_pt',
1094 The resulting array $ar->{payment_select_options} can be used in a template
1095 select_tag using value_key and title_key:
1097 [% L.select_tag('payment_type_' _ loop.count, invoice.payment_select_options, value_key => 'payment_type', title_key => 'display', id => 'payment_type_' _ loop.count) %]
1099 It would probably make sense to have different rules for the pre-selected items
1100 for sales and purchase, and to also make these rules configurable in the
1101 defaults. E.g. when creating a SEPA bank transfer for vendor invoices a company
1102 might always want to pay quickly making use of skonto, while another company
1103 might always want to pay as late as possible.
1105 =item C<get_payment_select_options_for_bank_transaction $banktransaction_id %params>
1107 Make suggestion for a skonto payment type by returning an HTML blob of the options
1108 of a HTML drop-down select with the most likely option preselected.
1110 This is a helper function for BankTransaction/ajax_payment_suggestion and
1111 template/webpages/bank_transactions/invoices.html
1113 We are working with an existing payment, so difference_as_skonto never makes sense.
1115 If skonto is not possible (skonto_date does not exists) simply return
1116 the single 'no skonto' option as a visual hint.
1118 If skonto is possible (skonto_date exists), add two possibilities:
1119 without_skonto and with_skonto_pt if payment date is within skonto_date,
1120 preselect with_skonto_pt, otherwise preselect without skonto.
1122 =item C<exchangerate>
1124 Returns 1 immediately if the record uses the default currency.
1126 Returns the exchangerate in database format for the invoice according to that
1127 invoice's transdate, returning 'buy' for sales, 'sell' for purchases.
1129 If no exchangerate can be found for that day undef is returned.
1133 Returns 1 if record uses a different currency, 0 if the default currency is used.
1137 =head1 TODO AND CAVEATS
1143 when looking at open amount, maybe consider that there may already be queued
1144 amounts in SEPA Export
1146 =item * C<skonto_charts>
1148 Cannot handle negative skonto amounts, will always calculate the skonto amount
1149 for credit notes or negative ap transactions with a positive sign.
1156 G. Richardson E<lt>grichardson@kivitendo-premium.de<gt>