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 SL::DB::MetaSetup::Invoice;
12 use SL::DB::Manager::Invoice;
13 use SL::DB::Helper::FlattenToForm;
14 use SL::DB::Helper::LinkedRecords;
15 use SL::DB::Helper::PriceTaxCalculator;
16 use SL::DB::Helper::PriceUpdater;
17 use SL::DB::Helper::TransNumberGenerator;
18 use SL::DB::AccTransaction;
22 __PACKAGE__->meta->add_relationship(
24 type => 'one to many',
25 class => 'SL::DB::InvoiceItem',
26 column_map => { id => 'trans_id' },
28 with_objects => [ 'part' ]
32 type => 'one to many',
33 class => 'SL::DB::Invoice',
34 column_map => { id => 'storno_id' },
38 __PACKAGE__->meta->initialize;
42 sub items { goto &invoiceitems; }
45 # For compatibility with Order, DeliveryOrder
46 croak 'not an accessor' if @_ > 1;
50 # it is assumed, that ordnumbers are unique here.
51 sub first_order_by_ordnumber {
54 my $orders = SL::DB::Manager::Order->get_all(
56 ordnumber => $self->ordnumber,
61 return first { $_->is_type('sales_order') } @{ $orders };
64 sub abschlag_percentage {
66 my $order = $self->first_order_by_ordnumber or return;
67 my $order_amount = $order->netamount or return;
68 return $self->abschlag
69 ? $self->netamount / $order_amount
75 die 'not a setter method' if @_;
77 return ($self->amount || 0) - ($self->netamount || 0);
80 __PACKAGE__->meta->make_attr_helpers(taxamount => 'numeric(15,5)');
84 return $self->paid >= $self->amount;
88 my ($class, $source, %params) = @_;
90 croak("Unsupported source object type '" . ref($source) . "'") unless ref($source) =~ m/^ SL::DB:: (?: Order | DeliveryOrder ) $/x;
91 croak("Cannot create invoices for purchase records") unless $source->customer_id;
93 my $terms = $source->can('payment_id') && $source->payment_id ? $source->payment_term->terms_netto : 0;
95 my %args = ( map({ ( $_ => $source->$_ ) } qw(customer_id taxincluded shippingpoint shipvia notes intnotes curr salesman_id cusordnumber ordnumber quonumber
96 department_id cp_id language_id payment_id delivery_customer_id delivery_vendor_id taxzone_id shipto_id
97 globalproject_id transaction_description)),
98 transdate => DateTime->today_local,
99 gldate => DateTime->today_local,
100 duedate => DateTime->today_local->add(days => $terms * 1),
105 employee_id => (SL::DB::Manager::Employee->current || SL::DB::Employee->new(id => $source->employee_id))->id,
108 if ($source->type =~ /_order$/) {
109 $args{deliverydate} = $source->reqdate;
110 $args{orddate} = $source->transdate;
112 $args{quodate} = $source->transdate;
115 my $invoice = $class->new(%args, %params);
118 my $source_item = $_;
119 SL::DB::InvoiceItem->new(map({ ( $_ => $source_item->$_ ) }
120 qw(parts_id description qty sellprice discount project_id
121 serialnumber pricegroup_id ordnumber transdate cusordnumber unit
122 base_qty subtotal longdescription lastcost price_factor_id)),
123 deliverydate => $source_item->reqdate,
124 fxsellprice => $source_item->sellprice,);
125 } @{ $source->items };
127 $invoice->invoiceitems(\@items);
133 my ($self, %params) = @_;
135 if (!$params{ar_id}) {
136 my $chart = SL::DB::Manager::Chart->get_all(query => [ SL::DB::Manager::Chart->link_filter('AR') ],
139 croak("No AR chart found and no parameter `ar_id' given") unless $chart;
140 $params{ar_id} = $chart->id;
144 my %data = $self->calculate_prices_and_taxes;
146 $self->_post_create_assemblyitem_entries($data{assembly_items});
147 $self->create_trans_number;
150 $self->_post_add_acctrans($data{amounts_cogs});
151 $self->_post_add_acctrans($data{amounts});
152 $self->_post_add_acctrans($data{taxes});
154 $self->_post_add_acctrans({ $params{ar_id} => $self->amount * -1 });
156 $self->_post_update_allocated($data{allocated});
159 if ($self->db->in_transaction) {
161 } elsif (!$self->db->do_transaction($worker)) {
162 $::lxdebug->message(LXDebug->WARN(), "convert_to_invoice failed: " . join("\n", (split(/\n/, $self->db->error))[0..2]));
169 sub _post_add_acctrans {
170 my ($self, $entries) = @_;
172 my $default_tax_id = SL::DB::Manager::Tax->find_by(taxkey => 0)->id;
174 while (my ($chart_id, $spec) = each %{ $entries }) {
175 $spec = { taxkey => 0, tax_id => $default_tax_id, amount => $spec } unless ref $spec;
176 SL::DB::AccTransaction->new(trans_id => $self->id,
177 chart_id => $chart_id,
178 amount => $spec->{amount},
179 tax_id => $spec->{tax_id},
180 taxkey => $spec->{taxkey},
181 project_id => $self->globalproject_id,
182 transdate => $self->transdate)->save;
186 sub _post_create_assemblyitem_entries {
187 my ($self, $assembly_entries) = @_;
189 my $items = $self->invoiceitems;
193 foreach my $item (@{ $items }) {
194 next if $item->assemblyitem;
196 push @new_items, $item;
199 foreach my $assembly_item (@{ $assembly_entries->[$item_idx] || [ ] }) {
200 push @new_items, SL::DB::InvoiceItem->new(parts_id => $assembly_item->{part},
201 description => $assembly_item->{part}->description,
202 unit => $assembly_item->{part}->unit,
203 qty => $assembly_item->{qty},
204 allocated => $assembly_item->{allocated},
207 assemblyitem => 't');
211 $self->invoiceitems(\@new_items);
214 sub _post_update_allocated {
215 my ($self, $allocated) = @_;
217 while (my ($invoice_id, $diff) = each %{ $allocated }) {
218 SL::DB::Manager::InvoiceItem->update_all(set => { allocated => { sql => "allocated + $diff" } },
219 where => [ id => $invoice_id ]);
226 return 'ar_transaction' if !$self->invoice;
227 return 'credit_note' if $self->type eq 'credit_note' && $self->amount < 0 && !$self->storno;
228 return 'invoice_storno' if $self->type ne 'credit_note' && $self->amount < 0 && $self->storno;
229 return 'credit_note_storno' if $self->type eq 'credit_note' && $self->amount > 0 && $self->storno;
233 sub displayable_state {
236 return $self->closed ? $::locale->text('closed') : $::locale->text('open');
247 SL::DB::Invoice: Rose model for invoices (table "ar")
253 =item C<new_from $source>
255 Creates a new C<SL::DB::Invoice> instance and copies as much
256 information from C<$source> as possible. At the moment only sales
257 orders and sales quotations are supported as sources.
259 The conversion copies order items into invoice items. Dates are copied
260 as appropriate, e.g. the C<transdate> field from an order will be
261 copied into the invoice's C<orddate> field.
263 Amounts, prices and taxes are not
264 calculated. L<SL::DB::Helper::PriceTaxCalculator::calculate_prices_and_taxes>
265 can be used for this.
267 The object returned is not saved.
269 =item C<post %params>
271 Posts the invoice. Required parameters are:
277 The ID of the accounds receivable chart the invoices amounts are
278 posted to. If it is not set then the first chart configured for
279 accounts receivables is used.
283 This function implements several steps:
287 =item 1. It calculates all prices, amounts and taxes by calling
288 L<SL::DB::Helper::PriceTaxCalculator::calculate_prices_and_taxes>.
290 =item 2. A new and unique invoice number is created.
292 =item 3. All amounts for costs of goods sold are recorded in
295 =item 4. All amounts for parts, services and assemblies are recorded
296 in C<acc_trans> with their respective charts. This is determined by
297 the part's buchungsgruppen.
299 =item 5. The total amount is posted to the accounts receivable chart
300 and recorded in C<acc_trans>.
302 =item 6. Items in C<invoice> are updated according to their allocation
303 status (regarding for costs of goold sold). Will only be done if
304 kivitendo is not configured to use Einnahmenüberschussrechnungen.
306 =item 7. The invoice and its items are saved.
310 Returns C<$self> on success and C<undef> on failure. The whole process
311 is run inside a transaction. If it fails then nothing is saved to or
312 changed in the database. A new transaction is only started if none is
315 =item C<basic_info $field>
317 See L<SL::DB::Object::basic_info>.
323 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>