1 # This file has been auto-generated only because it didn't exist.
2 # Feel free to modify it at will; it will not be overwritten automatically.
4 package SL::DB::Invoice;
9 use List::Util qw(first);
11 use Rose::DB::Object::Helpers ();
12 use SL::DB::MetaSetup::Invoice;
13 use SL::DB::Manager::Invoice;
14 use SL::DB::Helper::Payment qw(:ALL);
15 use SL::DB::Helper::AttrHTML;
16 use SL::DB::Helper::FlattenToForm;
17 use SL::DB::Helper::LinkedRecords;
18 use SL::DB::Helper::PriceTaxCalculator;
19 use SL::DB::Helper::PriceUpdater;
20 use SL::DB::Helper::TransNumberGenerator;
21 use SL::Locale::String qw(t8);
22 use SL::DB::CustomVariable;
24 __PACKAGE__->meta->add_relationship(
26 type => 'one to many',
27 class => 'SL::DB::InvoiceItem',
28 column_map => { id => 'trans_id' },
30 with_objects => [ 'part' ]
34 type => 'one to many',
35 class => 'SL::DB::Invoice',
36 column_map => { id => 'storno_id' },
38 sepa_export_items => {
39 type => 'one to many',
40 class => 'SL::DB::SepaExportItem',
41 column_map => { id => 'ar_id' },
42 manager_args => { with_objects => [ 'sepa_export' ] }
46 class => 'SL::DB::Shipto',
47 column_map => { id => 'trans_id' },
48 query_args => [ module => 'AR' ],
51 type => 'one to many',
52 class => 'SL::DB::AccTransaction',
53 column_map => { id => 'trans_id' },
55 with_objects => [ 'chart' ],
56 sort_by => 'acc_trans_id ASC',
61 __PACKAGE__->meta->initialize;
63 __PACKAGE__->attr_html('notes');
65 __PACKAGE__->before_save('_before_save_set_invnumber');
69 sub _before_save_set_invnumber {
72 $self->create_trans_number if !$self->invnumber;
79 sub items { goto &invoiceitems; }
80 sub add_items { goto &add_invoiceitems; }
85 return [ sort {$a->position <=> $b->position } @{ $self->items } ];
89 # For compatibility with Order, DeliveryOrder
90 croak 'not an accessor' if @_ > 1;
94 # it is assumed, that ordnumbers are unique here.
95 sub first_order_by_ordnumber {
98 my $orders = SL::DB::Manager::Order->get_all(
100 ordnumber => $self->ordnumber,
105 return first { $_->is_type('sales_order') } @{ $orders };
108 sub abschlag_percentage {
110 my $order = $self->first_order_by_ordnumber or return;
111 my $order_amount = $order->netamount or return;
112 return $self->abschlag
113 ? $self->netamount / $order_amount
119 die 'not a setter method' if @_;
121 return ($self->amount || 0) - ($self->netamount || 0);
124 __PACKAGE__->meta->make_attr_helpers(taxamount => 'numeric(15,5)');
128 return $self->paid >= $self->amount;
131 sub _clone_orderitem_delivery_order_item_cvar {
134 my $cloned = Rose::DB::Object::Helpers::clone_and_reset($_);
135 $cloned->sub_module('invoice');
141 my ($class, $source, %params) = @_;
143 croak("Unsupported source object type '" . ref($source) . "'") unless ref($source) =~ m/^ SL::DB:: (?: Order | DeliveryOrder ) $/x;
144 croak("Cannot create invoices for purchase records") unless $source->customer_id;
146 require SL::DB::Employee;
148 my $terms = $source->can('payment_id') && $source->payment_id ? $source->payment_terms
149 : $source->customer_id ? $source ->customer->payment_terms
152 my (@columns, @item_columns, $item_parent_id_column, $item_parent_column);
154 if (ref($source) eq 'SL::DB::Order') {
155 @columns = qw(quonumber payment_id delivery_customer_id delivery_vendor_id);
156 @item_columns = qw(subtotal);
158 $item_parent_id_column = 'trans_id';
159 $item_parent_column = 'order';
162 @columns = qw(donumber);
164 $item_parent_id_column = 'delivery_order_id';
165 $item_parent_column = 'delivery_order';
168 my %args = ( map({ ( $_ => $source->$_ ) } qw(customer_id taxincluded shippingpoint shipvia notes intnotes salesman_id cusordnumber ordnumber department_id
169 cp_id language_id taxzone_id shipto_id globalproject_id transaction_description currency_id delivery_term_id), @columns),
170 transdate => DateTime->today_local,
171 gldate => DateTime->today_local,
172 duedate => DateTime->today_local->add(days => ($terms ? $terms->terms_netto * 1 : 1)),
173 payment_id => $terms ? $terms->id : undef,
178 employee_id => (SL::DB::Manager::Employee->current || SL::DB::Employee->new(id => $source->employee_id))->id,
181 if ($source->type =~ /_order$/) {
182 $args{deliverydate} = $source->reqdate;
183 $args{orddate} = $source->transdate;
185 $args{quodate} = $source->transdate;
188 my $invoice = $class->new(%args);
189 $invoice->assign_attributes(%{ $params{attributes} }) if $params{attributes};
190 my $items = delete($params{items}) || $source->items_sorted;
194 my $source_item = $_;
195 my $source_item_id = $_->$item_parent_id_column;
196 my @custom_variables = map { _clone_orderitem_delivery_order_item_cvar($_) } @{ $source_item->custom_variables };
198 $item_parents{$source_item_id} ||= $source_item->$item_parent_column;
199 my $item_parent = $item_parents{$source_item_id};
200 my $current_invoice_item =
201 SL::DB::InvoiceItem->new(map({ ( $_ => $source_item->$_ ) }
202 qw(parts_id description qty sellprice discount project_id serialnumber pricegroup_id transdate cusordnumber unit
203 base_qty longdescription lastcost price_factor_id active_discount_source active_price_source), @item_columns),
204 deliverydate => $source_item->reqdate,
205 fxsellprice => $source_item->sellprice,
206 custom_variables => \@custom_variables,
207 ordnumber => ref($item_parent) eq 'SL::DB::Order' ? $item_parent->ordnumber : $source_item->ordnumber,
208 donumber => ref($item_parent) eq 'SL::DB::DeliveryOrder' ? $item_parent->donumber : $source_item->can('donumber') ? $source_item->donumber : '',
211 $current_invoice_item->{"converted_from_orderitems_id"} = $_->{id} if ref($item_parent) eq 'SL::DB::Order';
212 $current_invoice_item->{"converted_from_delivery_order_items_id"} = $_->{id} if ref($item_parent) eq 'SL::DB::DeliveryOrder';
213 $current_invoice_item;
216 @items = grep { $_->qty * 1 } @items if $params{skip_items_zero_qty};
217 @items = grep { $_->qty >=0 } @items if $params{skip_items_negative_qty};
219 $invoice->invoiceitems(\@items);
225 my ($self, %params) = @_;
227 require SL::DB::Chart;
228 if (!$params{ar_id}) {
229 my $chart = SL::DB::Manager::Chart->get_all(query => [ SL::DB::Manager::Chart->link_filter('AR') ],
232 croak("No AR chart found and no parameter `ar_id' given") unless $chart;
233 $params{ar_id} = $chart->id;
237 my %data = $self->calculate_prices_and_taxes;
239 $self->_post_create_assemblyitem_entries($data{assembly_items});
242 $self->_post_add_acctrans($data{amounts_cogs});
243 $self->_post_add_acctrans($data{amounts});
244 $self->_post_add_acctrans($data{taxes});
246 $self->_post_add_acctrans({ $params{ar_id} => $self->amount * -1 });
248 $self->_post_update_allocated($data{allocated});
251 if ($self->db->in_transaction) {
253 } elsif (!$self->db->do_transaction($worker)) {
254 $::lxdebug->message(LXDebug->WARN(), "convert_to_invoice failed: " . join("\n", (split(/\n/, $self->db->error))[0..2]));
261 sub _post_add_acctrans {
262 my ($self, $entries) = @_;
264 my $default_tax_id = SL::DB::Manager::Tax->find_by(taxkey => 0)->id;
267 require SL::DB::AccTransaction;
268 require SL::DB::Chart;
269 while (my ($chart_id, $spec) = each %{ $entries }) {
270 $spec = { taxkey => 0, tax_id => $default_tax_id, amount => $spec } unless ref $spec;
271 $chart_link = SL::DB::Manager::Chart->find_by(id => $chart_id)->{'link'};
274 SL::DB::AccTransaction->new(trans_id => $self->id,
275 chart_id => $chart_id,
276 amount => $spec->{amount},
277 tax_id => $spec->{tax_id},
278 taxkey => $spec->{taxkey},
279 project_id => $self->globalproject_id,
280 transdate => $self->transdate,
281 chart_link => $chart_link)->save;
285 sub _post_create_assemblyitem_entries {
286 my ($self, $assembly_entries) = @_;
288 my $items = $self->invoiceitems;
292 foreach my $item (@{ $items }) {
293 next if $item->assemblyitem;
295 push @new_items, $item;
298 foreach my $assembly_item (@{ $assembly_entries->[$item_idx] || [ ] }) {
299 push @new_items, SL::DB::InvoiceItem->new(parts_id => $assembly_item->{part},
300 description => $assembly_item->{part}->description,
301 unit => $assembly_item->{part}->unit,
302 qty => $assembly_item->{qty},
303 allocated => $assembly_item->{allocated},
306 assemblyitem => 't');
310 $self->invoiceitems(\@new_items);
313 sub _post_update_allocated {
314 my ($self, $allocated) = @_;
316 while (my ($invoice_id, $diff) = each %{ $allocated }) {
317 SL::DB::Manager::InvoiceItem->update_all(set => { allocated => { sql => "allocated + $diff" } },
318 where => [ id => $invoice_id ]);
325 return 'ar_transaction' if !$self->invoice;
326 return 'credit_note' if $self->type eq 'credit_note' && $self->amount < 0 && !$self->storno;
327 return 'invoice_storno' if $self->type ne 'credit_note' && $self->amount < 0 && $self->storno;
328 return 'credit_note_storno' if $self->type eq 'credit_note' && $self->amount > 0 && $self->storno;
332 sub displayable_state {
335 return $self->closed ? $::locale->text('closed') : $::locale->text('open');
338 sub displayable_type {
341 return t8('AR Transaction') if $self->invoice_type eq 'ar_transaction';
342 return t8('Credit Note') if $self->invoice_type eq 'credit_note';
343 return t8('Invoice') . "(" . t8('Storno') . ")" if $self->invoice_type eq 'invoice_storno';
344 return t8('Credit Note') . "(" . t8('Storno') . ")" if $self->invoice_type eq 'credit_note_storno';
345 return t8('Invoice');
351 return t8('AR Transaction (abbreviation)') if $self->invoice_type eq 'ar_transaction';
352 return t8('Credit note (one letter abbreviation)') if $self->invoice_type eq 'credit_note';
353 return t8('Invoice (one letter abbreviation)') . "(" . t8('Storno (one letter abbreviation)') . ")" if $self->invoice_type eq 'invoice_storno';
354 return t8('Credit note (one letter abbreviation)') . "(" . t8('Storno (one letter abbreviation)') . ")" if $self->invoice_type eq 'credit_note_storno';
355 return t8('Invoice (one letter abbreviation)');
374 $html = SL::Presenter->get->sales_invoice($self, display => 'inline') if $self->invoice;
375 $html = SL::Presenter->get->ar_transaction($self, display => 'inline') if !$self->invoice;
388 SL::DB::Invoice: Rose model for invoices (table "ar")
394 =item C<new_from $source, %params>
396 Creates a new C<SL::DB::Invoice> instance and copies as much
397 information from C<$source> as possible. At the moment only sales
398 orders and sales quotations are supported as sources.
400 The conversion copies order items into invoice items. Dates are copied
401 as appropriate, e.g. the C<transdate> field from an order will be
402 copied into the invoice's C<orddate> field.
404 C<%params> can include the following options:
410 An optional array reference of RDBO instances for the items to use. If
411 missing then the method C<items_sorted> will be called on
412 C<$source>. This option can be used to override the sorting, to
413 exclude certain positions or to add additional ones.
415 =item C<skip_items_negative_qty>
417 If trueish then items with a negative quantity are skipped. Items with
418 a quantity of 0 are not affected by this option.
420 =item C<skip_items_zero_qty>
422 If trueish then items with a quantity of 0 are skipped.
426 An optional hash reference. If it exists then it is passed to C<new>
427 allowing the caller to set certain attributes for the new delivery
432 Amounts, prices and taxes are not
433 calculated. L<SL::DB::Helper::PriceTaxCalculator::calculate_prices_and_taxes>
434 can be used for this.
436 The object returned is not saved.
438 =item C<post %params>
440 Posts the invoice. Required parameters are:
446 The ID of the accounds receivable chart the invoices amounts are
447 posted to. If it is not set then the first chart configured for
448 accounts receivables is used.
452 This function implements several steps:
456 =item 1. It calculates all prices, amounts and taxes by calling
457 L<SL::DB::Helper::PriceTaxCalculator::calculate_prices_and_taxes>.
459 =item 2. A new and unique invoice number is created.
461 =item 3. All amounts for costs of goods sold are recorded in
464 =item 4. All amounts for parts, services and assemblies are recorded
465 in C<acc_trans> with their respective charts. This is determined by
466 the part's buchungsgruppen.
468 =item 5. The total amount is posted to the accounts receivable chart
469 and recorded in C<acc_trans>.
471 =item 6. Items in C<invoice> are updated according to their allocation
472 status (regarding for costs of goold sold). Will only be done if
473 kivitendo is not configured to use Einnahmenüberschussrechnungen.
475 =item 7. The invoice and its items are saved.
479 Returns C<$self> on success and C<undef> on failure. The whole process
480 is run inside a transaction. If it fails then nothing is saved to or
481 changed in the database. A new transaction is only started if none is
484 =item C<basic_info $field>
486 See L<SL::DB::Object::basic_info>.
492 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>