Projekt

Allgemein

Profil

Herunterladen (16,2 KB) Statistiken
| Zweig: | Markierung: | Revision:
82515b2d Sven Schöling
package SL::DB::Invoice;

use strict;

73df5fb5 Moritz Bunkus
use Carp;
82515b2d Sven Schöling
use List::Util qw(first);

2714604a Moritz Bunkus
use Rose::DB::Object::Helpers ();
82515b2d Sven Schöling
use SL::DB::MetaSetup::Invoice;
use SL::DB::Manager::Invoice;
15f58ff3 Geoffrey Richardson
use SL::DB::Helper::Payment qw(:ALL);
a34c05f3 Moritz Bunkus
use SL::DB::Helper::AttrHTML;
f63af42d Moritz Bunkus
use SL::DB::Helper::AttrSorted;
c692dae1 Moritz Bunkus
use SL::DB::Helper::FlattenToForm;
e9fb6244 Moritz Bunkus
use SL::DB::Helper::LinkedRecords;
use SL::DB::Helper::PriceTaxCalculator;
2209370e Moritz Bunkus
use SL::DB::Helper::PriceUpdater;
b9dbc9e3 Moritz Bunkus
use SL::DB::Helper::TransNumberGenerator;
f6ed86ef Geoffrey Richardson
use SL::Locale::String qw(t8);
6a12a968 Niclas Zimmermann
use SL::DB::CustomVariable;
82515b2d Sven Schöling
__PACKAGE__->meta->add_relationship(
invoiceitems => {
type => 'one to many',
class => 'SL::DB::InvoiceItem',
column_map => { id => 'trans_id' },
manager_args => {
0845c4b7 Moritz Bunkus
with_objects => [ 'part' ]
82515b2d Sven Schöling
}
},
1d0a5eee Moritz Bunkus
storno_invoices => {
type => 'one to many',
class => 'SL::DB::Invoice',
column_map => { id => 'storno_id' },
},
fc1490e8 Moritz Bunkus
sepa_export_items => {
type => 'one to many',
class => 'SL::DB::SepaExportItem',
column_map => { id => 'ar_id' },
manager_args => { with_objects => [ 'sepa_export' ] }
},
325c539c Moritz Bunkus
custom_shipto => {
type => 'one to one',
class => 'SL::DB::Shipto',
column_map => { id => 'trans_id' },
query_args => [ module => 'AR' ],
},
0395c036 Geoffrey Richardson
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',
},
},
82515b2d Sven Schöling
);

__PACKAGE__->meta->initialize;

a34c05f3 Moritz Bunkus
__PACKAGE__->attr_html('notes');
f63af42d Moritz Bunkus
__PACKAGE__->attr_sorted('items');
a34c05f3 Moritz Bunkus
57d6293d Moritz Bunkus
__PACKAGE__->before_save('_before_save_set_invnumber');

# hooks

sub _before_save_set_invnumber {
my ($self) = @_;

$self->create_trans_number if !$self->invnumber;

return 1;
}

82515b2d Sven Schöling
# methods

0845c4b7 Moritz Bunkus
sub items { goto &invoiceitems; }
ae906113 Moritz Bunkus
sub add_items { goto &add_invoiceitems; }
4f7e0fa9 Geoffrey Richardson
sub record_number { goto &invnumber; };
4ac74078 Moritz Bunkus
a93f1e39 Moritz Bunkus
sub is_sales {
# For compatibility with Order, DeliveryOrder
croak 'not an accessor' if @_ > 1;
return 1;
}

82515b2d Sven Schöling
# it is assumed, that ordnumbers are unique here.
sub first_order_by_ordnumber {
my $self = shift;

my $orders = SL::DB::Manager::Order->get_all(
query => [
ordnumber => $self->ordnumber,

],
);

return first { $_->is_type('sales_order') } @{ $orders };
}

sub abschlag_percentage {
my $self = shift;
my $order = $self->first_order_by_ordnumber or return;
my $order_amount = $order->netamount or return;
return $self->abschlag
? $self->netamount / $order_amount
: undef;
}

sub taxamount {
my $self = shift;
die 'not a setter method' if @_;

55049b81 Sven Schöling
return ($self->amount || 0) - ($self->netamount || 0);
82515b2d Sven Schöling
}

78034f24 Sven Schöling
__PACKAGE__->meta->make_attr_helpers(taxamount => 'numeric(15,5)');

dce860e3 Moritz Bunkus
sub closed {
my ($self) = @_;
return $self->paid >= $self->amount;
}

