1 package SL::DB::DeliveryOrder;
7 use Rose::DB::Object::Helpers ();
9 use SL::DB::MetaSetup::DeliveryOrder;
10 use SL::DB::Manager::DeliveryOrder;
11 use SL::DB::Helper::AttrHTML;
12 use SL::DB::Helper::AttrSorted;
13 use SL::DB::Helper::FlattenToForm;
14 use SL::DB::Helper::LinkedRecords;
15 use SL::DB::Helper::TransNumberGenerator;
20 use SL::Helper::Number qw(_format_total _round_total);
22 use List::Util qw(first notall);
23 use List::MoreUtils qw(any);
25 __PACKAGE__->meta->add_relationship(orderitems => { type => 'one to many',
26 class => 'SL::DB::DeliveryOrderItem',
27 column_map => { id => 'delivery_order_id' },
28 manager_args => { with_objects => [ 'part' ] }
32 class => 'SL::DB::Shipto',
33 column_map => { id => 'trans_id' },
34 query_args => [ module => 'DO' ],
38 __PACKAGE__->meta->initialize;
40 __PACKAGE__->attr_html('notes');
41 __PACKAGE__->attr_sorted('items');
43 __PACKAGE__->before_save('_before_save_set_donumber');
47 sub _before_save_set_donumber {
50 $self->create_trans_number if !$self->donumber;
57 sub items { goto &orderitems; }
58 sub add_items { goto &add_orderitems; }
59 sub payment_terms { goto &payment; }
60 sub record_number { goto &donumber; }
67 require SL::DB::Order;
68 my $orders = SL::DB::Manager::Order->get_all(
70 ordnumber => $self->ordnumber,
71 @{ $params{query} || [] },
75 return first { $_->is_type('sales_order') } @{ $orders };
79 return shift->customer_id ? 'sales_delivery_order' : 'purchase_delivery_order';
82 sub displayable_type {
83 my $type = shift->type;
85 return $::locale->text('Sales Delivery Order') if $type eq 'sales_delivery_order';
86 return $::locale->text('Purchase Delivery Order') if $type eq 'purchase_delivery_order';
91 sub displayable_name {
92 join ' ', grep $_, map $_[0]->$_, qw(displayable_type record_number);
95 sub displayable_state {
99 ($self->closed ? $::locale->text('closed') : $::locale->text('open')),
100 ($self->delivered ? $::locale->text('delivered') : $::locale->text('not delivered'));
107 sub _clone_orderitem_cvar {
110 my $cloned = $_->clone_and_reset;
111 $cloned->sub_module('delivery_order_items');
117 my ($class, $source, %params) = @_;
119 croak("Unsupported source object type '" . ref($source) . "'") unless ref($source) eq 'SL::DB::Order';
121 my ($item_parent_id_column, $item_parent_column);
123 if (ref($source) eq 'SL::DB::Order') {
124 $item_parent_id_column = 'trans_id';
125 $item_parent_column = 'order';
128 my %args = ( map({ ( $_ => $source->$_ ) } qw(cp_id currency_id customer_id cusordnumber delivery_term_id department_id employee_id globalproject_id intnotes language_id notes
129 ordnumber payment_id reqdate salesman_id shippingpoint shipvia taxincluded taxzone_id transaction_description vendor_id
132 is_sales => !!$source->customer_id,
134 transdate => DateTime->today_local,
137 # Custom shipto addresses (the ones specific to the sales/purchase
138 # record and not to the customer/vendor) are only linked from
139 # shipto → delivery_orders. Meaning delivery_orders.shipto_id
140 # will not be filled in that case.
141 if (!$source->shipto_id && $source->id) {
142 $args{custom_shipto} = $source->custom_shipto->clone($class) if $source->can('custom_shipto') && $source->custom_shipto;
145 $args{shipto_id} = $source->shipto_id;
148 my $delivery_order = $class->new(%args);
149 $delivery_order->assign_attributes(%{ $params{attributes} }) if $params{attributes};
150 my $items = delete($params{items}) || $source->items_sorted;
154 my $source_item = $_;
155 my $source_item_id = $_->$item_parent_id_column;
156 my @custom_variables = map { _clone_orderitem_cvar($_) } @{ $source_item->custom_variables };
158 $item_parents{$source_item_id} ||= $source_item->$item_parent_column;
159 my $item_parent = $item_parents{$source_item_id};
161 my $current_do_item = SL::DB::DeliveryOrderItem->new(map({ ( $_ => $source_item->$_ ) }
162 qw(base_qty cusordnumber description discount lastcost longdescription marge_price_factor parts_id price_factor price_factor_id
163 project_id qty reqdate sellprice serialnumber transdate unit active_discount_source active_price_source
165 custom_variables => \@custom_variables,
166 ordnumber => ref($item_parent) eq 'SL::DB::Order' ? $item_parent->ordnumber : $source_item->ordnumber,
168 $current_do_item->{"converted_from_orderitems_id"} = $_->{id} if ref($item_parent) eq 'SL::DB::Order';
172 @items = grep { $params{item_filter}->($_) } @items if $params{item_filter};
173 @items = grep { $_->qty * 1 } @items if $params{skip_items_zero_qty};
174 @items = grep { $_->qty >=0 } @items if $params{skip_items_negative_qty};
176 $delivery_order->items(\@items);
178 return $delivery_order;
181 sub new_from_time_recordings {
182 my ($class, $sources, %params) = @_;
184 croak("Unsupported object type in sources") if any { ref($_) ne 'SL::DB::TimeRecording' } @$sources;
185 croak("Cannot create delivery order from source records of different customers") if any { $_->customer_id != $sources->[0]->customer_id } @$sources;
190 customer_id => $sources->[0]->customer_id,
191 taxzone_id => $sources->[0]->customer->taxzone_id,
192 currency_id => $sources->[0]->customer->currency_id,
193 employee_id => SL::DB::Manager::Employee->current->id,
194 salesman_id => SL::DB::Manager::Employee->current->id,
197 my $delivery_order = $class->new(%args);
198 $delivery_order->assign_attributes(%{ $params{attributes} }) if $params{attributes};
200 # - one item per part (article)
201 # - qty is sum of duration
202 # - description goes to item longdescription
203 # - ordered and summed by date
204 # - each description goes to an ordered list
205 # - (as time recording descriptions are formatted text by now, use stripped text)
206 # - merge same descriptions (todo)
210 my $default_partnummer = 6;
211 my $default_part_id = SL::DB::Manager::Part->find_by(partnumber => $default_partnummer)->id;
213 # check parts and collect entries
216 foreach my $source (@$sources) {
217 my $part_id = $source->part_id ? $source->part_id
218 : $default_part_id ? $default_part_id
221 die 'article not found for entry "' . $source->displayable_times . '"' if !$part_id;
223 if (!$part_by_part_id{$part_id}) {
224 $part_by_part_id{$part_id} = SL::DB::Part->new(id => $part_id)->load;
225 die 'article unit must be time based for entry "' . $source->displayable_times . '"' if !$part_by_part_id{$part_id}->unit_obj->is_time_based;
228 my $date = $source->start_time->to_kivitendo;
229 $entries->{$part_id}->{$date}->{duration} += _round_total($source->duration_in_hours);
230 $entries->{$part_id}->{$date}->{content} .= '<li>' . $source->description_as_stripped_html . '</li>';
231 $entries->{$part_id}->{$date}->{date_obj} = $source->start_time; # for sorting
234 my $h_unit = SL::DB::Manager::Unit->find_h_unit;
236 my @keys = sort { $part_by_part_id{$a}->partnumber cmp $part_by_part_id{$b}->partnumber } keys %$entries;
237 foreach my $key (@keys) {
239 my $longdescription = '';
241 my @dates = sort { $entries->{$key}->{$a}->{date_obj} <=> $entries->{$key}->{$b}->{date_obj} } keys %{$entries->{$key}};
242 foreach my $date (@dates) {
243 my $entry = $entries->{$key}->{$date};
245 $qty += $entry->{duration};
246 $longdescription .= $date . ' <strong>' . _format_total($entry->{duration}) . ' h</strong>';
247 $longdescription .= '<ul>';
248 $longdescription .= $entry->{content};
249 $longdescription .= '</ul>';
252 my $item = SL::DB::DeliveryOrderItem->new(
253 parts_id => $part_by_part_id{$key}->id,
254 description => $part_by_part_id{$key}->description,
257 sellprice => $part_by_part_id{$key}->sellprice,
258 longdescription => $longdescription,
261 $delivery_order->add_items($item);
264 return $delivery_order;
268 $_[0]->is_sales ? $_[0]->customer : $_[0]->vendor;
271 sub convert_to_invoice {
272 my ($self, %params) = @_;
274 croak("Conversion to invoices is only supported for sales records") unless $self->customer_id;
277 if (!$self->db->with_transaction(sub {
278 require SL::DB::Invoice;
279 $invoice = SL::DB::Invoice->new_from($self, %params)->post || die;
280 $self->link_to_record($invoice);
281 # TODO extend link_to_record for items, otherwise long-term no d.r.y.
282 foreach my $item (@{ $invoice->items }) {
283 foreach (qw(delivery_order_items)) { # expand if needed (orderitems)
284 if ($item->{"converted_from_${_}_id"}) {
285 die unless $item->{id};
286 RecordLinks->create_links('mode' => 'ids',
288 'from_ids' => $item->{"converted_from_${_}_id"},
289 'to_table' => 'invoice',
290 'to_id' => $item->{id},
292 delete $item->{"converted_from_${_}_id"};
296 $self->update_attributes(closed => 1);
308 sprintf "%s %s (%s)",
310 $self->customervendor->name,
311 $self->date->to_kivitendo;
323 SL::DB::DeliveryOrder - Rose model for delivery orders (table
332 An alias for C<transdate> for compatibility with other sales/purchase models.
334 =item C<displayable_name>
336 Returns a human-readable and translated description of the delivery order, consisting of
337 record type and number, e.g. "Verkaufslieferschein 123".
339 =item C<displayable_state>
341 Returns a human-readable description of the state regarding being
342 closed and delivered.
346 An alias for C<delivery_order_items> for compatibility with other
347 sales/purchase models.
349 =item C<new_from $source, %params>
351 Creates a new C<SL::DB::DeliveryOrder> instance and copies as much
352 information from C<$source> as possible. At the moment only instances
353 of C<SL::DB::Order> (sales quotations, sales orders, requests for
354 quotations and purchase orders) are supported as sources.
356 The conversion copies order items into delivery order items. Dates are copied
357 as appropriate, e.g. the C<transdate> field will be set to the current date.
359 Returns the new delivery order instance. The object returned is not
362 C<%params> can include the following options:
368 An optional array reference of RDBO instances for the items to use. If
369 missing then the method C<items_sorted> will be called on
370 C<$source>. This option can be used to override the sorting, to
371 exclude certain positions or to add additional ones.
373 =item C<skip_items_negative_qty>
375 If trueish then items with a negative quantity are skipped. Items with
376 a quantity of 0 are not affected by this option.
378 =item C<skip_items_zero_qty>
380 If trueish then items with a quantity of 0 are skipped.
384 An optional code reference that is called for each item with the item
385 as its sole parameter. Items for which the code reference returns a
386 falsish value will be skipped.
390 An optional hash reference. If it exists then it is passed to C<new>
391 allowing the caller to set certain attributes for the new delivery
396 =item C<new_from_time_recordings $sources, %params>
398 Creates a new C<SL::DB::DeliveryOrder> instace from the time recordings
399 given as C<$sources>. All time recording entries must belong to the same
400 customer. Time recordings are sorted by article and date. For each article
401 a new delivery order item is created. If no article is associated with an
402 entry, a default article will be used (hard coded).
403 Entries of the same date (for each article) are summed together and form a
404 list entry in the long description of the item.
406 The created delivery order object will be returnd but not saved.
408 C<$sources> must be an array reference of C<SL::DB::TimeRecording> instances.
410 C<%params> can include the following options:
416 An optional hash reference. If it exists then it is used to set
417 attributes of the newly created delivery order object.
423 TODO: Describe sales_order
427 Returns a string describing this record's type: either
428 C<sales_delivery_order> or C<purchase_delivery_order>.
430 =item C<convert_to_invoice %params>
432 Creates a new invoice with C<$self> as the basis by calling
433 L<SL::DB::Invoice::new_from>. That invoice is posted, and C<$self> is
434 linked to the new invoice via L<SL::DB::RecordLink>. C<$self>'s
435 C<closed> attribute is set to C<true>, and C<$self> is saved.
437 The arguments in C<%params> are passed to L<SL::DB::Invoice::new_from>.
439 Returns the new invoice instance on success and C<undef> on
440 failure. The whole process is run inside a transaction. On failure
441 nothing is created or changed in the database.
443 At the moment only sales delivery orders can be converted.
453 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>