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 transactions 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);
157 $new_acc_trans->save;
159 $reference_amount -= abs($amount);
160 $paid_amount += -1 * $amount;
161 $skonto_amount_check -= $skonto_booking->{'skonto_amount'};
163 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;
169 if ( $params{payment_type} eq 'difference_as_skonto' ) {
170 $arap_amount = $total_open_amount;
171 } elsif ( $params{payment_type} eq 'without_skonto' ) {
172 $arap_amount = $rounded_params_amount;
173 } elsif ( $params{payment_type} eq 'with_skonto_pt' ) {
174 # this should be amount + sum(amount+skonto), but while we only allow
175 # with_skonto_pt for completely unpaid invoices we just use the value
177 $arap_amount = $total_open_amount;
180 # regardless of payment_type there is always only exactly one arap booking
181 # TODO: compare $arap_amount to running total
182 my $arap_booking= SL::DB::AccTransaction->new(trans_id => $self->id,
183 chart_id => $reference_account->id,
184 chart_link => $reference_account->link,
185 amount => $arap_amount * $mult,
186 transdate => $transdate_obj,
187 source => '', #$params{source},
189 tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
192 $self->paid($self->paid+$paid_amount) if $paid_amount;
193 $self->datepaid($transdate_obj);
198 if ( ( $self->invoice && $::instance_conf->get_datev_check_on_sales_invoice ) ||
199 ( !$self->invoice && $::instance_conf->get_datev_check_on_ar_transaction )) {
203 if ( ( $self->invoice && $::instance_conf->get_datev_check_on_purchase_invoice ) ||
204 ( !$self->invoice && $::instance_conf->get_datev_check_on_ap_transaction )) {
209 if ( $datev_check ) {
211 my $datev = SL::DATEV->new(
212 exporttype => DATEV_ET_BUCHUNGEN,
213 format => DATEV_FORMAT_KNE,
215 trans_id => $self->{id},
218 $datev->clean_temporary_directories;
221 if ($datev->errors) {
222 # this exception should be caught by do_transaction, which handles the rollback
223 die join "\n", $::locale->text('DATEV check returned errors:'), $datev->errors;
227 }) || die t8('error while paying invoice #1 : ', $self->invnumber) . $db->error . "\n";
236 my $is_sales = ref($self) eq 'SL::DB::Invoice';
241 return undef unless ref $self->payment_terms;
242 return undef unless $self->payment_terms->terms_skonto > 0;
243 $skonto_date = DateTime->from_object(object => $self->transdate)->add(days => $self->payment_terms->terms_skonto);
245 return undef unless ref $self->vendor->payment_terms;
246 return undef unless $self->vendor->payment_terms->terms_skonto > 0;
247 $skonto_date = DateTime->from_object(object => $self->transdate)->add(days => $self->vendor->payment_terms->terms_skonto);
253 sub reference_account {
256 my $is_sales = ref($self) eq 'SL::DB::Invoice';
258 require SL::DB::Manager::AccTransaction;
260 my $link_filter = $is_sales ? 'AR' : 'AP';
262 my $acc_trans = SL::DB::Manager::AccTransaction->find_by(
263 trans_id => $self->id,
264 SL::DB::Manager::AccTransaction->chart_link_filter("$link_filter")
267 return undef unless ref $acc_trans;
269 my $reference_account = SL::DB::Manager::Chart->find_by(id => $acc_trans->chart_id);
271 return $reference_account;
274 sub reference_amount {
277 my $is_sales = ref($self) eq 'SL::DB::Invoice';
279 require SL::DB::Manager::AccTransaction;
281 my $link_filter = $is_sales ? 'AR' : 'AP';
283 my $acc_trans = SL::DB::Manager::AccTransaction->find_by(
284 trans_id => $self->id,
285 SL::DB::Manager::AccTransaction->chart_link_filter("$link_filter")
288 return undef unless ref $acc_trans;
290 # this should be the same as $self->amount
291 return $acc_trans->amount;
298 # in the future maybe calculate this from acc_trans
300 # if the difference is 0.01 Cent this may end up as 0.009999999999998
301 # numerically, so round this value when checking for cent threshold >= 0.01
303 return $self->amount - $self->paid;
309 return 0 if $self->amount == 0;
311 if ( $self->open_amount < 0 ) {
312 # overpaid, currently treated identically
313 $open_percent = $self->open_amount * 100 / $self->amount;
315 $open_percent = $self->open_amount * 100 / $self->amount;
318 return _round($open_percent) || 0;
324 return $self->amount - $self->amount_less_skonto;
327 sub remaining_skonto_days {
330 return undef unless ref $self->skonto_date;
332 my $dur = DateTime::Duration->new($self->skonto_date - DateTime->today);
333 return $dur->delta_days();
340 my $is_sales = ref($self) eq 'SL::DB::Invoice';
342 my $percent_skonto = 0;
345 return undef unless ref $self->payment_terms;
346 return undef unless $self->payment_terms->percent_skonto > 0;
347 $percent_skonto = $self->payment_terms->percent_skonto;
349 return undef unless ref $self->vendor->payment_terms;
350 return undef unless $self->vendor->payment_terms->terms_skonto > 0;
351 $percent_skonto = $self->vendor->payment_terms->percent_skonto;
354 return $percent_skonto;
357 sub amount_less_skonto {
358 # amount that has to be paid if skonto applies, always return positive rounded values
359 # the result is rounded so we can directly compare it with the user input
362 my $is_sales = ref($self) eq 'SL::DB::Invoice';
364 my $percent_skonto = $self->percent_skonto;
366 return _round($self->amount - ( $self->amount * $percent_skonto) );
370 sub check_skonto_configuration {
373 my $is_sales = ref($self) eq 'SL::DB::Invoice';
375 my $skonto_configured = 1; # default is assume skonto works
377 my $transactions = $self->transactions;
378 foreach my $transaction (@{ $transactions }) {
379 # find all transactions with an AR_amount or AP_amount link
380 my $tax = SL::DB::Manager::Tax->get_first( where => [taxkey => $transaction->{taxkey}]);
381 croak "no tax for taxkey " . $transaction->{taxkey} unless ref $tax;
383 $transaction->{chartlinks} = { map { $_ => 1 } split(m/:/, $transaction->{chart_link}) };
384 if ( $is_sales && $transaction->{chartlinks}->{AR_amount} ) {
385 $skonto_configured = 0 unless $tax->skonto_sales_chart_id;
386 } elsif ( !$is_sales && $transaction->{chartlinks}->{AP_amount}) {
387 $skonto_configured = 0 unless $tax->skonto_purchase_chart_id;
391 return $skonto_configured;
394 sub open_sepa_transfer_amount {
397 my ($vc, $key, $type);
398 if ( ref($self) eq 'SL::DB::Invoice' ) {
408 my $sql = qq|SELECT SUM(sei.amount) AS amount FROM sepa_export_items sei | .
409 qq| LEFT JOIN sepa_export se ON (sei.sepa_export_id = se.id) | .
410 qq| WHERE $key = ? AND NOT se.closed AND (se.vc = '$vc') |;
412 my ($open_sepa_amount) = $self->db->dbh->selectrow_array($sql, undef, $self->id);
414 return $open_sepa_amount || 0;
422 # TODO: use param for amount, may also want to calculate skonto_amounts by
423 # passing percentage in the future
425 my $amount = shift || $self->skonto_amount;
427 croak "no amount passed to skonto_charts" unless abs(_round($amount)) >= 0.01;
429 # TODO: check whether there are negative values in invoice / acc_trans ... credited items
431 # don't check whether skonto applies, because user may want to override this
432 # return undef unless $self->percent_skonto; # for is_sales
433 # return undef unless $self->vendor->payment_terms->percent_skonto; # for purchase
435 my $is_sales = ref($self) eq 'SL::DB::Invoice';
437 my $mult = $is_sales ? 1 : -1; # multiplier for getting the right sign
439 my @skonto_charts; # resulting array with all income/expense accounts that have to be corrected
441 # calculate effective skonto (percentage) in difference_as_skonto mode
442 # only works if there are no negative acc_trans values
443 my $effective_skonto_rate = $amount ? $amount / $self->amount : 0;
446 my $total_skonto_amount = 0;
447 my $total_rounding_error = 0;
449 my $reference_ARAP_amount = 0;
451 my $transactions = $self->transactions;
452 foreach my $transaction (@{ $transactions }) {
453 # find all transactions with an AR_amount or AP_amount link
454 $transaction->{chartlinks} = { map { $_ => 1 } split(m/:/, $transaction->{chart_link}) };
455 # second condition is that we can determine an automatic Skonto account for each AR_amount entry
457 if ( ( $is_sales && $transaction->{chartlinks}->{AR_amount} ) or ( !$is_sales && $transaction->{chartlinks}->{AP_amount}) ) {
458 # $reference_ARAP_amount += $transaction->{amount} * $mult;
460 # quick hack that works around problem of non-unique tax keys in SKR04
461 my $tax = SL::DB::Manager::Tax->get_first( where => [taxkey => $transaction->{taxkey}]);
462 croak "no tax for taxkey " . $transaction->{taxkey} unless ref $tax;
465 die t8('no skonto_chart configured for taxkey #1 : #2 : #3', $transaction->{taxkey} , $tax->taxdescription , $tax->rate*100) unless ref $tax->skonto_sales_chart;
467 die t8('no skonto_chart configured for taxkey #1 : #2 : #3', $transaction->{taxkey} , $tax->taxdescription , $tax->rate*100) unless ref $tax->skonto_purchase_chart;
470 my $skonto_amount_unrounded;
472 my $skonto_percent_abs = $self->amount ? abs($transaction->amount * (1 + $tax->rate) * 100 / $self->amount) : 0;
474 my $transaction_amount = abs($transaction->{amount} * (1 + $tax->rate));
475 my $transaction_skonto_percent = abs($transaction_amount/$self->amount); # abs($transaction->{amount} * (1 + $tax->rate));
478 $skonto_amount_unrounded = abs($amount * $transaction_skonto_percent);
479 my $skonto_amount_rounded = _round($skonto_amount_unrounded);
480 my $rounding_error = $skonto_amount_unrounded - $skonto_amount_rounded;
481 my $rounded_rounding_error = _round($rounding_error);
483 $total_rounding_error += $rounding_error;
484 $total_skonto_amount += $skonto_amount_rounded;
487 # skonto_percent_abs: relative part of amount + tax to the total invoice amount
488 'skonto_percent_abs' => $skonto_percent_abs,
489 'chart_id' => $is_sales ? $tax->skonto_sales_chart->id : $tax->skonto_purchase_chart->id,
490 'skonto_amount' => $skonto_amount_rounded,
491 # 'rounding_error' => $rounding_error,
492 # 'rounded_rounding_error' => $rounded_rounding_error,
495 push @skonto_charts, $rec;
499 # if the rounded sum of all rounding_errors reaches 0.01 this sum is
500 # subtracted from the largest skonto_amount
501 my $rounded_total_rounding_error = abs(_round($total_rounding_error));
503 if ( $rounded_total_rounding_error > 0 ) {
504 my $highest_amount_pos = 0;
505 my $highest_amount = 0;
507 foreach my $ref ( @skonto_charts ) {
509 if ( $ref->{skonto_amount} > $highest_amount ) {
510 $highest_amount = $ref->{skonto_amount};
511 $highest_amount_pos = $i;
514 $skonto_charts[$i]->{skonto_amount} -= $rounded_total_rounding_error;
517 return @skonto_charts;
521 sub within_skonto_period {
523 my $dateref = shift || DateTime->now->truncate( to => 'day' );
525 return undef unless ref $dateref eq 'DateTime';
526 return 0 unless $self->skonto_date;
528 # return 1 if requested date (or today) is inside skonto period
529 # this will also return 1 if date is before the invoice date
530 return $dateref <= $self->skonto_date;
533 sub valid_skonto_amount {
535 my $amount = shift || 0;
536 my $max_skonto_percent = 0.10;
538 return 0 unless $amount > 0;
540 # does this work for other currencies?
541 return ($self->amount*$max_skonto_percent) > $amount;
544 sub get_payment_select_options_for_bank_transaction {
545 my ($self, $bt_id, %params) = @_;
547 my $bt = SL::DB::Manager::BankTransaction->find_by( id => $bt_id );
550 my $open_amount = $self->open_amount;
553 if ( $open_amount && # invoice amount not 0
554 $self->skonto_date && # check whether skonto applies
555 abs(abs($self->amount_less_skonto) - abs($bt->amount)) < 0.01 &&
556 $self->check_skonto_configuration) {
557 if ( $self->within_skonto_period($bt->transdate) ) {
558 push(@options, { payment_type => 'without_skonto', display => t8('without skonto') });
559 push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt'), selected => 1 });
561 push(@options, { payment_type => 'without_skonto', display => t8('without skonto') , selected => 1 });
562 push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt')});
571 sub get_payment_suggestions {
573 my ($self, %params) = @_;
575 my $open_amount = $self->open_amount;
576 $open_amount -= $self->open_sepa_transfer_amount if $params{sepa};
578 $self->{invoice_amount_suggestion} = $open_amount;
579 undef $self->{payment_select_options};
580 push(@{$self->{payment_select_options}} , { payment_type => 'without_skonto', display => t8('without skonto') });
581 if ( $self->within_skonto_period ) {
582 # If there have been no payments yet suggest amount_less_skonto, otherwise the open amount
583 if ( $open_amount && # invoice amount not 0
584 $open_amount == $self->amount && # no payments yet, or sum of payments and sepa export amounts is zero
585 $self->check_skonto_configuration) {
586 $self->{invoice_amount_suggestion} = $self->amount_less_skonto;
587 push(@{$self->{payment_select_options}} , { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt') , selected => 1 });
589 if ( ( $self->valid_skonto_amount($self->open_amount) || $self->valid_skonto_amount($open_amount) ) and not $params{sepa} ) {
590 $self->{invoice_amount_suggestion} = $open_amount;
591 # only suggest difference_as_skonto if open_amount exactly matches skonto_amount
592 # AND we aren't in SEPA mode
594 $selected = 1 if _round($open_amount) == _round($self->skonto_amount);
595 push(@{$self->{payment_select_options}} , { payment_type => 'difference_as_skonto', display => t8('difference as skonto') , selected => $selected });
599 # invoice was configured with skonto, but skonto date has passed, or no skonto available
600 $self->{invoice_amount_suggestion} = $open_amount;
601 # difference_as_skonto doesn't make any sense for SEPA transfer, as this doesn't cause any actual payment
602 if ( $self->valid_skonto_amount($self->open_amount) && not $params{sepa} ) {
603 push(@{$self->{payment_select_options}} , { payment_type => 'difference_as_skonto', display => t8('difference as skonto') , selected => 0 });
612 return unless $self->id;
614 require SL::DB::AccTransaction;
615 SL::DB::Manager::AccTransaction->get_all(query => [ trans_id => $self->id ]);
618 sub validate_payment_type {
619 my $payment_type = shift;
621 my %allowed_payment_types = map { $_ => 1 } qw(without_skonto with_skonto_pt difference_as_skonto);
622 croak "illegal payment type: $payment_type, must be one of: " . join(' ', keys %allowed_payment_types) unless $allowed_payment_types{ $payment_type };
630 return $::form->round_amount($value, 2);
641 SL::DB::Helper::Payment Mixin providing helper methods for paying C<Invoice>
642 and C<PurchaseInvoice> objects and using skonto
646 In addition to actually causing a payment via pay_invoice this helper contains
647 many methods that help in determining information about the status of the
648 invoice, such as the remaining open amount, whether skonto applies, until which
649 date skonto applies, the skonto amount and relative percentages, what to do
652 To prevent duplicate code this was all added in this mixin rather than directly
653 in SL::DB::Invoice and SL::DB::PurchaseInvoice.
657 =item C<pay_invoice %params>
659 Create a payment booking for an existing invoice object (type ar/ap/is/ir) via
660 a configured bank account.
662 This function deals with all the acc_trans entries and also updates paid and datepaid.
666 my $ap = SL::DB::Manager::PurchaseInvoice->find_by( invnumber => '1');
667 my $bank = SL::DB::Manager::BankAccount->find_by( name => 'Bank');
668 $ap->pay_invoice(chart_id => $bank->chart_id,
669 amount => $ap->open_amount,
670 transdate => DateTime->now->to_kivitendo,
673 payment_type => 'without_skonto', # default if not specified
677 $ap->pay_invoice(chart_id => $bank->chart_id,
678 amount => $ap->amount, # doesn't need to be specified
679 transdate => DateTime->now->to_kivitendo,
682 payment_type => 'with_skonto',
685 Allowed payment types are:
686 without_skonto with_skonto_pt difference_as_skonto
688 The option C<payment_type> allows for a basic skonto mechanism.
690 C<without_skonto> is the default mode, "amount" is paid to the account in
691 chart_id. This can also be used for partial payments and corrections via
694 C<with_skonto_pt> can't be used for partial payments. When used on unpaid
695 invoices the whole amount is paid, with the skonto part automatically being
696 booked according to the skonto chart configured in the tax settings for each
697 tax key. If an amount is passed it is ignored and the actual configured skonto
700 C<difference_as_skonto> can only be used after partial payments have been made,
701 the whole specified amount is booked according to the skonto charts configured
702 in the tax settings for each tax key.
704 So passing amount doesn't have any effect for the cases C<with_skonto_pt> and
705 C<difference_as_skonto>, as all necessary values are taken from the stored
708 The skonto modes automatically calculate the relative amounts for a mix of
709 taxes, e.g. items with 7% and 19% in one invoice. There is a helper method
710 skonto_charts, which calculates the relative percentages according to the
711 amounts in acc_trans (which are grouped by tax).
713 There is currently no way of excluding certain items in an invoice from having
714 skonto applied to them. If this feature was added to parts the calculation
715 method of relative skonto would have to be completely rewritten using the
716 invoice items rather than acc_trans.
718 The skonto modes also still don't automatically correct the tax, this still has
719 to be done manually. Therefore all payments generated by pay_invoice have
722 There is currently no way to directly pay an invoice via this method if the
723 effective skonto differs from the skonto according to the payment terms
724 configured for the invoice/vendor.
726 In this case one has to pay in two steps: first the actual paid amount via
727 "without skonto", and then the remainder via "difference_as_skonto". The user
728 has to there actively decide whether to accept the differing skonto.
730 Because of the way skonto_charts works the calculation doesn't work if there
731 are negative values in acc_trans. E.g. one invoice with a positive value for
732 19% tax and a negative value for the acc_trans line with 7%
734 Skonto doesn't/shouldn't apply if the invoice contains credited items.
736 =item C<reference_account>
738 Returns a chart object which is the chart of the invoice with link AR or AP.
740 Example (1200 is the AR account for SKR04):
741 my $invoice = invoice(invnumber => '144');
742 $invoice->reference_account->accno
745 =item C<percent_skonto>
747 Returns the configured skonto percentage of the payment terms of an invoice,
748 e.g. 0.02 for 2%. Payment terms come from invoice settings for ar, from vendor
751 =item C<amount_less_skonto>
753 If the invoice has a payment term (via ar for sales, via vendor for purchase),
754 calculate the amount to be paid in the case of skonto. This doesn't check,
755 whether skonto applies (i.e. skonto doesn't wasn't exceeded), it just subtracts
756 the configured percentage (e.g. 2%) from the total amount.
758 The returned value is rounded to two decimals.
762 The date up to which skonto may be taken. This is calculated from the invoice
763 date + the number of days configured in the payment terms.
765 This method can also be used to determine whether skonto applies for the
766 invoice, as it returns undef if there is no payment term or skonto days is set
769 =item C<within_skonto_period [DATE]>
773 Checks whether the invoice has payment terms configured, and whether the date
774 is within the skonto max date. If no date is passed the current date is used.
776 You can also pass a dateref object as a parameter to check whether skonto
777 applies for that date rather than the current date.
779 =item C<valid_skonto_amount>
781 Takes an amount as an argument and checks whether the amount is less than 10%
782 of the total amount of the invoice. The value of 10% is currently hardcoded in
783 the method. This method is currently used to check whether to offer the payment
784 option "difference as skonto".
787 if ( $invoice->valid_skonto_amount($invoice->open_amount) ) {
791 =item C<skonto_charts [$amount]>
793 Returns a list of chart_ids and some calculated numbers that can be used for
794 paying the invoice with skonto. This function will automatically calculate the
795 relative skonto amounts even if the invoice contains several types of taxes
799 my $invoice = SL::DB::Manager::Invoice->find_by(invnumber => '211');
800 my @skonto_charts = $invoice->skonto_charts;
802 or with the total skonto amount as an argument:
803 my @skonto_charts = $invoice->skonto_charts($invoice->open_amount);
805 The following values are generated for each chart:
811 The chart id of the skonto amount to be booked.
813 =item C<skonto_amount>
815 The total amount to be paid to the account
817 =item C<skonto_percent>
819 The relative percentage of that skonto chart. This can be useful if the actual
820 ekonto that is paid deviates from the granted skonto, e.g. customer effectively
821 pays 2.6% skonto instead of 2%, and we accept this. Then we can still calculate
822 the relative skonto amounts for different taxes based on the absolute
823 percentages. Used for case C<difference_as_skonto>.
825 =item C<skonto_percent_abs>
827 The absolute percentage of that skonto chart in relation to the total amount.
828 Used to calculate skonto_amount for case C<with_skonto_pt>.
832 If the invoice contains several types of taxes then skonto_charts can be used
833 to calculate the relative amounts.
835 Example in console of an invoice with 100 Euro at 7% and 100 Euro at 19% with
838 my $invoice = invoice(invnumber => '144');
841 $invoice->payment_terms->percent_skonto
843 $invoice->skonto_charts
844 pp $invoice->skonto_charts
847 # 'skonto_amount' => '2.14',
848 # 'skonto_percent' => '47.3451327433627'
852 # 'skonto_amount' => '2.38',
853 # 'skonto_percent' => '52.654867256637'
856 C<skonto_charts> always returns positive values (abs) for C<skonto_amount> and
859 C<skonto_charts> generates one entry for each acc_trans entry. ar and ap
860 bookings only have one acc_trans entry for each taxkey (e.g. 7% and 19%). This
861 is because all the items are grouped according to the Buchungsgruppen mechanism
862 and the totals are written to acc_trans. For is and ir it is possible to have
863 several acc_trans entries with the same tax. In this case skonto_charts
864 generates a skonto booking for each acc_trans income/expense entry.
866 In the future this function may also be used to calculate the corrections for
871 Unrounded total open amount of invoice (amount - paid).
872 Doesn't take into account pending SEPA transfers.
874 =item C<open_percent>
876 Percentage of the invoice that is still unpaid, e.g. 100,00 if no payments have
877 been made yet, 0,00 if fully paid.
879 =item C<remaining_skonto_days>
881 How many days skonto can still be taken, calculated from current day. Returns 0
882 if current day is the max skonto date, and negative number if skonto date has
885 Returns undef if skonto is not configured for that invoice.
887 =item C<get_payment_suggestions %params>
889 Creates data intended for an L.select_tag dropdown that can be used in a
890 template. Depending on the rules it will choose from the options
891 without_skonto, with_skonto_pt and difference_as_skonto, and select the most
894 If the parameter "sepa" is passed, the SEPA export payments that haven't been
895 executed yet are considered when determining the open amount of the invoice.
897 The current rules are:
901 =item * without_skonto is always an option
903 =item * with_skonto_pt is only offered if there haven't been any payments yet and the current date is within the skonto period.
905 =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.
907 with_skonto_pt will only be offered, if all the AR_amount/AP_amount have a
908 taxkey with a configured skonto chart
912 It will also fill $self->{invoice_amount_suggestion} with either the open
913 amount, or if with_skonto_pt is selected, with amount_less_skonto, so the
914 template can fill the input with the likely amount.
917 my $ar = invoice( invnumber => '257');
918 $ar->get_payment_suggestions;
919 print $ar->{invoice_amount_suggestion} . "\n";
921 pp $ar->{payment_select_options}
924 # 'display' => 'ohne Skonto',
925 # 'payment_type' => 'without_skonto'
928 # 'display' => 'mit Skonto nach ZB',
929 # 'payment_type' => 'with_skonto_pt',
934 The resulting array $ar->{payment_select_options} can be used in a template
935 select_tag using value_key and title_key:
937 [% L.select_tag('payment_type_' _ loop.count, invoice.payment_select_options, value_key => 'payment_type', title_key => 'display', id => 'payment_type_' _ loop.count) %]
939 It would probably make sense to have different rules for the pre-selected items
940 for sales and purchase, and to also make these rules configurable in the
941 defaults. E.g. when creating a SEPA bank transfer for vendor invoices a company
942 might always want to pay quickly making use of skonto, while another company
943 might always want to pay as late as possible.
945 =item C<transactions>
947 Returns all acc_trans Objects of an ar/ap object.
949 Example in console to print account numbers and booked amounts of an invoice:
950 my $invoice = invoice(invnumber => '144');
951 foreach my $acc_trans ( @{ $invoice->transactions } ) {
952 print $acc_trans->chart->accno . " : " . $acc_trans->amount_as_number . "\n"
962 =item C<get_payment_select_options_for_bank_transaction $banktransaction_id %params>
964 Make suggestion for a skonto payment type by returning an HTML blob of the options
965 of a HTML drop-down select with the most likely option preselected.
967 This is a helper function for BankTransaction/ajax_payment_suggestion.
969 We are working with an existing payment, so difference_as_skonto never makes sense.
971 If skonto is possible (skonto_date exists), add two possibilities:
972 without_skonto and with_skonto_pt if payment date is within skonto_date,
973 preselect with_skonto_pt, otherwise preselect without skonto.
977 =head1 TODO AND CAVEATS
983 when looking at open amount, maybe consider that there may already be queued
984 amounts in SEPA Export
988 Can only handle default currency.
994 G. Richardson E<lt>grichardson@kivitendo-premium.de<gt>