2714604a Moritz Bunkus
sub _clone_orderitem_delivery_order_item_cvar {
my ($cvar) = @_;

my $cloned = Rose::DB::Object::Helpers::clone_and_reset($_);
$cloned->sub_module('invoice');

return $cloned;
}

73df5fb5 Moritz Bunkus
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;

e4b46220 Sven Schöling
require SL::DB::Employee;

6ee486a5 Moritz Bunkus
my (@columns, @item_columns, $item_parent_id_column, $item_parent_column);
73df5fb5 Moritz Bunkus
d81f55ce Moritz Bunkus
if (ref($source) eq 'SL::DB::Order') {
464f44ac Moritz Bunkus
@columns = qw(quonumber delivery_customer_id delivery_vendor_id);
d81f55ce Moritz Bunkus
@item_columns = qw(subtotal);

6ee486a5 Moritz Bunkus
$item_parent_id_column = 'trans_id';
$item_parent_column = 'order';

d81f55ce Moritz Bunkus
} else {
@columns = qw(donumber);
6ee486a5 Moritz Bunkus
$item_parent_id_column = 'delivery_order_id';
$item_parent_column = 'delivery_order';
d81f55ce Moritz Bunkus
}

464f44ac Moritz Bunkus
my $terms = $source->can('payment_id') ? $source->payment_terms : undef;

d81f55ce Moritz Bunkus
my %args = ( map({ ( $_ => $source->$_ ) } qw(customer_id taxincluded shippingpoint shipvia notes intnotes salesman_id cusordnumber ordnumber department_id
464f44ac Moritz Bunkus
cp_id language_id taxzone_id shipto_id globalproject_id transaction_description currency_id delivery_term_id payment_id), @columns),
73df5fb5 Moritz Bunkus
transdate => DateTime->today_local,
gldate => DateTime->today_local,
464f44ac Moritz Bunkus
duedate => $terms ? $terms->calc_date(reference_date => DateTime->today_local) : DateTime->today_local,
73df5fb5 Moritz Bunkus
invoice => 1,
type => 'invoice',
storno => 0,
22150c52 Moritz Bunkus
paid => 0,
73df5fb5 Moritz Bunkus
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;
}

6473dcb1 Moritz Bunkus
my $invoice = $class->new(%args);
$invoice->assign_attributes(%{ $params{attributes} }) if $params{attributes};
53aad992 Moritz Bunkus
my $items = delete($params{items}) || $source->items_sorted;
6ee486a5 Moritz Bunkus
my %item_parents;
73df5fb5 Moritz Bunkus
my @items = map {
2714604a Moritz Bunkus
my $source_item = $_;
6ee486a5 Moritz Bunkus
my $source_item_id = $_->$item_parent_id_column;
2714604a Moritz Bunkus
my @custom_variables = map { _clone_orderitem_delivery_order_item_cvar($_) } @{ $source_item->custom_variables };

6ee486a5 Moritz Bunkus
$item_parents{$source_item_id} ||= $source_item->$item_parent_column;
my $item_parent = $item_parents{$source_item_id};
34420ddb Jan Büren
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;
53aad992 Moritz Bunkus
} @{ $items };
73df5fb5 Moritz Bunkus
bbb98e03 Moritz Bunkus
@items = grep { $params{item_filter}->($_) } @items if $params{item_filter};
fff57e55 Moritz Bunkus
@items = grep { $_->qty * 1 } @items if $params{skip_items_zero_qty};
f9fdf190 Moritz Bunkus
@items = grep { $_->qty >=0 } @items if $params{skip_items_negative_qty};
fff57e55 Moritz Bunkus
73df5fb5 Moritz Bunkus
$invoice->invoiceitems(\@items);

return $invoice;
}

dce860e3 Moritz Bunkus
sub post {
my ($self, %params) = @_;

e4b46220 Sven Schöling
require SL::DB::Chart;
ed3be965 Moritz Bunkus
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;
}
dd04aff2 Moritz Bunkus
22150c52 Moritz Bunkus
my $worker = sub {
dce860e3 Moritz Bunkus
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});

dd04aff2 Moritz Bunkus
$self->_post_add_acctrans({ $params{ar_id} => $self->amount * -1 });

dce860e3 Moritz Bunkus
$self->_post_update_allocated($data{allocated});
22150c52 Moritz Bunkus
};

