use strict;
use Carp;
-use List::Util qw(first);
+use List::Util qw(first sum);
-use Rose::DB::Object::Helpers ();
+use Rose::DB::Object::Helpers qw(has_loaded_related forget_related);
use SL::DB::MetaSetup::Invoice;
use SL::DB::Manager::Invoice;
use SL::DB::Helper::Payment qw(:ALL);
use SL::DB::Helper::AttrSorted;
use SL::DB::Helper::FlattenToForm;
use SL::DB::Helper::LinkedRecords;
+use SL::DB::Helper::PDF_A;
use SL::DB::Helper::PriceTaxCalculator;
use SL::DB::Helper::PriceUpdater;
+use SL::DB::Helper::SalesPurchaseInvoice;
use SL::DB::Helper::TransNumberGenerator;
+use SL::DB::Helper::ZUGFeRD;
use SL::Locale::String qw(t8);
use SL::DB::CustomVariable;
sort_by => 'acc_trans_id ASC',
},
},
+ dunnings => {
+ type => 'one to many',
+ class => 'SL::DB::Dunning',
+ column_map => { id => 'trans_id' },
+ manager_args => { with_objects => [ 'dunnings' ] }
+ },
);
__PACKAGE__->meta->initialize;
sub _clone_orderitem_delivery_order_item_cvar {
my ($cvar) = @_;
- my $cloned = Rose::DB::Object::Helpers::clone_and_reset($_);
+ my $cloned = $_->clone_and_reset;
$cloned->sub_module('invoice');
return $cloned;
my (@columns, @item_columns, $item_parent_id_column, $item_parent_column);
if (ref($source) eq 'SL::DB::Order') {
- @columns = qw(quonumber delivery_customer_id delivery_vendor_id);
+ @columns = qw(quonumber delivery_customer_id delivery_vendor_id tax_point);
@item_columns = qw(subtotal);
$item_parent_id_column = 'trans_id';
}
my $terms = $source->can('payment_id') ? $source->payment_terms : undef;
+ $terms = $source->customer->payment_terms if !defined $terms && $source->customer;
my %args = ( map({ ( $_ => $source->$_ ) } qw(customer_id taxincluded shippingpoint shipvia notes intnotes salesman_id cusordnumber ordnumber department_id
- cp_id language_id taxzone_id shipto_id globalproject_id transaction_description currency_id delivery_term_id payment_id), @columns),
- transdate => DateTime->today_local,
+ cp_id language_id taxzone_id tax_point globalproject_id transaction_description currency_id delivery_term_id
+ billing_address_id), @columns),
+ transdate => $params{transdate} // DateTime->today_local,
gldate => DateTime->today_local,
duedate => $terms ? $terms->calc_date(reference_date => DateTime->today_local) : DateTime->today_local,
invoice => 1,
employee_id => (SL::DB::Manager::Employee->current || SL::DB::Employee->new(id => $source->employee_id))->id,
);
- if ($source->type =~ /_order$/) {
+ $args{payment_id} = ( $terms ? $terms->id : $source->payment_id);
+
+ if ($source->type =~ /_delivery_order$/) {
+ $args{deliverydate} = $source->reqdate;
+ if (my $order = SL::DB::Manager::Order->find_by(ordnumber => $source->ordnumber)) {
+ $args{orddate} = $order->transdate;
+ }
+
+ } elsif ($source->type =~ /_order$/) {
$args{deliverydate} = $source->reqdate;
$args{orddate} = $source->transdate;
+
} else {
$args{quodate} = $source->transdate;
}
+ # Custom shipto addresses (the ones specific to the sales/purchase
+ # record and not to the customer/vendor) are only linked from shipto
+ # → ar. Meaning ar.shipto_id will not be filled in that
+ # case.
+ if (!$source->shipto_id && $source->id) {
+ $args{custom_shipto} = $source->custom_shipto->clone($class) if $source->can('custom_shipto') && $source->custom_shipto;
+
+ } else {
+ $args{shipto_id} = $source->shipto_id;
+ }
+
my $invoice = $class->new(%args);
$invoice->assign_attributes(%{ $params{attributes} }) if $params{attributes};
my $items = delete($params{items}) || $source->items_sorted;
sub post {
my ($self, %params) = @_;
+ die "not an invoice" unless $self->invoice;
+
require SL::DB::Chart;
if (!$params{ar_id}) {
- my $chart = SL::DB::Manager::Chart->get_all(query => [ SL::DB::Manager::Chart->link_filter('AR') ],
- sort_by => 'id ASC',
- limit => 1)->[0];
- croak("No AR chart found and no parameter `ar_id' given") unless $chart;
+ my $chart;
+ if ($::instance_conf->get_ar_chart_id) {
+ $chart = SL::DB::Manager::Chart->find_by(id => $::instance_conf->get_ar_chart_id);
+ } else {
+ $chart = SL::DB::Manager::Chart->get_all(query => [ SL::DB::Manager::Chart->link_filter('AR') ],
+ sort_by => 'id ASC',
+ limit => 1)->[0];
+ };
+ croak("No AR chart found and no parameter 'ar_id' given") unless $chart;
$params{ar_id} = $chart->id;
}
- my $worker = sub {
+ if (!$self->db->with_transaction(sub {
my %data = $self->calculate_prices_and_taxes;
$self->_post_create_assemblyitem_entries($data{assembly_items});
$self->_post_add_acctrans($data{amounts_cogs});
$self->_post_add_acctrans($data{amounts});
- $self->_post_add_acctrans($data{taxes});
+ $self->_post_add_acctrans($data{taxes_by_chart_id});
$self->_post_add_acctrans({ $params{ar_id} => $self->amount * -1 });
$self->_post_update_allocated($data{allocated});
- };
- if ($self->db->in_transaction) {
- $worker->();
- } elsif (!$self->db->do_transaction($worker)) {
+ $self->_post_book_rounding($data{rounding});
+
+ 1;
+ })) {
$::lxdebug->message(LXDebug->WARN(), "convert_to_invoice failed: " . join("\n", (split(/\n/, $self->db->error))[0..2]));
return undef;
}
$chart_link = SL::DB::Manager::Chart->find_by(id => $chart_id)->{'link'};
$chart_link ||= '';
+ if ($spec->{amount} != 0) {
+ SL::DB::AccTransaction->new(trans_id => $self->id,
+ chart_id => $chart_id,
+ amount => $spec->{amount},
+ tax_id => $spec->{tax_id},
+ taxkey => $spec->{taxkey},
+ project_id => $self->globalproject_id,
+ transdate => $self->transdate,
+ chart_link => $chart_link)->save;
+ }
+ }
+}
+
+sub _post_book_rounding {
+ my ($self, $rounding) = @_;
+
+ my $tax_id = SL::DB::Manager::Tax->find_by(taxkey => 0)->id;
+ my $rnd_accno = $rounding == 0 ? 0
+ : $rounding > 0 ? SL::DB::Default->get->rndgain_accno_id
+ : SL::DB::Default->get->rndloss_accno_id
+ ;
+ if ($rnd_accno != 0) {
SL::DB::AccTransaction->new(trans_id => $self->id,
- chart_id => $chart_id,
- amount => $spec->{amount},
- tax_id => $spec->{tax_id},
- taxkey => $spec->{taxkey},
+ chart_id => $rnd_accno,
+ amount => $rounding,
+ tax_id => $tax_id,
+ taxkey => 0,
project_id => $self->globalproject_id,
transdate => $self->transdate,
- chart_link => $chart_link)->save;
+ chart_link => $rnd_accno)->save;
}
}
+sub add_ar_amount_row {
+ my ($self, %params ) = @_;
+
+ # only allow this method for ar invoices (Debitorenbuchung)
+ die "not an ar invoice" if $self->invoice and not $self->customer_id;
+
+ die "add_ar_amount_row needs a chart object as chart param" unless $params{chart} && $params{chart}->isa('SL::DB::Chart');
+ die "chart must be an AR_amount chart" unless $params{chart}->link =~ /AR_amount/;
+
+ my $acc_trans = [];
+
+ my $roundplaces = 2;
+ my ($netamount,$taxamount);
+
+ $netamount = $params{amount} * 1;
+ my $tax = SL::DB::Manager::Tax->find_by(id => $params{tax_id}) || die "Can't find tax with id " . $params{tax_id};
+
+ if ( $tax and $tax->rate != 0 ) {
+ ($netamount, $taxamount) = Form->calculate_tax($params{amount}, $tax->rate, $self->taxincluded, $roundplaces);
+ };
+ next unless $netamount; # netamount mustn't be zero
+ my $sign = $self->customer_id ? 1 : -1;
+ my $acc = SL::DB::AccTransaction->new(
+ amount => $netamount * $sign,
+ chart_id => $params{chart}->id,
+ chart_link => $params{chart}->link,
+ transdate => $self->transdate,
+ gldate => $self->gldate,
+ taxkey => $tax->taxkey,
+ tax_id => $tax->id,
+ project_id => $params{project_id},
+ );
+
+ $self->add_transactions( $acc );
+ push( @$acc_trans, $acc );
+
+ if ( $taxamount ) {
+ my $acc = SL::DB::AccTransaction->new(
+ amount => $taxamount * $sign,
+ chart_id => $tax->chart_id,
+ chart_link => $tax->chart->link,
+ transdate => $self->transdate,
+ gldate => $self->gldate,
+ taxkey => $tax->taxkey,
+ tax_id => $tax->id,
+ );
+ $self->add_transactions( $acc );
+ push( @$acc_trans, $acc );
+ };
+ return $acc_trans;
+};
+
+sub create_ar_row {
+ my ($self, %params) = @_;
+ # to be called after adding all AR_amount rows, adds an AR row
+
+ # only allow this method for ar invoices (Debitorenbuchung)
+ die if $self->invoice and not $self->customer_id;
+ die "create_ar_row needs a chart object as a parameter" unless $params{chart} and ref($params{chart}) eq 'SL::DB::Chart';
+
+ my @transactions = @{$self->transactions};
+ # die "invoice has no acc_transactions" unless scalar @transactions > 0;
+ return 0 unless scalar @transactions > 0;
+
+ my $chart = $params{chart} || SL::DB::Manager::Chart->find_by(id => $::instance_conf->get_ar_chart_id);
+ die "illegal chart in create_ar_row" unless $chart;
+
+ die "receivables chart must have link 'AR'" unless $chart->link eq 'AR';
+
+ my $acc_trans = [];
+
+ # hardcoded entry for no tax: tax_id and taxkey should be 0
+ my $tax = SL::DB::Manager::Tax->find_by(id => 0, taxkey => 0) || die "Can't find tax with id 0 and taxkey 0";
+
+ my $sign = $self->customer_id ? -1 : 1;
+ my $acc = SL::DB::AccTransaction->new(
+ amount => $self->amount * $sign,
+ chart_id => $params{chart}->id,
+ chart_link => $params{chart}->link,
+ transdate => $self->transdate,
+ taxkey => $tax->taxkey,
+ tax_id => $tax->id,
+ );
+ $self->add_transactions( $acc );
+ push( @$acc_trans, $acc );
+ return $acc_trans;
+}
+
+sub validate_acc_trans {
+ my ($self, %params) = @_;
+ # should be able to check unsaved invoice objects with several acc_trans lines
+
+ die "validate_acc_trans can't check invoice object with empty transactions" unless $self->transactions;
+
+ my @transactions = @{$self->transactions};
+ # die "invoice has no acc_transactions" unless scalar @transactions > 0;
+ return 0 unless scalar @transactions > 0;
+ return 0 unless $self->has_loaded_related('transactions');
+ if ( $params{debug} ) {
+ printf("starting validatation of invoice %s with trans_id %s and taxincluded %s\n", $self->invnumber, $self->id, $self->taxincluded);
+ foreach my $acc ( @transactions ) {
+ printf("chart: %s amount: %s tax_id: %s link: %s\n", $acc->chart->accno, $acc->amount, $acc->tax_id, $acc->chart->link);
+ };
+ };
+
+ my $acc_trans_sum = sum map { $_->amount } @transactions;
+
+ unless ( $::form->round_amount($acc_trans_sum, 10) == 0 ) {
+ my $string = "sum of acc_transactions isn't 0: $acc_trans_sum\n";
+
+ if ( $params{debug} ) {
+ foreach my $trans ( @transactions ) {
+ $string .= sprintf(" %s %s %s\n", $trans->chart->accno, $trans->taxkey, $trans->amount);
+ };
+ };
+ return 0;
+ };
+
+ # only use the first AR entry, so it also works for paid invoices
+ my @ar_transactions = map { $_->amount } grep { $_->chart_link eq 'AR' } @transactions;
+ my $ar_sum = $ar_transactions[0];
+ # my $ar_sum = sum map { $_->amount } grep { $_->chart_link eq 'AR' } @transactions;
+
+ unless ( $::form->round_amount($ar_sum * -1,2) == $::form->round_amount($self->amount,2) ) {
+ if ( $params{debug} ) {
+ printf("debug: (ar_sum) %s = %s (amount)\n", $::form->round_amount($ar_sum * -1,2) , $::form->round_amount($self->amount, 2) );
+ foreach my $trans ( @transactions ) {
+ printf(" %s %s %s %s\n", $trans->chart->accno, $trans->taxkey, $trans->amount, $trans->chart->link);
+ };
+ };
+ die sprintf("sum of ar (%s) isn't equal to invoice amount (%s)", $::form->round_amount($ar_sum * -1,2), $::form->round_amount($self->amount,2));
+ };
+
+ return 1;
+};
+
+sub recalculate_amounts {
+ my ($self, %params) = @_;
+ # calculate and set amount and netamount from acc_trans objects
+
+ croak ("Can only recalculate amounts for ar transactions") if $self->invoice;
+
+ return undef unless $self->has_loaded_related('transactions');
+
+ my ($netamount, $taxamount);
+
+ my @transactions = @{$self->transactions};
+
+ foreach my $acc ( @transactions ) {
+ $netamount += $acc->amount if $acc->chart->link =~ /AR_amount/;
+ $taxamount += $acc->amount if $acc->chart->link =~ /AR_tax/;
+ };
+
+ $self->amount($netamount+$taxamount);
+ $self->netamount($netamount);
+};
+
+
sub _post_create_assemblyitem_entries {
my ($self, $assembly_entries) = @_;
my ($self) = @_;
return 'ar_transaction' if !$self->invoice;
- return 'credit_note' if $self->type eq 'credit_note' && $self->amount < 0 && !$self->storno;
+ return 'invoice_for_advance_payment_storno' if $self->type eq 'invoice_for_advance_payment' && $self->amount < 0 && $self->storno;
+ return 'invoice_for_advance_payment' if $self->type eq 'invoice_for_advance_payment';
+ return 'final_invoice' if $self->type eq 'final_invoice';
+ # stornoed credit_notes are still credit notes and not invoices
+ return 'credit_note' if $self->type eq 'credit_note' && $self->amount < 0;
return 'invoice_storno' if $self->type ne 'credit_note' && $self->amount < 0 && $self->storno;
return 'credit_note_storno' if $self->type eq 'credit_note' && $self->amount > 0 && $self->storno;
return 'invoice';
return t8('Credit Note') if $self->invoice_type eq 'credit_note';
return t8('Invoice') . "(" . t8('Storno') . ")" if $self->invoice_type eq 'invoice_storno';
return t8('Credit Note') . "(" . t8('Storno') . ")" if $self->invoice_type eq 'credit_note_storno';
+ return t8('Invoice for Advance Payment') if $self->invoice_type eq 'invoice_for_advance_payment';
+ return t8('Invoice for Advance Payment') . "(" . t8('Storno') . ")" if $self->invoice_type eq 'invoice_for_advance_payment_storno';
+ return t8('Final Invoice') if $self->invoice_type eq 'final_invoice';
return t8('Invoice');
}
return t8('Credit note (one letter abbreviation)') if $self->invoice_type eq 'credit_note';
return t8('Invoice (one letter abbreviation)') . "(" . t8('Storno (one letter abbreviation)') . ")" if $self->invoice_type eq 'invoice_storno';
return t8('Credit note (one letter abbreviation)') . "(" . t8('Storno (one letter abbreviation)') . ")" if $self->invoice_type eq 'credit_note_storno';
+ return t8('Invoice for Advance Payment (one letter abbreviation)') if $self->invoice_type eq 'invoice_for_advance_payment';
+ return t8('Invoice for Advance Payment with Storno (abbreviation)') if $self->invoice_type eq 'invoice_for_advance_payment_storno';
+ return t8('Final Invoice (one letter abbreviation)') if $self->invoice_type eq 'final_invoice';
return t8('Invoice (one letter abbreviation)');
}
+sub oneline_summary {
+ my $self = shift;
+
+ return sprintf("%s: %s %s %s (%s)", $self->abbreviation, $self->invnumber, $self->customer->name,
+ $::form->format_amount(\%::myconfig, $self->amount,2), $self->transdate->to_kivitendo);
+}
+
sub date {
goto &transdate;
}
my ($self) = @_;
my $html;
- $html = SL::Presenter->get->sales_invoice($self, display => 'inline') if $self->invoice;
- $html = SL::Presenter->get->ar_transaction($self, display => 'inline') if !$self->invoice;
+ $html = $self->presenter->sales_invoice(display => 'inline') if $self->invoice;
+ $html = $self->presenter->ar_transaction(display => 'inline') if !$self->invoice;
return $html;
}
+sub mark_as_paid {
+ my ($self) = @_;
+
+ $self->update_attributes(paid => $self->amount);
+}
+
+sub effective_tax_point {
+ my ($self) = @_;
+
+ return $self->tax_point || $self->deliverydate || $self->transdate;
+}
+
1;
__END__
=pod
+=encoding UTF-8
+
=head1 NAME
SL::DB::Invoice: Rose model for invoices (table "ar")
=item * C<ar_id>
-The ID of the accounds receivable chart the invoices amounts are
+The ID of the accounts receivable chart the invoice's amounts are
posted to. If it is not set then the first chart configured for
accounts receivables is used.
and recorded in C<acc_trans>.
=item 6. Items in C<invoice> are updated according to their allocation
-status (regarding for costs of goold sold). Will only be done if
+status (regarding costs of goods sold). Will only be done if
kivitendo is not configured to use Einnahmenüberschussrechnungen.
=item 7. The invoice and its items are saved.
Returns C<$self> on success and C<undef> on failure. The whole process
is run inside a transaction. If it fails then nothing is saved to or
-changed in the database. A new transaction is only started if none is
+changed in the database. A new transaction is only started if none are
active.
=item C<basic_info $field>
See L<SL::DB::Object::basic_info>.
+=item C<closed>
+
+Returns 1 or 0, depending on whether the invoice is closed or not. Currently
+invoices that are overpaid also count as closed and credit notes in general.
+
+=item C<recalculate_amounts %params>
+
+Calculate and set amount and netamount from acc_trans objects by summing up the
+values of acc_trans objects with AR_amount and AR_tax link charts.
+amount and netamount are set to the calculated values.
+
+=item C<validate_acc_trans>
+
+Checks if the sum of all associated acc_trans objects is 0 and checks whether
+the amount of the AR acc_transaction matches the AR amount. Only the first AR
+line is checked, because the sum of all AR lines is 0 for paid invoices.
+
+Returns 0 or 1.
+
+Can be called with a debug parameter which writes debug info to STDOUT, which is
+useful in console mode or while writing tests.
+
+ my $ar = SL::DB::Manager::Invoice->get_first();
+ $ar->validate_acc_trans(debug => 1);
+
+=item C<create_ar_row %params>
+
+Creates a new acc_trans entry for the receivable (AR) entry of an existing AR
+invoice object, which already has some income and tax acc_trans entries.
+
+The acc_trans entry is also returned inside an array ref.
+
+Mandatory params are
+
+=over 2
+
+=item * chart as an RDBO object, e.g. for bank. Must be a 'paid' chart.
+
+=back
+
+Currently the amount of the invoice object is used for the acc_trans amount.
+Use C<recalculate_amounts> before calling this method if amount isn't known
+yet or you didn't set it manually.
+
+=item C<add_ar_amount_row %params>
+
+Add a new entry for an existing AR invoice object. Creates an acc_trans entry,
+and also adds an acc_trans tax entry, if the tax has an associated tax chart.
+Also all acc_trans entries that were created are returned inside an array ref.
+
+Mandatory params are
+
+=over 2
+
+=item * chart as an RDBO object, should be an income chart (link = AR_amount)
+
+=item * tax_id
+
+=item * amount
+
+=back
+
+=item C<mark_as_paid>
+
+Marks the invoice as paid by setting its C<paid> member to the value of C<amount>.
+
=back
=head1 TODO
+
As explained in the new_from example, it is possible to set transdate to a new value.
From a user / programm point of view transdate is more than holy and there should be
some validity checker available for controller code. At least the same logic like in
projects / kivitendo-erp.git / blobdiff