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);
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);
21 # Public functions not exported by default
25 my ($self, %params) = @_;
29 my $is_sales = ref($self) eq 'SL::DB::Invoice';
30 my $mult = $is_sales ? 1 : -1; # multiplier for getting the right sign depending on ar/ap
32 my $paid_amount = 0; # the amount that will be later added to $self->paid
34 # default values if not set
35 $params{payment_type} = 'without_skonto' unless $params{payment_type};
36 validate_payment_type($params{payment_type});
38 # check for required parameters
39 Common::check_params(\%params, qw(chart_id transdate));
41 my $transdate_obj = $::locale->parse_date_to_object($params{transdate});
42 croak t8('Illegal date') unless ref $transdate_obj;
44 # check for closed period
45 my $closedto = $::locale->parse_date_to_object($::instance_conf->get_closedto);
46 if ( ref $closedto && $transdate_obj < $closedto ) {
47 croak t8('Cannot post payment for a closed period!');
50 # check for maximum number of future days
51 if ( $::instance_conf->get_max_future_booking_interval > 0 ) {
52 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 );
56 if ( $params{'payment_type'} eq 'without_skonto' ) {
57 croak "invalid amount for payment_type 'without_skonto': $params{'amount'}\n" unless abs($params{'amount'}) > 0;
60 # options with_skonto_pt and difference_as_skonto don't require the parameter
61 # amount, but if amount is passed, make sure it matches the expected value
62 if ( $params{'payment_type'} eq 'difference_as_skonto' ) {
63 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;
64 } elsif ( $params{'payment_type'} eq 'with_skonto_pt' ) {
65 croak "amount $params{amount} doesn't match amount less skonto: " . $self->open_amount . "\n" if $params{amount} && abs($self->amount_less_skonto - $params{amount} ) > 0.0000001;
66 croak "payment type with_skonto_pt can't be used if payments have already been made" if $self->paid != 0;
69 # absolute skonto amount for invoice, use as reference sum to see if the
70 # calculated skontos add up
71 # only needed for payment_term "with_skonto_pt"
73 my $skonto_amount_check = $self->skonto_amount; # variable should be zero after calculating all skonto
74 my $total_open_amount = $self->open_amount;
76 # account where money is paid to/from: bank account or cash
77 my $account_bank = SL::DB::Manager::Chart->find_by(id => $params{chart_id});
78 croak "can't find bank account" unless ref $account_bank;
80 my $reference_account = $self->reference_account;
81 croak "can't find reference account (link = AR/AP) for invoice" unless ref $reference_account;
83 my $memo = $params{'memo'} || '';
84 my $source = $params{'source'} || '';
86 my $rounded_params_amount = _round( $params{amount} );
89 $db->do_transaction(sub {
92 # all three payment type create 1 AR/AP booking (the paid part)
93 # difference_as_skonto creates n skonto bookings (1 for each tax type)
94 # with_skonto_pt creates 1 bank booking and n skonto bookings (1 for each tax type)
95 # without_skonto creates 1 bank booking
97 # as long as there is no automatic tax, payments are always booked with
100 unless ( $params{payment_type} eq 'difference_as_skonto' ) {
101 # cases with_skonto_pt and without_skonto
103 # for case with_skonto_pt we need to know the corrected amount at this
104 # stage if we are going to use $params{amount}
106 my $pay_amount = $rounded_params_amount;
107 $pay_amount = $self->amount_less_skonto if $params{payment_type} eq 'with_skonto_pt';
109 # bank account and AR/AP
110 $paid_amount += $pay_amount;
112 # total amount against bank, do we already know this by now?
113 $new_acc_trans = SL::DB::AccTransaction->new(trans_id => $self->id,
114 chart_id => $account_bank->id,
115 chart_link => $account_bank->link,
116 amount => (-1 * $pay_amount) * $mult,
117 transdate => $transdate_obj,
121 tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
122 $new_acc_trans->save;
125 if ( $params{payment_type} eq 'difference_as_skonto' or $params{payment_type} eq 'with_skonto_pt' ) {
127 my $total_skonto_amount;
128 if ( $params{payment_type} eq 'with_skonto_pt' ) {
129 $total_skonto_amount = $self->skonto_amount;
130 } elsif ( $params{payment_type} eq 'difference_as_skonto' ) {
131 $total_skonto_amount = $self->open_amount;
134 my @skonto_bookings = $self->skonto_charts($total_skonto_amount);
137 if ( $params{payment_type} eq 'difference_as_skonto' ) {
138 my $calculated_skonto_sum = sum map { $_->{skonto_amount} } @skonto_bookings;
139 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);
142 my $reference_amount = $total_skonto_amount;
144 # create an acc_trans entry for each result of $self->skonto_charts
145 foreach my $skonto_booking ( @skonto_bookings ) {
146 next unless $skonto_booking->{'chart_id'};
147 next unless $skonto_booking->{'skonto_amount'} != 0;
148 my $amount = -1 * $skonto_booking->{skonto_amount};
149 $new_acc_trans = SL::DB::AccTransaction->new(trans_id => $self->id,
150 chart_id => $skonto_booking->{'chart_id'},
151 chart_link => SL::DB::Manager::Chart->find_by(id => $skonto_booking->{'chart_id'})->{'link'},
152 amount => $amount * $mult,
153 transdate => $transdate_obj,
154 source => $params{source},
156 tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
158 # the acc_trans entries are saved individually, not added to $self and then saved all at once
159 $new_acc_trans->save;
161 $reference_amount -= abs($amount);
162 $paid_amount += -1 * $amount;
163 $skonto_amount_check -= $skonto_booking->{'skonto_amount'};
165 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;
171 if ( $params{payment_type} eq 'difference_as_skonto' ) {
172 $arap_amount = $total_open_amount;
173 } elsif ( $params{payment_type} eq 'without_skonto' ) {
174 $arap_amount = $rounded_params_amount;
175 } elsif ( $params{payment_type} eq 'with_skonto_pt' ) {
176 # this should be amount + sum(amount+skonto), but while we only allow
177 # with_skonto_pt for completely unpaid invoices we just use the value
179 $arap_amount = $total_open_amount;
182 # regardless of payment_type there is always only exactly one arap booking
183 # TODO: compare $arap_amount to running total
184 my $arap_booking= SL::DB::AccTransaction->new(trans_id => $self->id,
185 chart_id => $reference_account->id,
186 chart_link => $reference_account->link,
187 amount => $arap_amount * $mult,
188 transdate => $transdate_obj,
189 source => '', #$params{source},
191 tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
194 $self->paid($self->paid+$paid_amount) if $paid_amount;
195 $self->datepaid($transdate_obj);
198 # make sure transactions will be reloaded the next time $self->transactions
199 # is called, as pay_invoice saves the acc_trans objects individually rather
200 # than adding them to the transaction relation array.
201 $self->forget_related('transactions');
205 if ( ( $self->invoice && $::instance_conf->get_datev_check_on_sales_invoice ) ||
206 ( !$self->invoice && $::instance_conf->get_datev_check_on_ar_transaction )) {
210 if ( ( $self->invoice && $::instance_conf->get_datev_check_on_purchase_invoice ) ||
211 ( !$self->invoice && $::instance_conf->get_datev_check_on_ap_transaction )) {
216 if ( $datev_check ) {
218 my $datev = SL::DATEV->new(
219 exporttype => DATEV_ET_BUCHUNGEN,
220 format => DATEV_FORMAT_KNE,
222 trans_id => $self->{id},
225 $datev->clean_temporary_directories;
228 if ($datev->errors) {
229 # this exception should be caught by do_transaction, which handles the rollback
230 die join "\n", $::locale->text('DATEV check returned errors:'), $datev->errors;
234 }) || die t8('error while paying invoice #1 : ', $self->invnumber) . $db->error . "\n";
243 my $is_sales = ref($self) eq 'SL::DB::Invoice';
248 return undef unless ref $self->payment_terms;
249 return undef unless $self->payment_terms->terms_skonto > 0;
250 $skonto_date = DateTime->from_object(object => $self->transdate)->add(days => $self->payment_terms->terms_skonto);
252 return undef unless ref $self->vendor->payment_terms;
253 return undef unless $self->vendor->payment_terms->terms_skonto > 0;
254 $skonto_date = DateTime->from_object(object => $self->transdate)->add(days => $self->vendor->payment_terms->terms_skonto);
260 sub reference_account {
263 my $is_sales = ref($self) eq 'SL::DB::Invoice';
265 require SL::DB::Manager::AccTransaction;
267 my $link_filter = $is_sales ? 'AR' : 'AP';
269 my $acc_trans = SL::DB::Manager::AccTransaction->find_by(
270 trans_id => $self->id,
271 SL::DB::Manager::AccTransaction->chart_link_filter("$link_filter")
274 return undef unless ref $acc_trans;
276 my $reference_account = SL::DB::Manager::Chart->find_by(id => $acc_trans->chart_id);
278 return $reference_account;
281 sub reference_amount {
284 my $is_sales = ref($self) eq 'SL::DB::Invoice';
286 require SL::DB::Manager::AccTransaction;
288 my $link_filter = $is_sales ? 'AR' : 'AP';
290 my $acc_trans = SL::DB::Manager::AccTransaction->find_by(
291 trans_id => $self->id,
292 SL::DB::Manager::AccTransaction->chart_link_filter("$link_filter")
295 return undef unless ref $acc_trans;
297 # this should be the same as $self->amount
298 return $acc_trans->amount;
305 # in the future maybe calculate this from acc_trans
307 # if the difference is 0.01 Cent this may end up as 0.009999999999998
308 # numerically, so round this value when checking for cent threshold >= 0.01
310 return $self->amount - $self->paid;
316 return 0 if $self->amount == 0;
318 if ( $self->open_amount < 0 ) {
319 # overpaid, currently treated identically
320 $open_percent = $self->open_amount * 100 / $self->amount;
322 $open_percent = $self->open_amount * 100 / $self->amount;
325 return _round($open_percent) || 0;
331 return $self->amount - $self->amount_less_skonto;
334 sub remaining_skonto_days {
337 return undef unless ref $self->skonto_date;
339 my $dur = DateTime::Duration->new($self->skonto_date - DateTime->today);
340 return $dur->delta_days();
347 my $is_sales = ref($self) eq 'SL::DB::Invoice';
349 my $percent_skonto = 0;
352 return undef unless ref $self->payment_terms;
353 return undef unless $self->payment_terms->percent_skonto > 0;
354 $percent_skonto = $self->payment_terms->percent_skonto;
356 return undef unless ref $self->vendor->payment_terms;
357 return undef unless $self->vendor->payment_terms->terms_skonto > 0;
358 $percent_skonto = $self->vendor->payment_terms->percent_skonto;
361 return $percent_skonto;
364 sub amount_less_skonto {
365 # amount that has to be paid if skonto applies, always return positive rounded values
366 # the result is rounded so we can directly compare it with the user input
369 my $is_sales = ref($self) eq 'SL::DB::Invoice';
371 my $percent_skonto = $self->percent_skonto || 0;
373 return _round($self->amount - ( $self->amount * $percent_skonto) );
377 sub check_skonto_configuration {
380 my $is_sales = ref($self) eq 'SL::DB::Invoice';
382 my $skonto_configured = 1; # default is assume skonto works
384 # my $transactions = $self->transactions;
385 foreach my $transaction (@{ $self->transactions }) {
386 # find all transactions with an AR_amount or AP_amount link
387 my $tax = SL::DB::Manager::Tax->get_first( where => [taxkey => $transaction->{taxkey}]);
388 croak "no tax for taxkey " . $transaction->{taxkey} unless ref $tax;
390 $transaction->{chartlinks} = { map { $_ => 1 } split(m/:/, $transaction->{chart_link}) };
391 if ( $is_sales && $transaction->{chartlinks}->{AR_amount} ) {
392 $skonto_configured = 0 unless $tax->skonto_sales_chart_id;
393 } elsif ( !$is_sales && $transaction->{chartlinks}->{AP_amount}) {
394 $skonto_configured = 0 unless $tax->skonto_purchase_chart_id;
398 return $skonto_configured;
401 sub open_sepa_transfer_amount {
404 my ($vc, $key, $type);
405 if ( ref($self) eq 'SL::DB::Invoice' ) {
415 my $sql = qq|SELECT SUM(sei.amount) AS amount FROM sepa_export_items sei | .
416 qq| LEFT JOIN sepa_export se ON (sei.sepa_export_id = se.id) | .
417 qq| WHERE $key = ? AND NOT se.closed AND (se.vc = '$vc') |;
419 my ($open_sepa_amount) = $self->db->dbh->selectrow_array($sql, undef, $self->id);
421 return $open_sepa_amount || 0;
429 # TODO: use param for amount, may also want to calculate skonto_amounts by
430 # passing percentage in the future
432 my $amount = shift || $self->skonto_amount;
434 croak "no amount passed to skonto_charts" unless abs(_round($amount)) >= 0.01;
436 # TODO: check whether there are negative values in invoice / acc_trans ... credited items
438 # don't check whether skonto applies, because user may want to override this
439 # return undef unless $self->percent_skonto; # for is_sales
440 # return undef unless $self->vendor->payment_terms->percent_skonto; # for purchase
442 my $is_sales = ref($self) eq 'SL::DB::Invoice';
444 my $mult = $is_sales ? 1 : -1; # multiplier for getting the right sign
446 my @skonto_charts; # resulting array with all income/expense accounts that have to be corrected
448 # calculate effective skonto (percentage) in difference_as_skonto mode
449 # only works if there are no negative acc_trans values
450 my $effective_skonto_rate = $amount ? $amount / $self->amount : 0;
453 my $total_skonto_amount = 0;
454 my $total_rounding_error = 0;
456 my $reference_ARAP_amount = 0;
458 # my $transactions = $self->transactions;
459 foreach my $transaction (@{ $self->transactions }) {
460 # find all transactions with an AR_amount or AP_amount link
461 $transaction->{chartlinks} = { map { $_ => 1 } split(m/:/, $transaction->{chart_link}) };
462 # second condition is that we can determine an automatic Skonto account for each AR_amount entry
464 if ( ( $is_sales && $transaction->{chartlinks}->{AR_amount} ) or ( !$is_sales && $transaction->{chartlinks}->{AP_amount}) ) {
465 # $reference_ARAP_amount += $transaction->{amount} * $mult;
467 # quick hack that works around problem of non-unique tax keys in SKR04
468 my $tax = SL::DB::Manager::Tax->get_first( where => [taxkey => $transaction->{taxkey}]);
469 croak "no tax for taxkey " . $transaction->{taxkey} unless ref $tax;
472 die t8('no skonto_chart configured for taxkey #1 : #2 : #3', $transaction->{taxkey} , $tax->taxdescription , $tax->rate*100) unless ref $tax->skonto_sales_chart;
474 die t8('no skonto_chart configured for taxkey #1 : #2 : #3', $transaction->{taxkey} , $tax->taxdescription , $tax->rate*100) unless ref $tax->skonto_purchase_chart;
477 my $skonto_amount_unrounded;
479 my $skonto_percent_abs = $self->amount ? abs($transaction->amount * (1 + $tax->rate) * 100 / $self->amount) : 0;
481 my $transaction_amount = abs($transaction->{amount} * (1 + $tax->rate));
482 my $transaction_skonto_percent = abs($transaction_amount/$self->amount); # abs($transaction->{amount} * (1 + $tax->rate));
485 $skonto_amount_unrounded = abs($amount * $transaction_skonto_percent);
486 my $skonto_amount_rounded = _round($skonto_amount_unrounded);
487 my $rounding_error = $skonto_amount_unrounded - $skonto_amount_rounded;
488 my $rounded_rounding_error = _round($rounding_error);
490 $total_rounding_error += $rounding_error;
491 $total_skonto_amount += $skonto_amount_rounded;
494 # skonto_percent_abs: relative part of amount + tax to the total invoice amount
495 'skonto_percent_abs' => $skonto_percent_abs,
496 'chart_id' => $is_sales ? $tax->skonto_sales_chart->id : $tax->skonto_purchase_chart->id,
497 'skonto_amount' => $skonto_amount_rounded,
498 # 'rounding_error' => $rounding_error,
499 # 'rounded_rounding_error' => $rounded_rounding_error,
502 push @skonto_charts, $rec;
506 # if the rounded sum of all rounding_errors reaches 0.01 this sum is
507 # subtracted from the largest skonto_amount
508 my $rounded_total_rounding_error = abs(_round($total_rounding_error));
510 if ( $rounded_total_rounding_error > 0 ) {
511 my $highest_amount_pos = 0;
512 my $highest_amount = 0;
514 foreach my $ref ( @skonto_charts ) {
516 if ( $ref->{skonto_amount} > $highest_amount ) {
517 $highest_amount = $ref->{skonto_amount};
518 $highest_amount_pos = $i;
521 $skonto_charts[$i]->{skonto_amount} -= $rounded_total_rounding_error;
524 return @skonto_charts;
528 sub within_skonto_period {
530 my $dateref = shift || DateTime->now->truncate( to => 'day' );
532 return undef unless ref $dateref eq 'DateTime';
533 return 0 unless $self->skonto_date;
535 # return 1 if requested date (or today) is inside skonto period
536 # this will also return 1 if date is before the invoice date
537 return $dateref <= $self->skonto_date;
540 sub valid_skonto_amount {
542 my $amount = shift || 0;
543 my $max_skonto_percent = 0.10;
545 return 0 unless $amount > 0;
547 # does this work for other currencies?
548 return ($self->amount*$max_skonto_percent) > $amount;
551 sub get_payment_select_options_for_bank_transaction {
552 my ($self, $bt_id, %params) = @_;
554 my $bt = SL::DB::Manager::BankTransaction->find_by( id => $bt_id );
557 my $open_amount = $self->open_amount;
560 if ( $open_amount && # invoice amount not 0
561 $self->skonto_date && # check whether skonto applies
562 abs(abs($self->amount_less_skonto) - abs($bt->amount)) < 0.01 &&
563 $self->check_skonto_configuration) {
564 if ( $self->within_skonto_period($bt->transdate) ) {
565 push(@options, { payment_type => 'without_skonto', display => t8('without skonto') });
566 push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt'), selected => 1 });
568 push(@options, { payment_type => 'without_skonto', display => t8('without skonto') , selected => 1 });
569 push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt')});
578 sub get_payment_suggestions {
580 my ($self, %params) = @_;
582 my $open_amount = $self->open_amount;
583 $open_amount -= $self->open_sepa_transfer_amount if $params{sepa};
585 $self->{invoice_amount_suggestion} = $open_amount;
586 undef $self->{payment_select_options};
587 push(@{$self->{payment_select_options}} , { payment_type => 'without_skonto', display => t8('without skonto') });
588 if ( $self->within_skonto_period ) {
589 # If there have been no payments yet suggest amount_less_skonto, otherwise the open amount
590 if ( $open_amount && # invoice amount not 0
591 $open_amount == $self->amount && # no payments yet, or sum of payments and sepa export amounts is zero
592 $self->check_skonto_configuration) {
593 $self->{invoice_amount_suggestion} = $self->amount_less_skonto;
594 push(@{$self->{payment_select_options}} , { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt') , selected => 1 });
596 if ( ( $self->valid_skonto_amount($self->open_amount) || $self->valid_skonto_amount($open_amount) ) and not $params{sepa} ) {
597 $self->{invoice_amount_suggestion} = $open_amount;
598 # only suggest difference_as_skonto if open_amount exactly matches skonto_amount
599 # AND we aren't in SEPA mode
601 $selected = 1 if _round($open_amount) == _round($self->skonto_amount);
602 push(@{$self->{payment_select_options}} , { payment_type => 'difference_as_skonto', display => t8('difference as skonto') , selected => $selected });
606 # invoice was configured with skonto, but skonto date has passed, or no skonto available
607 $self->{invoice_amount_suggestion} = $open_amount;
608 # difference_as_skonto doesn't make any sense for SEPA transfer, as this doesn't cause any actual payment
609 if ( $self->valid_skonto_amount($self->open_amount) && not $params{sepa} ) {
610 push(@{$self->{payment_select_options}} , { payment_type => 'difference_as_skonto', display => t8('difference as skonto') , selected => 0 });
616 sub validate_payment_type {
617 my $payment_type = shift;
619 my %allowed_payment_types = map { $_ => 1 } qw(without_skonto with_skonto_pt difference_as_skonto);
620 croak "illegal payment type: $payment_type, must be one of: " . join(' ', keys %allowed_payment_types) unless $allowed_payment_types{ $payment_type };
628 return $::form->round_amount($value, 2);
639 SL::DB::Helper::Payment Mixin providing helper methods for paying C<Invoice>
640 and C<PurchaseInvoice> objects and using skonto
644 In addition to actually causing a payment via pay_invoice this helper contains
645 many methods that help in determining information about the status of the
646 invoice, such as the remaining open amount, whether skonto applies, until which
647 date skonto applies, the skonto amount and relative percentages, what to do
650 To prevent duplicate code this was all added in this mixin rather than directly
651 in SL::DB::Invoice and SL::DB::PurchaseInvoice.
655 =item C<pay_invoice %params>
657 Create a payment booking for an existing invoice object (type ar/ap/is/ir) via
658 a configured bank account.
660 This function deals with all the acc_trans entries and also updates paid and datepaid.
664 my $ap = SL::DB::Manager::PurchaseInvoice->find_by( invnumber => '1');
665 my $bank = SL::DB::Manager::BankAccount->find_by( name => 'Bank');
666 $ap->pay_invoice(chart_id => $bank->chart_id,
667 amount => $ap->open_amount,
668 transdate => DateTime->now->to_kivitendo,
671 payment_type => 'without_skonto', # default if not specified
675 $ap->pay_invoice(chart_id => $bank->chart_id,
676 amount => $ap->amount, # doesn't need to be specified
677 transdate => DateTime->now->to_kivitendo,
680 payment_type => 'with_skonto',
683 Allowed payment types are:
684 without_skonto with_skonto_pt difference_as_skonto
686 The option C<payment_type> allows for a basic skonto mechanism.
688 C<without_skonto> is the default mode, "amount" is paid to the account in
689 chart_id. This can also be used for partial payments and corrections via
692 C<with_skonto_pt> can't be used for partial payments. When used on unpaid
693 invoices the whole amount is paid, with the skonto part automatically being
694 booked according to the skonto chart configured in the tax settings for each
695 tax key. If an amount is passed it is ignored and the actual configured skonto
698 C<difference_as_skonto> can only be used after partial payments have been made,
699 the whole specified amount is booked according to the skonto charts configured
700 in the tax settings for each tax key.
702 So passing amount doesn't have any effect for the cases C<with_skonto_pt> and
703 C<difference_as_skonto>, as all necessary values are taken from the stored
706 The skonto modes automatically calculate the relative amounts for a mix of
707 taxes, e.g. items with 7% and 19% in one invoice. There is a helper method
708 skonto_charts, which calculates the relative percentages according to the
709 amounts in acc_trans (which are grouped by tax).
711 There is currently no way of excluding certain items in an invoice from having
712 skonto applied to them. If this feature was added to parts the calculation
713 method of relative skonto would have to be completely rewritten using the
714 invoice items rather than acc_trans.
716 The skonto modes also still don't automatically correct the tax, this still has
717 to be done manually. Therefore all payments generated by pay_invoice have
720 There is currently no way to directly pay an invoice via this method if the
721 effective skonto differs from the skonto according to the payment terms
722 configured for the invoice/vendor.
724 In this case one has to pay in two steps: first the actual paid amount via
725 "without skonto", and then the remainder via "difference_as_skonto". The user
726 has to there actively decide whether to accept the differing skonto.
728 Because of the way skonto_charts works the calculation doesn't work if there
729 are negative values in acc_trans. E.g. one invoice with a positive value for
730 19% tax and a negative value for the acc_trans line with 7%
732 Skonto doesn't/shouldn't apply if the invoice contains credited items.
734 =item C<reference_account>
736 Returns a chart object which is the chart of the invoice with link AR or AP.
738 Example (1200 is the AR account for SKR04):
739 my $invoice = invoice(invnumber => '144');
740 $invoice->reference_account->accno
743 =item C<percent_skonto>
745 Returns the configured skonto percentage of the payment terms of an invoice,
746 e.g. 0.02 for 2%. Payment terms come from invoice settings for ar, from vendor
749 =item C<amount_less_skonto>
751 If the invoice has a payment term (via ar for sales, via vendor for purchase),
752 calculate the amount to be paid in the case of skonto. This doesn't check,
753 whether skonto applies (i.e. skonto doesn't wasn't exceeded), it just subtracts
754 the configured percentage (e.g. 2%) from the total amount.
756 The returned value is rounded to two decimals.
760 The date up to which skonto may be taken. This is calculated from the invoice
761 date + the number of days configured in the payment terms.
763 This method can also be used to determine whether skonto applies for the
764 invoice, as it returns undef if there is no payment term or skonto days is set
767 =item C<within_skonto_period [DATE]>
771 Checks whether the invoice has payment terms configured, and whether the date
772 is within the skonto max date. If no date is passed the current date is used.
774 You can also pass a dateref object as a parameter to check whether skonto
775 applies for that date rather than the current date.
777 =item C<valid_skonto_amount>
779 Takes an amount as an argument and checks whether the amount is less than 10%
780 of the total amount of the invoice. The value of 10% is currently hardcoded in
781 the method. This method is currently used to check whether to offer the payment
782 option "difference as skonto".
785 if ( $invoice->valid_skonto_amount($invoice->open_amount) ) {
789 =item C<skonto_charts [$amount]>
791 Returns a list of chart_ids and some calculated numbers that can be used for
792 paying the invoice with skonto. This function will automatically calculate the
793 relative skonto amounts even if the invoice contains several types of taxes
797 my $invoice = SL::DB::Manager::Invoice->find_by(invnumber => '211');
798 my @skonto_charts = $invoice->skonto_charts;
800 or with the total skonto amount as an argument:
801 my @skonto_charts = $invoice->skonto_charts($invoice->open_amount);
803 The following values are generated for each chart:
809 The chart id of the skonto amount to be booked.
811 =item C<skonto_amount>
813 The total amount to be paid to the account
815 =item C<skonto_percent>
817 The relative percentage of that skonto chart. This can be useful if the actual
818 ekonto that is paid deviates from the granted skonto, e.g. customer effectively
819 pays 2.6% skonto instead of 2%, and we accept this. Then we can still calculate
820 the relative skonto amounts for different taxes based on the absolute
821 percentages. Used for case C<difference_as_skonto>.
823 =item C<skonto_percent_abs>
825 The absolute percentage of that skonto chart in relation to the total amount.
826 Used to calculate skonto_amount for case C<with_skonto_pt>.
830 If the invoice contains several types of taxes then skonto_charts can be used
831 to calculate the relative amounts.
833 Example in console of an invoice with 100 Euro at 7% and 100 Euro at 19% with
836 my $invoice = invoice(invnumber => '144');
839 $invoice->payment_terms->percent_skonto
841 $invoice->skonto_charts
842 pp $invoice->skonto_charts
845 # 'skonto_amount' => '2.14',
846 # 'skonto_percent' => '47.3451327433627'
850 # 'skonto_amount' => '2.38',
851 # 'skonto_percent' => '52.654867256637'
854 C<skonto_charts> always returns positive values (abs) for C<skonto_amount> and
857 C<skonto_charts> generates one entry for each acc_trans entry. ar and ap
858 bookings only have one acc_trans entry for each taxkey (e.g. 7% and 19%). This
859 is because all the items are grouped according to the Buchungsgruppen mechanism
860 and the totals are written to acc_trans. For is and ir it is possible to have
861 several acc_trans entries with the same tax. In this case skonto_charts
862 generates a skonto booking for each acc_trans income/expense entry.
864 In the future this function may also be used to calculate the corrections for
869 Unrounded total open amount of invoice (amount - paid).
870 Doesn't take into account pending SEPA transfers.
872 =item C<open_percent>
874 Percentage of the invoice that is still unpaid, e.g. 100,00 if no payments have
875 been made yet, 0,00 if fully paid.
877 =item C<remaining_skonto_days>
879 How many days skonto can still be taken, calculated from current day. Returns 0
880 if current day is the max skonto date, and negative number if skonto date has
883 Returns undef if skonto is not configured for that invoice.
885 =item C<get_payment_suggestions %params>
887 Creates data intended for an L.select_tag dropdown that can be used in a
888 template. Depending on the rules it will choose from the options
889 without_skonto, with_skonto_pt and difference_as_skonto, and select the most
892 If the parameter "sepa" is passed, the SEPA export payments that haven't been
893 executed yet are considered when determining the open amount of the invoice.
895 The current rules are:
899 =item * without_skonto is always an option
901 =item * with_skonto_pt is only offered if there haven't been any payments yet and the current date is within the skonto period.
903 =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.
905 with_skonto_pt will only be offered, if all the AR_amount/AP_amount have a
906 taxkey with a configured skonto chart
910 It will also fill $self->{invoice_amount_suggestion} with either the open
911 amount, or if with_skonto_pt is selected, with amount_less_skonto, so the
912 template can fill the input with the likely amount.
915 my $ar = invoice( invnumber => '257');
916 $ar->get_payment_suggestions;
917 print $ar->{invoice_amount_suggestion} . "\n";
919 pp $ar->{payment_select_options}
922 # 'display' => 'ohne Skonto',
923 # 'payment_type' => 'without_skonto'
926 # 'display' => 'mit Skonto nach ZB',
927 # 'payment_type' => 'with_skonto_pt',
932 The resulting array $ar->{payment_select_options} can be used in a template
933 select_tag using value_key and title_key:
935 [% L.select_tag('payment_type_' _ loop.count, invoice.payment_select_options, value_key => 'payment_type', title_key => 'display', id => 'payment_type_' _ loop.count) %]
937 It would probably make sense to have different rules for the pre-selected items
938 for sales and purchase, and to also make these rules configurable in the
939 defaults. E.g. when creating a SEPA bank transfer for vendor invoices a company
940 might always want to pay quickly making use of skonto, while another company
941 might always want to pay as late as possible.
943 =item C<get_payment_select_options_for_bank_transaction $banktransaction_id %params>
945 Make suggestion for a skonto payment type by returning an HTML blob of the options
946 of a HTML drop-down select with the most likely option preselected.
948 This is a helper function for BankTransaction/ajax_payment_suggestion.
950 We are working with an existing payment, so difference_as_skonto never makes sense.
952 If skonto is possible (skonto_date exists), add two possibilities:
953 without_skonto and with_skonto_pt if payment date is within skonto_date,
954 preselect with_skonto_pt, otherwise preselect without skonto.
958 =head1 TODO AND CAVEATS
964 when looking at open amount, maybe consider that there may already be queued
965 amounts in SEPA Export
969 Can only handle default currency.
975 G. Richardson E<lt>grichardson@kivitendo-premium.de<gt>