use strict;
+use Carp;
use List::Util qw(first);
+use Rose::DB::Object::Helpers ();
+
use SL::DB::MetaSetup::Invoice;
use SL::DB::Manager::Invoice;
-
-__PACKAGE__->attr_number($_, places => -2) for qw(amount netamount paid marge_total marge_percent taxamount);
-__PACKAGE__->attr_date($_) for qw(transdate gldate datepaid duedate deliverydate orddate quodate);
-__PACKAGE__->attr_percent($_) for qw(abschlag_percentage);
+use SL::DB::Helper::FlattenToForm;
+use SL::DB::Helper::LinkedRecords;
+use SL::DB::Helper::PriceTaxCalculator;
+use SL::DB::Helper::PriceUpdater;
+use SL::DB::Helper::TransNumberGenerator;
+use SL::Locale::String qw(t8);
__PACKAGE__->meta->add_relationship(
invoiceitems => {
with_objects => [ 'part' ]
}
},
+ storno_invoices => {
+ type => 'one to many',
+ class => 'SL::DB::Invoice',
+ column_map => { id => 'storno_id' },
+ },
+ sepa_export_items => {
+ type => 'one to many',
+ class => 'SL::DB::SepaExportItem',
+ column_map => { id => 'ar_id' },
+ manager_args => { with_objects => [ 'sepa_export' ] }
+ },
+ custom_shipto => {
+ type => 'one to one',
+ class => 'SL::DB::Shipto',
+ column_map => { id => 'trans_id' },
+ query_args => [ module => 'AR' ],
+ },
);
__PACKAGE__->meta->initialize;
+__PACKAGE__->before_save('_before_save_set_invnumber');
+
+# hooks
+
+sub _before_save_set_invnumber {
+ my ($self) = @_;
+
+ $self->create_trans_number if !$self->invnumber;
+
+ return 1;
+}
+
# methods
+sub items { goto &invoiceitems; }
+sub add_items { goto &add_invoiceitems; }
+
+sub items_sorted {
+ my ($self) = @_;
+
+ return [ sort {$a->id <=> $b->id } @{ $self->items } ];
+}
+
+sub is_sales {
+ # For compatibility with Order, DeliveryOrder
+ croak 'not an accessor' if @_ > 1;
+ return 1;
+}
+
# it is assumed, that ordnumbers are unique here.
sub first_order_by_ordnumber {
my $self = shift;
my $self = shift;
die 'not a setter method' if @_;
- return $self->amount - $self->netamount;
+ return ($self->amount || 0) - ($self->netamount || 0);
+}
+
+__PACKAGE__->meta->make_attr_helpers(taxamount => 'numeric(15,5)');
+
+sub closed {
+ my ($self) = @_;
+ return $self->paid >= $self->amount;
+}
+
+sub _clone_orderitem_delivery_order_item_cvar {
+ my ($cvar) = @_;
+
+ my $cloned = Rose::DB::Object::Helpers::clone_and_reset($_);
+ $cloned->sub_module('invoice');
+
+ return $cloned;
+}
+
+sub new_from {
+ my ($class, $source, %params) = @_;
+
+ croak("Unsupported source object type '" . ref($source) . "'") unless ref($source) =~ m/^ SL::DB:: (?: Order | DeliveryOrder ) $/x;
+ croak("Cannot create invoices for purchase records") unless $source->customer_id;
+
+ require SL::DB::Employee;
+
+ my $terms = $source->can('payment_id') && $source->payment_id ? $source->payment_terms
+ : $source->customer_id ? $source ->customer->payment_terms
+ : undef;
+
+ my (@columns, @item_columns, $item_parent_id_column, $item_parent_column);
+
+ if (ref($source) eq 'SL::DB::Order') {
+ @columns = qw(quonumber payment_id delivery_customer_id delivery_vendor_id);
+ @item_columns = qw(subtotal);
+
+ $item_parent_id_column = 'trans_id';
+ $item_parent_column = 'order';
+
+ } else {
+ @columns = qw(donumber);
+
+ $item_parent_id_column = 'delivery_order_id';
+ $item_parent_column = 'delivery_order';
+ }
+
+ 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), @columns),
+ transdate => DateTime->today_local,
+ gldate => DateTime->today_local,
+ duedate => DateTime->today_local->add(days => ($terms ? $terms->terms_netto * 1 : 1)),
+ payment_id => $terms ? $terms->id : undef,
+ invoice => 1,
+ type => 'invoice',
+ storno => 0,
+ paid => 0,
+ employee_id => (SL::DB::Manager::Employee->current || SL::DB::Employee->new(id => $source->employee_id))->id,
+ );
+
+ if ($source->type =~ /_order$/) {
+ $args{deliverydate} = $source->reqdate;
+ $args{orddate} = $source->transdate;
+ } else {
+ $args{quodate} = $source->transdate;
+ }
+
+ my $invoice = $class->new(%args);
+ $invoice->assign_attributes(%{ $params{attributes} }) if $params{attributes};
+ my $items = delete($params{items}) || $source->items_sorted;
+ my %item_parents;
+
+ my @items = map {
+ my $source_item = $_;
+ my $source_item_id = $_->$item_parent_id_column;
+ my @custom_variables = map { _clone_orderitem_delivery_order_item_cvar($_) } @{ $source_item->custom_variables };
+
+ $item_parents{$source_item_id} ||= $source_item->$item_parent_column;
+ my $item_parent = $item_parents{$source_item_id};
+
+ SL::DB::InvoiceItem->new(map({ ( $_ => $source_item->$_ ) }
+ qw(parts_id description qty sellprice discount project_id serialnumber pricegroup_id transdate cusordnumber unit
+ base_qty longdescription lastcost price_factor_id), @item_columns),
+ deliverydate => $source_item->reqdate,
+ fxsellprice => $source_item->sellprice,
+ custom_variables => \@custom_variables,
+ ordnumber => ref($item_parent) eq 'SL::DB::Order' ? $item_parent->ordnumber : $source_item->ordnumber,
+ donumber => ref($item_parent) eq 'SL::DB::DeliveryOrder' ? $item_parent->donumber : $source_item->can('donumber') ? $source_item->donumber : '',
+ );
+
+ } @{ $items };
+
+ @items = grep { $_->qty * 1 } @items if $params{skip_items_zero_qty};
+ @items = grep { $_->qty >=0 } @items if $params{skip_items_negative_qty};
+
+ $invoice->invoiceitems(\@items);
+
+ return $invoice;
+}
+
+sub post {
+ my ($self, %params) = @_;
+
+ 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;
+ $params{ar_id} = $chart->id;
+ }
+
+ my $worker = sub {
+ my %data = $self->calculate_prices_and_taxes;
+
+ $self->_post_create_assemblyitem_entries($data{assembly_items});
+ $self->save;
+
+ $self->_post_add_acctrans($data{amounts_cogs});
+ $self->_post_add_acctrans($data{amounts});
+ $self->_post_add_acctrans($data{taxes});
+
+ $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)) {
+ $::lxdebug->message(LXDebug->WARN(), "convert_to_invoice failed: " . join("\n", (split(/\n/, $self->db->error))[0..2]));
+ return undef;
+ }
+
+ return $self;
+}
+
+sub _post_add_acctrans {
+ my ($self, $entries) = @_;
+
+ my $default_tax_id = SL::DB::Manager::Tax->find_by(taxkey => 0)->id;
+ my $chart_link;
+
+ require SL::DB::AccTransaction;
+ require SL::DB::Chart;
+ while (my ($chart_id, $spec) = each %{ $entries }) {
+ $spec = { taxkey => 0, tax_id => $default_tax_id, amount => $spec } unless ref $spec;
+ $chart_link = SL::DB::Manager::Chart->find_by(id => $chart_id)->{'link'};
+ $chart_link ||= '';
+
+ 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_create_assemblyitem_entries {
+ my ($self, $assembly_entries) = @_;
+
+ my $items = $self->invoiceitems;
+ my @new_items;
+
+ my $item_idx = 0;
+ foreach my $item (@{ $items }) {
+ next if $item->assemblyitem;
+
+ push @new_items, $item;
+ $item_idx++;
+
+ foreach my $assembly_item (@{ $assembly_entries->[$item_idx] || [ ] }) {
+ push @new_items, SL::DB::InvoiceItem->new(parts_id => $assembly_item->{part},
+ description => $assembly_item->{part}->description,
+ unit => $assembly_item->{part}->unit,
+ qty => $assembly_item->{qty},
+ allocated => $assembly_item->{allocated},
+ sellprice => 0,
+ fxsellprice => 0,
+ assemblyitem => 't');
+ }
+ }
+
+ $self->invoiceitems(\@new_items);
+}
+
+sub _post_update_allocated {
+ my ($self, $allocated) = @_;
+
+ while (my ($invoice_id, $diff) = each %{ $allocated }) {
+ SL::DB::Manager::InvoiceItem->update_all(set => { allocated => { sql => "allocated + $diff" } },
+ where => [ id => $invoice_id ]);
+ }
+}
+
+sub invoice_type {
+ my ($self) = @_;
+
+ return 'ar_transaction' if !$self->invoice;
+ return 'credit_note' if $self->type eq 'credit_note' && $self->amount < 0 && !$self->storno;
+ 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';
+}
+
+sub displayable_state {
+ my $self = shift;
+
+ return $self->closed ? $::locale->text('closed') : $::locale->text('open');
+}
+
+sub displayable_type {
+ my ($self) = @_;
+
+ return t8('AR Transaction') if $self->invoice_type eq 'ar_transaction';
+ 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');
+}
+
+sub abbreviation {
+ my ($self) = @_;
+
+ return t8('AR Transaction (abbreviation)') if $self->invoice_type eq 'ar_transaction';
+ 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 (one letter abbreviation)');
+}
+
+sub date {
+ goto &transdate;
+}
+
+sub transactions {
+ my ($self) = @_;
+
+ return unless $self->id;
+
+ require SL::DB::AccTransaction;
+ SL::DB::Manager::AccTransaction->get_all(query => [ trans_id => $self->id ]);
}
1;
+
+__END__
+
+=pod
+
+=head1 NAME
+
+SL::DB::Invoice: Rose model for invoices (table "ar")
+
+=head1 FUNCTIONS
+
+=over 4
+
+=item C<new_from $source, %params>
+
+Creates a new C<SL::DB::Invoice> instance and copies as much
+information from C<$source> as possible. At the moment only sales
+orders and sales quotations are supported as sources.
+
+The conversion copies order items into invoice items. Dates are copied
+as appropriate, e.g. the C<transdate> field from an order will be
+copied into the invoice's C<orddate> field.
+
+C<%params> can include the following options:
+
+=over 2
+
+=item C<items>
+
+An optional array reference of RDBO instances for the items to use. If
+missing then the method C<items_sorted> will be called on
+C<$source>. This option can be used to override the sorting, to
+exclude certain positions or to add additional ones.
+
+=item C<skip_items_negative_qty>
+
+If trueish then items with a negative quantity are skipped. Items with
+a quantity of 0 are not affected by this option.
+
+=item C<skip_items_zero_qty>
+
+If trueish then items with a quantity of 0 are skipped.
+
+=item C<attributes>
+
+An optional hash reference. If it exists then it is passed to C<new>
+allowing the caller to set certain attributes for the new delivery
+order.
+
+=back
+
+Amounts, prices and taxes are not
+calculated. L<SL::DB::Helper::PriceTaxCalculator::calculate_prices_and_taxes>
+can be used for this.
+
+The object returned is not saved.
+
+=item C<post %params>
+
+Posts the invoice. Required parameters are:
+
+=over 2
+
+=item * C<ar_id>
+
+The ID of the accounds receivable chart the invoices amounts are
+posted to. If it is not set then the first chart configured for
+accounts receivables is used.
+
+=back
+
+This function implements several steps:
+
+=over 2
+
+=item 1. It calculates all prices, amounts and taxes by calling
+L<SL::DB::Helper::PriceTaxCalculator::calculate_prices_and_taxes>.
+
+=item 2. A new and unique invoice number is created.
+
+=item 3. All amounts for costs of goods sold are recorded in
+C<acc_trans>.
+
+=item 4. All amounts for parts, services and assemblies are recorded
+in C<acc_trans> with their respective charts. This is determined by
+the part's buchungsgruppen.
+
+=item 5. The total amount is posted to the accounts receivable chart
+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
+kivitendo is not configured to use Einnahmenüberschussrechnungen.
+
+=item 7. The invoice and its items are saved.
+
+=back
+
+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
+active.
+
+=item C<basic_info $field>
+
+See L<SL::DB::Object::basic_info>.
+
+=back
+
+=head1 AUTHOR
+
+Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
+
+=cut