projekt kivitendo

  Common::check_params(\%params, qw(chart_id transdate));

  }

  if ($params{'payment_type'} eq 'free_skonto') {

    Common::check_params(\%params, qw(amount skonto_amount));

  # options with_skonto_pt and difference_as_skonto don't require the parameter

  # amount, but if amount is passed, make sure it matches the expected value

  if ( $params{'payment_type'} eq 'difference_as_skonto' ) {

    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;

  } elsif ( $params{'payment_type'} eq 'with_skonto_pt' ) {

    croak "amount $params{amount} doesn't match amount less skonto: " . $self->amount_less_skonto . "\n" if $params{amount} && abs($self->amount_less_skonto - $params{amount} ) > 0.0000001;

    croak "payment type with_skonto_pt can't be used if payments have already been made" if $self->paid != 0;

  };

    # difference_as_skonto creates n skonto bookings (1 for each buchungsgruppe type)

    # with_skonto_pt creates 1 bank booking and n skonto bookings (1 for each buchungsgruppe type)

    # as long as there is no automatic tax, payments are always booked with

    # taxkey 0

    unless ( $rounded_params_amount == 0 || $params{payment_type} eq 'difference_as_skonto' ) {

      # stage if we are going to use $params{amount}

    # better everything except without_skonto

    if ($params{payment_type} eq 'difference_as_skonto' or $params{payment_type} eq 'with_skonto_pt'

        or $params{payment_type} eq 'free_skonto' ) {

      } elsif ( $params{payment_type} eq 'difference_as_skonto' ) {

        # only used for tests. no real code calls this payment_type!

        $total_skonto_amount = $self->open_amount;

      # error checking:

      if ( $params{payment_type} eq 'difference_as_skonto' ) {

        my $calculated_skonto_sum  = sum map { $_->{skonto_amount} } @skonto_bookings;

        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);

      };

      # TODO create internal sub _skonto_bookings

      if ( $params{payment_type} eq 'difference_as_skonto' ) {

          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;

      }

    if ( $params{payment_type} eq 'difference_as_skonto' ) {

      $arap_amount = $total_open_amount;

    } elsif ( $params{payment_type} eq 'without_skonto' ) {

# $main::locale->text('difference_as_skonto')

  my %allowed_payment_types = map { $_ => 1 } qw(without_skonto with_skonto_pt difference_as_skonto free_skonto);

The params C<transdate> and C<chart_id> are mandantory.

If the default payment ('without_skonto') is used the param amount is also

mandantory.

If the payment type ('free_skonto') is used the number params skonto_amount and amount

are as well mandantory and need to be positive. Furthermore the skonto amount has

to be lower than the payment or open invoice amount.

Amount is either a positive or negative number, but never 0.

  without_skonto with_skonto_pt difference_as_skonto

C<difference_as_skonto> can only be used after partial payments have been made,

the whole specified amount is booked according to the skonto charts configured

in the tax settings for each tax key.

So passing amount doesn't have any effect for the cases C<with_skonto_pt> and

C<difference_as_skonto>, as all necessary values are taken from the stored

invoice.

skonto_charts, which calculates the relative percentages according to the

amounts in acc_trans (which are grouped by tax).

The skonto modes also still don't automatically correct the tax, this still has

to be done manually. Therefore all payments generated by pay_invoice have

taxkey 0.

There is currently no way to directly pay an invoice via this method if the

effective skonto differs from the skonto according to the payment terms

configured for the invoice/vendor.

In this case one has to pay in two steps: first the actual paid amount via

"without skonto", and then the remainder via "difference_as_skonto". The user

has to there actively decide whether to accept the differing skonto.

the two ids (acc_trans_id) of the newly created bookings.

=item C<skonto_charts [$amount]>

  my @skonto_charts = $invoice->skonto_charts;

  my @skonto_charts = $invoice->skonto_charts($invoice->open_amount);

=item C<skonto_percent>

The relative percentage of that skonto chart. This can be useful if the actual

ekonto that is paid deviates from the granted skonto, e.g. customer effectively

pays 2.6% skonto instead of 2%, and we accept this. Then we can still calculate

the relative skonto amounts for different taxes based on the absolute

percentages. Used for case C<difference_as_skonto>.

=item C<skonto_percent_abs>

The absolute percentage of that skonto chart in relation to the total amount.

Used to calculate skonto_amount for case C<with_skonto_pt>.

Example in console of an invoice with 100 Euro at 7% and 100 Euro at 19% with

tax not included:

  my $invoice = invoice(invnumber => '144');

  $invoice->amount

  226.00000

  $invoice->payment_terms->percent_skonto

  0.02

  $invoice->skonto_charts

  pp $invoice->skonto_charts

  #             $VAR1 = {

  #               'chart_id'       => 128,

  #               'skonto_amount'  => '2.14',

  #               'skonto_percent' => '47.3451327433627'

  #             };

  #             $VAR2 = {

  #               'chart_id'       => 130,

  #               'skonto_amount'  => '2.38',

  #               'skonto_percent' => '52.654867256637'

  #             };

C<skonto_charts> always returns positive values (abs) for C<skonto_amount> and

C<skonto_percent>.

C<skonto_charts> generates one entry for each acc_trans entry. ar and ap

bookings only have one acc_trans entry for each taxkey (e.g. 7% and 19%).  This

is because all the items are grouped according to the Buchungsgruppen mechanism

and the totals are written to acc_trans.  For is and ir it is possible to have

several acc_trans entries with the same tax. In this case skonto_charts

generates a skonto booking for each acc_trans income/expense entry.

In the future this function may also be used to calculate the corrections for

the income tax.

without_skonto, with_skonto_pt and difference_as_skonto, and select the most

=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.

We are working with an existing payment, so difference_as_skonto never makes sense.

=item * C<skonto_charts>