8 use List::Util qw(max);
9 use List::MoreUtils qw(any);
11 use SL::DB::MetaSetup::Order;
12 use SL::DB::Manager::Order;
13 use SL::DB::Helper::AttrHTML;
14 use SL::DB::Helper::AttrSorted;
15 use SL::DB::Helper::FlattenToForm;
16 use SL::DB::Helper::LinkedRecords;
17 use SL::DB::Helper::PriceTaxCalculator;
18 use SL::DB::Helper::PriceUpdater;
19 use SL::DB::Helper::TransNumberGenerator;
21 use Rose::DB::Object::Helpers qw(as_tree);
23 __PACKAGE__->meta->add_relationship(
25 type => 'one to many',
26 class => 'SL::DB::OrderItem',
27 column_map => { id => 'trans_id' },
29 with_objects => [ 'part' ]
32 periodic_invoices_config => {
34 class => 'SL::DB::PeriodicInvoicesConfig',
35 column_map => { id => 'oe_id' },
39 class => 'SL::DB::Shipto',
40 column_map => { id => 'trans_id' },
41 query_args => [ module => 'OE' ],
45 __PACKAGE__->meta->initialize;
47 __PACKAGE__->attr_html('notes');
48 __PACKAGE__->attr_sorted('items');
50 __PACKAGE__->before_save('_before_save_set_ord_quo_number');
54 sub _before_save_set_ord_quo_number {
57 # ordnumber is 'NOT NULL'. Therefore make sure it's always set to at
58 # least an empty string, even if we're saving a quotation.
59 $self->ordnumber('') if !$self->ordnumber;
61 my $field = $self->quotation ? 'quonumber' : 'ordnumber';
62 $self->create_trans_number if !$self->$field;
69 sub items { goto &orderitems; }
70 sub add_items { goto &add_orderitems; }
71 sub record_number { goto &number; }
76 return 'sales_order' if $self->customer_id && ! $self->quotation;
77 return 'purchase_order' if $self->vendor_id && ! $self->quotation;
78 return 'sales_quotation' if $self->customer_id && $self->quotation;
79 return 'request_quotation' if $self->vendor_id && $self->quotation;
85 return shift->type eq shift;
88 sub displayable_type {
89 my $type = shift->type;
91 return $::locale->text('Sales quotation') if $type eq 'sales_quotation';
92 return $::locale->text('Request quotation') if $type eq 'request_quotation';
93 return $::locale->text('Sales Order') if $type eq 'sales_order';
94 return $::locale->text('Purchase Order') if $type eq 'purchase_order';
99 sub displayable_name {
100 join ' ', grep $_, map $_[0]->$_, qw(displayable_type record_number);
104 croak 'not an accessor' if @_ > 1;
105 return !!shift->customer_id;
112 if ($self->quotation) {
115 require SL::DB::Invoice;
116 return SL::DB::Manager::Invoice->get_all(
118 ordnumber => $self->ordnumber,
119 @{ $params{query} || [] },
125 sub displayable_state {
128 return $self->closed ? $::locale->text('closed') : $::locale->text('open');
131 sub abschlag_invoices {
132 return shift()->invoices(query => [ abschlag => 1 ]);
136 return shift()->invoices(query => [ abschlag => 0 ]);
139 sub convert_to_invoice {
140 my ($self, %params) = @_;
142 croak("Conversion to invoices is only supported for sales records") unless $self->customer_id;
145 if (!$self->db->with_transaction(sub {
146 require SL::DB::Invoice;
147 $invoice = SL::DB::Invoice->new_from($self)->post(%params) || die;
148 $self->link_to_record($invoice);
149 $self->update_attributes(closed => 1);
158 sub convert_to_delivery_order {
159 my ($self, @args) = @_;
162 if (!$self->db->with_transaction(sub {
163 require SL::DB::DeliveryOrder;
164 $delivery_order = SL::DB::DeliveryOrder->new_from($self, @args);
165 $delivery_order->save;
166 $self->link_to_record($delivery_order);
167 # TODO extend link_to_record for items, otherwise long-term no d.r.y.
168 foreach my $item (@{ $delivery_order->items }) {
169 foreach (qw(orderitems)) { # expand if needed (delivery_order_items)
170 if ($item->{"converted_from_${_}_id"}) {
171 die unless $item->{id};
172 RecordLinks->create_links('dbh' => $self->db->dbh,
175 'from_ids' => $item->{"converted_from_${_}_id"},
176 'to_table' => 'delivery_order_items',
177 'to_id' => $item->{id},
179 delete $item->{"converted_from_${_}_id"};
184 $self->update_attributes(delivered => 1);
190 return $delivery_order;
193 sub _clone_orderitem_cvar {
196 my $cloned = $_->clone_and_reset;
197 $cloned->sub_module('orderitems');
203 my ($class, $source, %params) = @_;
205 croak("Unsupported source object type '" . ref($source) . "'") unless ref($source) eq 'SL::DB::Order';
206 croak("A destination type must be given as parameter") unless $params{destination_type};
208 my $destination_type = delete $params{destination_type};
211 { from => 'sales_quotation', to => 'sales_order', abbr => 'sqso' },
212 { from => 'request_quotation', to => 'purchase_order', abbr => 'rqpo' },
213 { from => 'sales_quotation', to => 'sales_quotation', abbr => 'sqsq' },
214 { from => 'sales_order', to => 'sales_order', abbr => 'soso' },
215 { from => 'request_quotation', to => 'request_quotation', abbr => 'rqrq' },
216 { from => 'purchase_order', to => 'purchase_order', abbr => 'popo' },
218 my $from_to = (grep { $_->{from} eq $source->type && $_->{to} eq $destination_type} @from_tos)[0];
219 croak("Cannot convert from '" . $source->type . "' to '" . $destination_type . "'") if !$from_to;
221 my ($item_parent_id_column, $item_parent_column);
223 if (ref($source) eq 'SL::DB::Order') {
224 $item_parent_id_column = 'trans_id';
225 $item_parent_column = 'order';
228 my %args = ( map({ ( $_ => $source->$_ ) } qw(amount cp_id currency_id cusordnumber customer_id delivery_customer_id delivery_term_id delivery_vendor_id
229 department_id employee_id globalproject_id intnotes marge_percent marge_total language_id netamount notes
230 ordnumber payment_id quonumber reqdate salesman_id shippingpoint shipvia taxincluded taxzone_id
231 transaction_description vendor_id
233 quotation => !!($destination_type =~ m{quotation$}),
236 transdate => DateTime->today_local,
239 # Custom shipto addresses (the ones specific to the sales/purchase
240 # record and not to the customer/vendor) are only linked from
241 # shipto → order. Meaning order.shipto_id
242 # will not be filled in that case.
243 if (!$source->shipto_id && $source->id) {
244 $args{custom_shipto} = $source->custom_shipto->clone($class) if $source->can('custom_shipto') && $source->custom_shipto;
247 $args{shipto_id} = $source->shipto_id;
250 my $order = $class->new(%args);
251 $order->assign_attributes(%{ $params{attributes} }) if $params{attributes};
252 my $items = delete($params{items}) || $source->items_sorted;
256 my $source_item = $_;
257 my $source_item_id = $_->$item_parent_id_column;
258 my @custom_variables = map { _clone_orderitem_cvar($_) } @{ $source_item->custom_variables };
260 $item_parents{$source_item_id} ||= $source_item->$item_parent_column;
261 my $item_parent = $item_parents{$source_item_id};
263 my $current_oe_item = SL::DB::OrderItem->new(map({ ( $_ => $source_item->$_ ) }
264 qw(active_discount_source active_price_source base_qty cusordnumber
265 description discount lastcost longdescription
266 marge_percent marge_price_factor marge_total
267 ordnumber parts_id price_factor price_factor_id pricegroup_id
268 project_id qty reqdate sellprice serialnumber ship subtotal transdate unit
270 custom_variables => \@custom_variables,
272 $current_oe_item->{"converted_from_orderitems_id"} = $_->{id} if ref($item_parent) eq 'SL::DB::Order';
276 @items = grep { $params{item_filter}->($_) } @items if $params{item_filter};
277 @items = grep { $_->qty * 1 } @items if $params{skip_items_zero_qty};
278 @items = grep { $_->qty >=0 } @items if $params{skip_items_negative_qty};
280 $order->items(\@items);
288 return if !$self->type;
290 my %number_method = (
291 sales_order => 'ordnumber',
292 sales_quotation => 'quonumber',
293 purchase_order => 'ordnumber',
294 request_quotation => 'quonumber',
297 return $self->${ \ $number_method{$self->type} }(@_);
301 $_[0]->is_sales ? $_[0]->customer : $_[0]->vendor;
311 sprintf "%s %s %s (%s)",
313 $self->customervendor->name,
314 $self->amount_as_number,
315 $self->date->to_kivitendo;
328 SL::DB::Order - Order Datenbank Objekt.
334 Returns one of the following string types:
342 =item sales_quotation
344 =item request_quotation
348 =head2 C<is_type TYPE>
350 Returns true if the order is of the given type.
352 =head2 C<convert_to_delivery_order %params>
354 Creates a new delivery order with C<$self> as the basis by calling
355 L<SL::DB::DeliveryOrder::new_from>. That delivery order is saved, and
356 C<$self> is linked to the new invoice via
357 L<SL::DB::RecordLink>. C<$self>'s C<delivered> attribute is set to
358 C<true>, and C<$self> is saved.
360 The arguments in C<%params> are passed to
361 L<SL::DB::DeliveryOrder::new_from>.
363 Returns C<undef> on failure. Otherwise the new delivery order will be
366 =head2 C<convert_to_invoice %params>
368 Creates a new invoice with C<$self> as the basis by calling
369 L<SL::DB::Invoice::new_from>. That invoice is posted, and C<$self> is
370 linked to the new invoice via L<SL::DB::RecordLink>. C<$self>'s
371 C<closed> attribute is set to C<true>, and C<$self> is saved.
373 The arguments in C<%params> are passed to L<SL::DB::Invoice::post>.
375 Returns the new invoice instance on success and C<undef> on
376 failure. The whole process is run inside a transaction. On failure
377 nothing is created or changed in the database.
379 At the moment only sales quotations and sales orders can be converted.
381 =head2 C<new_from $source, %params>
383 Creates a new C<SL::DB::Order> instance and copies as much
384 information from C<$source> as possible. At the moment only records with the
385 same destination type as the source type and sales orders from
386 sales quotations and purchase orders from requests for quotations can be
389 The C<transdate> field will be set to the current date.
391 The conversion copies the order items as well.
393 Returns the new order instance. The object returned is not
396 C<%params> can include the following options
397 (C<destination_type> is mandatory):
401 =item C<destination_type>
404 The type of the newly created object. Can be C<sales_quotation>,
405 C<sales_order>, C<purchase_quotation> or C<purchase_order> for now.
409 An optional array reference of RDBO instances for the items to use. If
410 missing then the method C<items_sorted> will be called on
411 C<$source>. This option can be used to override the sorting, to
412 exclude certain positions or to add additional ones.
414 =item C<skip_items_negative_qty>
416 If trueish then items with a negative quantity are skipped. Items with
417 a quantity of 0 are not affected by this option.
419 =item C<skip_items_zero_qty>
421 If trueish then items with a quantity of 0 are skipped.
425 An optional code reference that is called for each item with the item
426 as its sole parameter. Items for which the code reference returns a
427 falsish value will be skipped.
431 An optional hash reference. If it exists then it is passed to C<new>
432 allowing the caller to set certain attributes for the new delivery
437 =head2 C<create_sales_process>
439 Creates and saves a new sales process. Can only be called for sales
442 The newly created process will be linked bidirectionally to both
443 C<$self> and to all sales quotations that are linked to C<$self>.
445 Returns the newly created process instance.
453 Sven Schöling <s.schoeling@linet-services.de>