if ($self->db->in_transaction) {
$worker->();
} elsif (!$self->db->do_transaction($worker)) {
0e25aa33 Moritz Bunkus
$::lxdebug->message(LXDebug->WARN(), "convert_to_invoice failed: " . join("\n", (split(/\n/, $self->db->error))[0..2]));
22150c52 Moritz Bunkus
return undef;
}
dce860e3 Moritz Bunkus
22150c52 Moritz Bunkus
return $self;
dce860e3 Moritz Bunkus
}

sub _post_add_acctrans {
my ($self, $entries) = @_;

03ff37cb Niclas Zimmermann
my $default_tax_id = SL::DB::Manager::Tax->find_by(taxkey => 0)->id;
3af5e2e0 Niclas Zimmermann
my $chart_link;
03ff37cb Niclas Zimmermann
e4b46220 Sven Schöling
require SL::DB::AccTransaction;
require SL::DB::Chart;
dce860e3 Moritz Bunkus
while (my ($chart_id, $spec) = each %{ $entries }) {
03ff37cb Niclas Zimmermann
$spec = { taxkey => 0, tax_id => $default_tax_id, amount => $spec } unless ref $spec;
3af5e2e0 Niclas Zimmermann
$chart_link = SL::DB::Manager::Chart->find_by(id => $chart_id)->{'link'};
$chart_link ||= '';

373cec3f Moritz Bunkus
SL::DB::AccTransaction->new(trans_id => $self->id,
chart_id => $chart_id,
amount => $spec->{amount},
03ff37cb Niclas Zimmermann
tax_id => $spec->{tax_id},
373cec3f Moritz Bunkus
taxkey => $spec->{taxkey},
project_id => $self->globalproject_id,
3af5e2e0 Niclas Zimmermann
transdate => $self->transdate,
chart_link => $chart_link)->save;
dce860e3 Moritz Bunkus
}
}

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 }) {
22150c52 Moritz Bunkus
SL::DB::Manager::InvoiceItem->update_all(set => { allocated => { sql => "allocated + $diff" } },
dce860e3 Moritz Bunkus
where => [ id => $invoice_id ]);
}
}

2746ccd0 Sven Schöling
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');
}

001155e4 Sven Schöling
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');
}

a7114646 Geoffrey Richardson
sub displayable_name {
join ' ', grep $_, map $_[0]->$_, qw(displayable_type record_number);
};

f6ed86ef Geoffrey Richardson
sub abbreviation {
49f5b7f7 Geoffrey Richardson
my ($self) = @_;
f6ed86ef Geoffrey Richardson
49f5b7f7 Geoffrey Richardson
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';
f6ed86ef Geoffrey Richardson
return t8('Invoice (one letter abbreviation)');
}

16c6be41 Moritz Bunkus
sub date {
goto &transdate;
}

704f339f Sven Schöling
sub reqdate {
goto &duedate;
}

1e2673bb Sven Schöling
sub customervendor {
goto &customer;
}

6a12a968 Niclas Zimmermann
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;
}

82515b2d Sven Schöling
1;
6834acd9 Moritz Bunkus
__END__

=pod

=head1 NAME

SL::DB::Invoice: Rose model for invoices (table "ar")

=head1 FUNCTIONS

=over 4

074e54e7 Moritz Bunkus
=item C<new_from $source, %params>
6834acd9 Moritz Bunkus
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.

074e54e7 Moritz Bunkus
C<%params> can include the following options:

=over 2

53aad992 Moritz Bunkus
=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.

f9fdf190 Moritz Bunkus
=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.

fff57e55 Moritz Bunkus
=item C<skip_items_zero_qty>

If trueish then items with a quantity of 0 are skipped.

bbb98e03 Moritz Bunkus
=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.

074e54e7 Moritz Bunkus
=item C<attributes>

An optional hash reference. If it exists then it is passed to C<new>
20118160 Jan Büren
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;
074e54e7 Moritz Bunkus
=back

6834acd9 Moritz Bunkus
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
ed3be965 Moritz Bunkus
posted to. If it is not set then the first chart configured for
accounts receivables is used.
6834acd9 Moritz Bunkus
=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
4bacfb02 Moritz Bunkus
kivitendo is not configured to use Einnahmenüberschussrechnungen.
6834acd9 Moritz Bunkus
=item 7. The invoice and its items are saved.

=back

78600d89 Moritz Bunkus
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.
6834acd9 Moritz Bunkus
=item C<basic_info $field>

See L<SL::DB::Object::basic_info>.

=back

20118160 Jan Büren
=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));

6834acd9 Moritz Bunkus
=head1 AUTHOR

Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>

=cut