-# This file has been auto-generated only because it didn't exist.
-# Feel free to modify it at will; it will not be overwritten automatically.
-
package SL::DB::Invoice;
use strict;
use Carp;
use List::Util qw(first);
+use Rose::DB::Object::Helpers ();
use SL::DB::MetaSetup::Invoice;
use SL::DB::Manager::Invoice;
+use SL::DB::Helper::Payment qw(:ALL);
+use SL::DB::Helper::AttrHTML;
+use SL::DB::Helper::AttrSorted;
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::DB::AccTransaction;
-use SL::DB::Chart;
-use SL::DB::Employee;
+use SL::Locale::String qw(t8);
+use SL::DB::CustomVariable;
__PACKAGE__->meta->add_relationship(
invoiceitems => {
with_objects => [ 'part' ]
}
},
- payment_term => {
- type => 'one to one',
- class => 'SL::DB::PaymentTerm',
- column_map => { payment_id => 'id' },
- },
- contact => {
- type => 'one to one',
- class => 'SL::DB::Contact',
- column_map => { cp_id => 'cp_id' },
+ storno_invoices => {
+ type => 'one to many',
+ class => 'SL::DB::Invoice',
+ column_map => { id => 'storno_id' },
},
- shipto => {
- type => 'one to one',
- class => 'SL::DB::Shipto',
- column_map => { shipto_id => 'shipto_id' },
+ sepa_export_items => {
+ type => 'one to many',
+ class => 'SL::DB::SepaExportItem',
+ column_map => { id => 'ar_id' },
+ manager_args => { with_objects => [ 'sepa_export' ] }
},
- department => {
- type => 'one to one',
- class => 'SL::DB::Department',
- column_map => { department_id => 'id' },
+ sepa_exports => {
+ type => 'many to many',
+ map_class => 'SL::DB::SepaExportItem',
+ map_from => 'ar',
+ map_to => 'sepa_export',
},
- language => {
- type => 'one to one',
- class => 'SL::DB::Language',
- column_map => { language_id => 'id' },
+ custom_shipto => {
+ type => 'one to one',
+ class => 'SL::DB::Shipto',
+ column_map => { id => 'trans_id' },
+ query_args => [ module => 'AR' ],
},
- employee => {
- type => 'one to one',
- class => 'SL::DB::Employee',
- column_map => { employee_id => 'id' },
+ transactions => {
+ type => 'one to many',
+ class => 'SL::DB::AccTransaction',
+ column_map => { id => 'trans_id' },
+ manager_args => {
+ with_objects => [ 'chart' ],
+ sort_by => 'acc_trans_id ASC',
+ },
},
);
__PACKAGE__->meta->initialize;
+__PACKAGE__->attr_html('notes');
+__PACKAGE__->attr_sorted('items');
+
+__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 record_number { goto &invnumber; };
+
+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 {
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;
- my $terms = $source->can('payment_id') && $source->payment_id ? $source->payment_term->terms_netto : 0;
+ require SL::DB::Employee;
+
+ 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);
+ @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 $terms = $source->can('payment_id') ? $source->payment_terms : undef;
- my %args = ( map({ ( $_ => $source->$_ ) } qw(customer_id taxincluded shippingpoint shipvia notes intnotes curr salesman_id cusordnumber ordnumber quonumber
- department_id cp_id language_id payment_id delivery_customer_id delivery_vendor_id taxzone_id shipto_id
- globalproject_id transaction_description)),
+ 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,
gldate => DateTime->today_local,
- duedate => DateTime->today_local->add(days => $terms * 1),
+ duedate => $terms ? $terms->calc_date(reference_date => DateTime->today_local) : DateTime->today_local,
invoice => 1,
type => 'invoice',
storno => 0,
$args{quodate} = $source->transdate;
}
- my $invoice = $class->new(%args, %params);
+ 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 = $_;
- SL::DB::InvoiceItem->new(map({ ( $_ => $source_item->$_ ) }
- qw(parts_id description qty sellprice discount project_id
- serialnumber pricegroup_id ordnumber transdate cusordnumber unit
- base_qty subtotal longdescription lastcost price_factor_id)),
- deliverydate => $source_item->reqdate,
- fxsellprice => $source_item->sellprice,);
- } @{ $source->items };
+ 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};
+ my $current_invoice_item =
+ 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 active_discount_source active_price_source), @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 : '',
+ );
+
+ $current_invoice_item->{"converted_from_orderitems_id"} = $_->{id} if ref($item_parent) eq 'SL::DB::Order';
+ $current_invoice_item->{"converted_from_delivery_order_items_id"} = $_->{id} if ref($item_parent) eq 'SL::DB::DeliveryOrder';
+ $current_invoice_item;
+ } @{ $items };
+
+ @items = grep { $params{item_filter}->($_) } @items if $params{item_filter};
+ @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);
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;
+ croak("No AR chart found and no parameter 'ar_id' given") unless $chart;
$params{ar_id} = $chart->id;
}
my %data = $self->calculate_prices_and_taxes;
$self->_post_create_assemblyitem_entries($data{assembly_items});
- $self->create_trans_number;
$self->save;
$self->_post_add_acctrans($data{amounts_cogs});
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, amount => $spec } unless ref $spec;
+ $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)->save;
+ transdate => $self->transdate,
+ chart_link => $chart_link)->save;
}
}
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 displayable_name {
+ join ' ', grep $_, map $_[0]->$_, qw(displayable_type record_number);
+};
+
+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 reqdate {
+ goto &duedate;
+}
+
+sub customervendor {
+ goto &customer;
+}
+
+sub link {
+ 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;
+
+ return $html;
+}
+
1;
__END__
=pod
+=encoding UTF-8
+
=head1 NAME
SL::DB::Invoice: Rose model for invoices (table "ar")
=over 4
-=item C<new_from $source>
+=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
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<item_filter>
+
+An optional code reference that is called for each item with the item
+as its sole parameter. Items for which the code reference returns a
+falsish value will be 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 invoice.
+For example to set a different transdate (default is the current date),
+call the method like this:
+
+ my %params;
+ $params{attributes}{transdate} = '28.08.2015';
+ $invoice = SL::DB::Invoice->new_from($self, %params)->post || die;
+
+=back
+
Amounts, prices and taxes are not
calculated. L<SL::DB::Helper::PriceTaxCalculator::calculate_prices_and_taxes>
can be used for this.
=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>
=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
+ Form.pm from ar.pl should be available:
+ # see old stuff ar.pl post
+ #$form->error($locale->text('Cannot post transaction above the maximum future booking date!'))
+ # if ($form->date_max_future($transdate, \%myconfig));
+ #$form->error($locale->text('Cannot post transaction for a closed period!')) if ($form->date_closed($form->{"transdate"}, \%myconfig));
+
=head1 AUTHOR
Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
projects / kivitendo-erp.git / blobdiff