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 create_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 if ( $params{payment_type} eq 'difference_as_skonto' ) {
166 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;
173 if ( $params{payment_type} eq 'difference_as_skonto' ) {
174 $arap_amount = $total_open_amount;
175 } elsif ( $params{payment_type} eq 'without_skonto' ) {
176 $arap_amount = $rounded_params_amount;
177 } elsif ( $params{payment_type} eq 'with_skonto_pt' ) {
178 # this should be amount + sum(amount+skonto), but while we only allow
179 # with_skonto_pt for completely unpaid invoices we just use the value
181 $arap_amount = $total_open_amount;
184 # regardless of payment_type there is always only exactly one arap booking
185 # TODO: compare $arap_amount to running total
186 my $arap_booking= SL::DB::AccTransaction->new(trans_id => $self->id,
187 chart_id => $reference_account->id,
188 chart_link => $reference_account->link,
189 amount => $arap_amount * $mult,
190 transdate => $transdate_obj,
191 source => '', #$params{source},
193 tax_id => SL::DB::Manager::Tax->find_by(taxkey => 0)->id);
196 $self->paid($self->paid+$paid_amount) if $paid_amount;
197 $self->datepaid($transdate_obj);
200 # make sure transactions will be reloaded the next time $self->transactions
201 # is called, as pay_invoice saves the acc_trans objects individually rather
202 # than adding them to the transaction relation array.
203 $self->forget_related('transactions');
207 if ( ( $self->invoice && $::instance_conf->get_datev_check_on_sales_invoice ) ||
208 ( !$self->invoice && $::instance_conf->get_datev_check_on_ar_transaction )) {
212 if ( ( $self->invoice && $::instance_conf->get_datev_check_on_purchase_invoice ) ||
213 ( !$self->invoice && $::instance_conf->get_datev_check_on_ap_transaction )) {
218 if ( $datev_check ) {
220 my $datev = SL::DATEV->new(
221 exporttype => DATEV_ET_BUCHUNGEN,
222 format => DATEV_FORMAT_KNE,
224 trans_id => $self->{id},
227 $datev->clean_temporary_directories;
230 if ($datev->errors) {
231 # this exception should be caught by do_transaction, which handles the rollback
232 die join "\n", $::locale->text('DATEV check returned errors:'), $datev->errors;
236 }) || die t8('error while paying invoice #1 : ', $self->invnumber) . $db->error . "\n";
245 my $is_sales = ref($self) eq 'SL::DB::Invoice';
250 return undef unless ref $self->payment_terms;
251 return undef unless $self->payment_terms->terms_skonto > 0;
252 $skonto_date = DateTime->from_object(object => $self->transdate)->add(days => $self->payment_terms->terms_skonto);
254 return undef unless ref $self->vendor->payment_terms;
255 return undef unless $self->vendor->payment_terms->terms_skonto > 0;
256 $skonto_date = DateTime->from_object(object => $self->transdate)->add(days => $self->vendor->payment_terms->terms_skonto);
262 sub reference_account {
265 my $is_sales = ref($self) eq 'SL::DB::Invoice';
267 require SL::DB::Manager::AccTransaction;
269 my $link_filter = $is_sales ? 'AR' : 'AP';
271 my $acc_trans = SL::DB::Manager::AccTransaction->find_by(
272 trans_id => $self->id,
273 SL::DB::Manager::AccTransaction->chart_link_filter("$link_filter")
276 return undef unless ref $acc_trans;
278 my $reference_account = SL::DB::Manager::Chart->find_by(id => $acc_trans->chart_id);
280 return $reference_account;
283 sub reference_amount {
286 my $is_sales = ref($self) eq 'SL::DB::Invoice';
288 require SL::DB::Manager::AccTransaction;
290 my $link_filter = $is_sales ? 'AR' : 'AP';
292 my $acc_trans = SL::DB::Manager::AccTransaction->find_by(
293 trans_id => $self->id,
294 SL::DB::Manager::AccTransaction->chart_link_filter("$link_filter")
297 return undef unless ref $acc_trans;
299 # this should be the same as $self->amount
300 return $acc_trans->amount;
307 # in the future maybe calculate this from acc_trans
309 # if the difference is 0.01 Cent this may end up as 0.009999999999998
310 # numerically, so round this value when checking for cent threshold >= 0.01
312 return $self->amount - $self->paid;
318 return 0 if $self->amount == 0;
320 if ( $self->open_amount < 0 ) {
321 # overpaid, currently treated identically
322 $open_percent = $self->open_amount * 100 / $self->amount;
324 $open_percent = $self->open_amount * 100 / $self->amount;
327 return _round($open_percent) || 0;
333 return $self->amount - $self->amount_less_skonto;
336 sub remaining_skonto_days {
339 return undef unless ref $self->skonto_date;
341 my $dur = DateTime::Duration->new($self->skonto_date - DateTime->today);
342 return $dur->delta_days();
349 my $is_sales = ref($self) eq 'SL::DB::Invoice';
351 my $percent_skonto = 0;
354 return undef unless ref $self->payment_terms;
355 return undef unless $self->payment_terms->percent_skonto > 0;
356 $percent_skonto = $self->payment_terms->percent_skonto;
358 return undef unless ref $self->vendor->payment_terms;
359 return undef unless $self->vendor->payment_terms->terms_skonto > 0;
360 $percent_skonto = $self->vendor->payment_terms->percent_skonto;
363 return $percent_skonto;
366 sub amount_less_skonto {
367 # amount that has to be paid if skonto applies, always return positive rounded values
368 # the result is rounded so we can directly compare it with the user input
371 my $is_sales = ref($self) eq 'SL::DB::Invoice';
373 my $percent_skonto = $self->percent_skonto || 0;
375 return _round($self->amount - ( $self->amount * $percent_skonto) );
379 sub check_skonto_configuration {
382 my $is_sales = ref($self) eq 'SL::DB::Invoice';
384 my $skonto_configured = 1; # default is assume skonto works
386 # my $transactions = $self->transactions;
387 foreach my $transaction (@{ $self->transactions }) {
388 # find all transactions with an AR_amount or AP_amount link
389 my $tax = SL::DB::Manager::Tax->get_first( where => [taxkey => $transaction->{taxkey}]);
390 croak "no tax for taxkey " . $transaction->{taxkey} unless ref $tax;
392 $transaction->{chartlinks} = { map { $_ => 1 } split(m/:/, $transaction->{chart_link}) };
393 if ( $is_sales && $transaction->{chartlinks}->{AR_amount} ) {
394 $skonto_configured = 0 unless $tax->skonto_sales_chart_id;
395 } elsif ( !$is_sales && $transaction->{chartlinks}->{AP_amount}) {
396 $skonto_configured = 0 unless $tax->skonto_purchase_chart_id;
400 return $skonto_configured;
403 sub open_sepa_transfer_amount {
406 my ($vc, $key, $type);
407 if ( ref($self) eq 'SL::DB::Invoice' ) {
417 my $sql = qq|SELECT SUM(sei.amount) AS amount FROM sepa_export_items sei | .
418 qq| LEFT JOIN sepa_export se ON (sei.sepa_export_id = se.id) | .
419 qq| WHERE $key = ? AND NOT se.closed AND (se.vc = '$vc') |;
421 my ($open_sepa_amount) = $self->db->dbh->selectrow_array($sql, undef, $self->id);
423 return $open_sepa_amount || 0;
431 # TODO: use param for amount, may also want to calculate skonto_amounts by
432 # passing percentage in the future
434 my $amount = shift || $self->skonto_amount;
436 croak "no amount passed to skonto_charts" unless abs(_round($amount)) >= 0.01;
438 # TODO: check whether there are negative values in invoice / acc_trans ... credited items
440 # don't check whether skonto applies, because user may want to override this
441 # return undef unless $self->percent_skonto; # for is_sales
442 # return undef unless $self->vendor->payment_terms->percent_skonto; # for purchase
444 my $is_sales = ref($self) eq 'SL::DB::Invoice';
446 my $mult = $is_sales ? 1 : -1; # multiplier for getting the right sign
448 my @skonto_charts; # resulting array with all income/expense accounts that have to be corrected
450 # calculate effective skonto (percentage) in difference_as_skonto mode
451 # only works if there are no negative acc_trans values
452 my $effective_skonto_rate = $amount ? $amount / $self->amount : 0;
455 my $total_skonto_amount = 0;
456 my $total_rounding_error = 0;
458 my $reference_ARAP_amount = 0;
460 # my $transactions = $self->transactions;
461 foreach my $transaction (@{ $self->transactions }) {
462 # find all transactions with an AR_amount or AP_amount link
463 $transaction->{chartlinks} = { map { $_ => 1 } split(m/:/, $transaction->{chart_link}) };
464 # second condition is that we can determine an automatic Skonto account for each AR_amount entry
466 if ( ( $is_sales && $transaction->{chartlinks}->{AR_amount} ) or ( !$is_sales && $transaction->{chartlinks}->{AP_amount}) ) {
467 # $reference_ARAP_amount += $transaction->{amount} * $mult;
469 # quick hack that works around problem of non-unique tax keys in SKR04
470 my $tax = SL::DB::Manager::Tax->get_first( where => [taxkey => $transaction->{taxkey}]);
471 croak "no tax for taxkey " . $transaction->{taxkey} unless ref $tax;
474 die t8('no skonto_chart configured for taxkey #1 : #2 : #3', $transaction->{taxkey} , $tax->taxdescription , $tax->rate*100) unless ref $tax->skonto_sales_chart;
476 die t8('no skonto_chart configured for taxkey #1 : #2 : #3', $transaction->{taxkey} , $tax->taxdescription , $tax->rate*100) unless ref $tax->skonto_purchase_chart;
479 my $skonto_amount_unrounded;
481 my $skonto_percent_abs = $self->amount ? abs($transaction->amount * (1 + $tax->rate) * 100 / $self->amount) : 0;
483 my $transaction_amount = abs($transaction->{amount} * (1 + $tax->rate));
484 my $transaction_skonto_percent = abs($transaction_amount/$self->amount); # abs($transaction->{amount} * (1 + $tax->rate));
487 $skonto_amount_unrounded = abs($amount * $transaction_skonto_percent);
488 my $skonto_amount_rounded = _round($skonto_amount_unrounded);
489 my $rounding_error = $skonto_amount_unrounded - $skonto_amount_rounded;
490 my $rounded_rounding_error = _round($rounding_error);
492 $total_rounding_error += $rounding_error;
493 $total_skonto_amount += $skonto_amount_rounded;
496 # skonto_percent_abs: relative part of amount + tax to the total invoice amount
497 'skonto_percent_abs' => $skonto_percent_abs,
498 'chart_id' => $is_sales ? $tax->skonto_sales_chart->id : $tax->skonto_purchase_chart->id,
499 'skonto_amount' => $skonto_amount_rounded,
500 # 'rounding_error' => $rounding_error,
501 # 'rounded_rounding_error' => $rounded_rounding_error,
504 push @skonto_charts, $rec;
508 # if the rounded sum of all rounding_errors reaches 0.01 this sum is
509 # subtracted from the largest skonto_amount
510 my $rounded_total_rounding_error = abs(_round($total_rounding_error));
512 if ( $rounded_total_rounding_error > 0 ) {
513 my $highest_amount_pos = 0;
514 my $highest_amount = 0;
516 foreach my $ref ( @skonto_charts ) {
518 if ( $ref->{skonto_amount} > $highest_amount ) {
519 $highest_amount = $ref->{skonto_amount};
520 $highest_amount_pos = $i;
523 $skonto_charts[$i]->{skonto_amount} -= $rounded_total_rounding_error;
526 return @skonto_charts;
530 sub within_skonto_period {
532 my $dateref = shift || DateTime->now->truncate( to => 'day' );
534 return undef unless ref $dateref eq 'DateTime';
535 return 0 unless $self->skonto_date;
537 # return 1 if requested date (or today) is inside skonto period
538 # this will also return 1 if date is before the invoice date
539 return $dateref <= $self->skonto_date;
542 sub valid_skonto_amount {
544 my $amount = shift || 0;
545 my $max_skonto_percent = 0.10;
547 return 0 unless $amount > 0;
549 # does this work for other currencies?
550 return ($self->amount*$max_skonto_percent) > $amount;
553 sub get_payment_select_options_for_bank_transaction {
554 my ($self, $bt_id, %params) = @_;
556 my $bt = SL::DB::Manager::BankTransaction->find_by( id => $bt_id );
559 my $open_amount = $self->open_amount;
562 if ( $open_amount && # invoice amount not 0
563 $self->skonto_date && # check whether skonto applies
564 abs(abs($self->amount_less_skonto) - abs($bt->amount)) < 0.01 &&
565 $self->check_skonto_configuration) {
566 if ( $self->within_skonto_period($bt->transdate) ) {
567 push(@options, { payment_type => 'without_skonto', display => t8('without skonto') });
568 push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt'), selected => 1 });
570 push(@options, { payment_type => 'without_skonto', display => t8('without skonto') , selected => 1 });
571 push(@options, { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt')});
580 sub get_payment_suggestions {
582 my ($self, %params) = @_;
584 my $open_amount = $self->open_amount;
585 $open_amount -= $self->open_sepa_transfer_amount if $params{sepa};
587 $self->{invoice_amount_suggestion} = $open_amount;
588 undef $self->{payment_select_options};
589 push(@{$self->{payment_select_options}} , { payment_type => 'without_skonto', display => t8('without skonto') });
590 if ( $self->within_skonto_period ) {
591 # If there have been no payments yet suggest amount_less_skonto, otherwise the open amount
592 if ( $open_amount && # invoice amount not 0
593 $open_amount == $self->amount && # no payments yet, or sum of payments and sepa export amounts is zero
594 $self->check_skonto_configuration) {
595 $self->{invoice_amount_suggestion} = $self->amount_less_skonto;
596 push(@{$self->{payment_select_options}} , { payment_type => 'with_skonto_pt', display => t8('with skonto acc. to pt') , selected => 1 });
598 if ( ( $self->valid_skonto_amount($self->open_amount) || $self->valid_skonto_amount($open_amount) ) and not $params{sepa} ) {
599 $self->{invoice_amount_suggestion} = $open_amount;
600 # only suggest difference_as_skonto if open_amount exactly matches skonto_amount
601 # AND we aren't in SEPA mode
603 $selected = 1 if _round($open_amount) == _round($self->skonto_amount);
604 push(@{$self->{payment_select_options}} , { payment_type => 'difference_as_skonto', display => t8('difference as skonto') , selected => $selected });
608 # invoice was configured with skonto, but skonto date has passed, or no skonto available
609 $self->{invoice_amount_suggestion} = $open_amount;
610 # difference_as_skonto doesn't make any sense for SEPA transfer, as this doesn't cause any actual payment
611 if ( $self->valid_skonto_amount($self->open_amount) && not $params{sepa} ) {
612 push(@{$self->{payment_select_options}} , { payment_type => 'difference_as_skonto', display => t8('difference as skonto') , selected => 0 });
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 };
627 sub create_bank_transaction {
628 my ($self, %params) = @_;
630 require SL::DB::Chart;
631 require SL::DB::BankAccount;
634 if ( $params{chart_id} ) {
635 $bank_chart = SL::DB::Manager::Chart->find_by(chart_id => $params{chart_id}) or die "Can't find bank chart";
636 } elsif ( $::instance_conf->get_ar_paid_accno_id ) {
637 $bank_chart = SL::DB::Manager::Chart->find_by(id => $::instance_conf->get_ar_paid_accno_id);
639 $bank_chart = SL::DB::Manager::Chart->find_by(description => 'Bank') or die "Can't find bank chart";
641 my $bank_account = SL::DB::Manager::BankAccount->find_by(chart_id => $bank_chart->id) or die "Can't find bank account for chart";
643 my $multiplier = $self->is_sales ? 1 : -1;
644 my $amount = ($params{amount} || $self->amount) * $multiplier;
646 my $transdate = $params{transdate} || DateTime->today;
648 my $bt = SL::DB::BankTransaction->new(
649 local_bank_account_id => $bank_account->id,
650 remote_bank_code => $self->customervendor->bank_code,
651 remote_account_number => $self->customervendor->account_number,
652 transdate => $transdate,
653 valutadate => $transdate,
654 amount => $::form->round_amount($amount, 2),
655 currency => $self->currency->id,
656 remote_name => $self->customervendor->depositor,
657 purpose => $self->invnumber
665 return $::form->round_amount($value, 2);
676 SL::DB::Helper::Payment Mixin providing helper methods for paying C<Invoice>
677 and C<PurchaseInvoice> objects and using skonto
681 In addition to actually causing a payment via pay_invoice this helper contains
682 many methods that help in determining information about the status of the
683 invoice, such as the remaining open amount, whether skonto applies, until which
684 date skonto applies, the skonto amount and relative percentages, what to do
687 To prevent duplicate code this was all added in this mixin rather than directly
688 in SL::DB::Invoice and SL::DB::PurchaseInvoice.
692 =item C<pay_invoice %params>
694 Create a payment booking for an existing invoice object (type ar/ap/is/ir) via
695 a configured bank account.
697 This function deals with all the acc_trans entries and also updates paid and datepaid.
701 my $ap = SL::DB::Manager::PurchaseInvoice->find_by( invnumber => '1');
702 my $bank = SL::DB::Manager::BankAccount->find_by( name => 'Bank');
703 $ap->pay_invoice(chart_id => $bank->chart_id,
704 amount => $ap->open_amount,
705 transdate => DateTime->now->to_kivitendo,
708 payment_type => 'without_skonto', # default if not specified
712 $ap->pay_invoice(chart_id => $bank->chart_id,
713 amount => $ap->amount, # doesn't need to be specified
714 transdate => DateTime->now->to_kivitendo,
717 payment_type => 'with_skonto',
720 Allowed payment types are:
721 without_skonto with_skonto_pt difference_as_skonto
723 The option C<payment_type> allows for a basic skonto mechanism.
725 C<without_skonto> is the default mode, "amount" is paid to the account in
726 chart_id. This can also be used for partial payments and corrections via
729 C<with_skonto_pt> can't be used for partial payments. When used on unpaid
730 invoices the whole amount is paid, with the skonto part automatically being
731 booked according to the skonto chart configured in the tax settings for each
732 tax key. If an amount is passed it is ignored and the actual configured skonto
735 C<difference_as_skonto> can only be used after partial payments have been made,
736 the whole specified amount is booked according to the skonto charts configured
737 in the tax settings for each tax key.
739 So passing amount doesn't have any effect for the cases C<with_skonto_pt> and
740 C<difference_as_skonto>, as all necessary values are taken from the stored
743 The skonto modes automatically calculate the relative amounts for a mix of
744 taxes, e.g. items with 7% and 19% in one invoice. There is a helper method
745 skonto_charts, which calculates the relative percentages according to the
746 amounts in acc_trans (which are grouped by tax).
748 There is currently no way of excluding certain items in an invoice from having
749 skonto applied to them. If this feature was added to parts the calculation
750 method of relative skonto would have to be completely rewritten using the
751 invoice items rather than acc_trans.
753 The skonto modes also still don't automatically correct the tax, this still has
754 to be done manually. Therefore all payments generated by pay_invoice have
757 There is currently no way to directly pay an invoice via this method if the
758 effective skonto differs from the skonto according to the payment terms
759 configured for the invoice/vendor.
761 In this case one has to pay in two steps: first the actual paid amount via
762 "without skonto", and then the remainder via "difference_as_skonto". The user
763 has to there actively decide whether to accept the differing skonto.
765 Because of the way skonto_charts works the calculation doesn't work if there
766 are negative values in acc_trans. E.g. one invoice with a positive value for
767 19% tax and a negative value for the acc_trans line with 7%
769 Skonto doesn't/shouldn't apply if the invoice contains credited items.
771 =item C<reference_account>
773 Returns a chart object which is the chart of the invoice with link AR or AP.
775 Example (1200 is the AR account for SKR04):
776 my $invoice = invoice(invnumber => '144');
777 $invoice->reference_account->accno
780 =item C<percent_skonto>
782 Returns the configured skonto percentage of the payment terms of an invoice,
783 e.g. 0.02 for 2%. Payment terms come from invoice settings for ar, from vendor
786 =item C<amount_less_skonto>
788 If the invoice has a payment term (via ar for sales, via vendor for purchase),
789 calculate the amount to be paid in the case of skonto. This doesn't check,
790 whether skonto applies (i.e. skonto doesn't wasn't exceeded), it just subtracts
791 the configured percentage (e.g. 2%) from the total amount.
793 The returned value is rounded to two decimals.
797 The date up to which skonto may be taken. This is calculated from the invoice
798 date + the number of days configured in the payment terms.
800 This method can also be used to determine whether skonto applies for the
801 invoice, as it returns undef if there is no payment term or skonto days is set
804 =item C<within_skonto_period [DATE]>
808 Checks whether the invoice has payment terms configured, and whether the date
809 is within the skonto max date. If no date is passed the current date is used.
811 You can also pass a dateref object as a parameter to check whether skonto
812 applies for that date rather than the current date.
814 =item C<valid_skonto_amount>
816 Takes an amount as an argument and checks whether the amount is less than 10%
817 of the total amount of the invoice. The value of 10% is currently hardcoded in
818 the method. This method is currently used to check whether to offer the payment
819 option "difference as skonto".
822 if ( $invoice->valid_skonto_amount($invoice->open_amount) ) {
826 =item C<skonto_charts [$amount]>
828 Returns a list of chart_ids and some calculated numbers that can be used for
829 paying the invoice with skonto. This function will automatically calculate the
830 relative skonto amounts even if the invoice contains several types of taxes
834 my $invoice = SL::DB::Manager::Invoice->find_by(invnumber => '211');
835 my @skonto_charts = $invoice->skonto_charts;
837 or with the total skonto amount as an argument:
838 my @skonto_charts = $invoice->skonto_charts($invoice->open_amount);
840 The following values are generated for each chart:
846 The chart id of the skonto amount to be booked.
848 =item C<skonto_amount>
850 The total amount to be paid to the account
852 =item C<skonto_percent>
854 The relative percentage of that skonto chart. This can be useful if the actual
855 ekonto that is paid deviates from the granted skonto, e.g. customer effectively
856 pays 2.6% skonto instead of 2%, and we accept this. Then we can still calculate
857 the relative skonto amounts for different taxes based on the absolute
858 percentages. Used for case C<difference_as_skonto>.
860 =item C<skonto_percent_abs>
862 The absolute percentage of that skonto chart in relation to the total amount.
863 Used to calculate skonto_amount for case C<with_skonto_pt>.
867 If the invoice contains several types of taxes then skonto_charts can be used
868 to calculate the relative amounts.
870 Example in console of an invoice with 100 Euro at 7% and 100 Euro at 19% with
873 my $invoice = invoice(invnumber => '144');
876 $invoice->payment_terms->percent_skonto
878 $invoice->skonto_charts
879 pp $invoice->skonto_charts
882 # 'skonto_amount' => '2.14',
883 # 'skonto_percent' => '47.3451327433627'
887 # 'skonto_amount' => '2.38',
888 # 'skonto_percent' => '52.654867256637'
891 C<skonto_charts> always returns positive values (abs) for C<skonto_amount> and
894 C<skonto_charts> generates one entry for each acc_trans entry. ar and ap
895 bookings only have one acc_trans entry for each taxkey (e.g. 7% and 19%). This
896 is because all the items are grouped according to the Buchungsgruppen mechanism
897 and the totals are written to acc_trans. For is and ir it is possible to have
898 several acc_trans entries with the same tax. In this case skonto_charts
899 generates a skonto booking for each acc_trans income/expense entry.
901 In the future this function may also be used to calculate the corrections for
906 Unrounded total open amount of invoice (amount - paid).
907 Doesn't take into account pending SEPA transfers.
909 =item C<open_percent>
911 Percentage of the invoice that is still unpaid, e.g. 100,00 if no payments have
912 been made yet, 0,00 if fully paid.
914 =item C<remaining_skonto_days>
916 How many days skonto can still be taken, calculated from current day. Returns 0
917 if current day is the max skonto date, and negative number if skonto date has
920 Returns undef if skonto is not configured for that invoice.
922 =item C<get_payment_suggestions %params>
924 Creates data intended for an L.select_tag dropdown that can be used in a
925 template. Depending on the rules it will choose from the options
926 without_skonto, with_skonto_pt and difference_as_skonto, and select the most
929 If the parameter "sepa" is passed, the SEPA export payments that haven't been
930 executed yet are considered when determining the open amount of the invoice.
932 The current rules are:
936 =item * without_skonto is always an option
938 =item * with_skonto_pt is only offered if there haven't been any payments yet and the current date is within the skonto period.
940 =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.
942 with_skonto_pt will only be offered, if all the AR_amount/AP_amount have a
943 taxkey with a configured skonto chart
947 It will also fill $self->{invoice_amount_suggestion} with either the open
948 amount, or if with_skonto_pt is selected, with amount_less_skonto, so the
949 template can fill the input with the likely amount.
952 my $ar = invoice( invnumber => '257');
953 $ar->get_payment_suggestions;
954 print $ar->{invoice_amount_suggestion} . "\n";
956 pp $ar->{payment_select_options}
959 # 'display' => 'ohne Skonto',
960 # 'payment_type' => 'without_skonto'
963 # 'display' => 'mit Skonto nach ZB',
964 # 'payment_type' => 'with_skonto_pt',
969 The resulting array $ar->{payment_select_options} can be used in a template
970 select_tag using value_key and title_key:
972 [% L.select_tag('payment_type_' _ loop.count, invoice.payment_select_options, value_key => 'payment_type', title_key => 'display', id => 'payment_type_' _ loop.count) %]
974 It would probably make sense to have different rules for the pre-selected items
975 for sales and purchase, and to also make these rules configurable in the
976 defaults. E.g. when creating a SEPA bank transfer for vendor invoices a company
977 might always want to pay quickly making use of skonto, while another company
978 might always want to pay as late as possible.
980 =item C<get_payment_select_options_for_bank_transaction $banktransaction_id %params>
982 Make suggestion for a skonto payment type by returning an HTML blob of the options
983 of a HTML drop-down select with the most likely option preselected.
985 This is a helper function for BankTransaction/ajax_payment_suggestion.
987 We are working with an existing payment, so difference_as_skonto never makes sense.
989 If skonto is possible (skonto_date exists), add two possibilities:
990 without_skonto and with_skonto_pt if payment date is within skonto_date,
991 preselect with_skonto_pt, otherwise preselect without skonto.
993 =item C<create_bank_transaction %params>
995 Method used for testing purposes, allows you to quickly create bank
996 transactions from invoices to have something to test payments against.
998 my $ap = SL::DB::Manager::Invoice->find_by(id => 41);
999 $ap->create_bank_transaction(amount => $ap->amount/2, transdate => DateTime->today->add(days => 5));
1001 Amount is always relative to the absolute amount of the invoice, use positive
1002 values for sales and purchases.
1006 =head1 TODO AND CAVEATS
1012 when looking at open amount, maybe consider that there may already be queued
1013 amounts in SEPA Export
1017 Can only handle default currency.
1023 G. Richardson E<lt>grichardson@kivitendo-premium.de<gt>