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::Attr;
14 use SL::DB::Helper::AttrHTML;
15 use SL::DB::Helper::AttrSorted;
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);
23 use Rose::DB::Object::Helpers qw(as_tree);
25 __PACKAGE__->meta->add_relationship(
27 type => 'one to many',
28 class => 'SL::DB::OrderItem',
29 column_map => { id => 'trans_id' },
31 with_objects => [ 'part' ]
34 periodic_invoices_config => {
36 class => 'SL::DB::PeriodicInvoicesConfig',
37 column_map => { id => 'oe_id' },
41 class => 'SL::DB::Shipto',
42 column_map => { id => 'trans_id' },
43 query_args => [ module => 'OE' ],
47 class => 'SL::DB::Exchangerate',
48 column_map => { currency_id => 'currency_id', transdate => 'transdate' },
52 SL::DB::Helper::Attr::make(__PACKAGE__, daily_exchangerate => 'numeric');
54 __PACKAGE__->meta->initialize;
56 __PACKAGE__->attr_html('notes');
57 __PACKAGE__->attr_sorted('items');
59 __PACKAGE__->before_save('_before_save_set_ord_quo_number');
60 __PACKAGE__->before_save('_before_save_create_new_project');
61 __PACKAGE__->before_save('_before_save_remove_empty_custom_shipto');
62 __PACKAGE__->before_save('_before_save_set_custom_shipto_module');
66 sub _before_save_set_ord_quo_number {
69 # ordnumber is 'NOT NULL'. Therefore make sure it's always set to at
70 # least an empty string, even if we're saving a quotation.
71 $self->ordnumber('') if !$self->ordnumber;
73 my $field = $self->quotation ? 'quonumber' : 'ordnumber';
74 $self->create_trans_number if !$self->$field;
78 sub _before_save_create_new_project {
81 # force new project, if not set yet
82 if ($::instance_conf->get_order_always_project && !$self->globalproject_id && ($self->type eq 'sales_order')) {
84 die t8("Error while creating project with project number of new order number, project number #1 already exists!", $self->ordnumber)
85 if SL::DB::Manager::Project->find_by(projectnumber => $self->ordnumber);
88 my $new_project = SL::DB::Project->new(
89 projectnumber => $self->ordnumber,
90 description => $self->customer->name,
91 customer_id => $self->customer->id,
93 project_type_id => $::instance_conf->get_project_type_id,
94 project_status_id => $::instance_conf->get_project_status_id,
97 $self->globalproject_id($new_project->id);
98 } or die t8('Could not create new project #1', $@);
104 sub _before_save_remove_empty_custom_shipto {
107 $self->custom_shipto(undef) if $self->custom_shipto && $self->custom_shipto->is_empty;
112 sub _before_save_set_custom_shipto_module {
115 $self->custom_shipto->module('OE') if $self->custom_shipto;
122 sub items { goto &orderitems; }
123 sub add_items { goto &add_orderitems; }
124 sub record_number { goto &number; }
129 return 'sales_order' if $self->customer_id && ! $self->quotation;
130 return 'purchase_order' if $self->vendor_id && ! $self->quotation;
131 return 'sales_quotation' if $self->customer_id && $self->quotation;
132 return 'request_quotation' if $self->vendor_id && $self->quotation;
138 return shift->type eq shift;
142 # oe doesn't have deliverydate, but it does have reqdate.
143 # But this has a different meaning for sales quotations.
144 # deliverydate can be used to determine tax if tax_point isn't set.
146 return $_[0]->reqdate if $_[0]->type ne 'sales_quotation';
149 sub effective_tax_point {
152 return $self->tax_point || $self->deliverydate || $self->transdate;
155 sub displayable_type {
156 my $type = shift->type;
158 return $::locale->text('Sales quotation') if $type eq 'sales_quotation';
159 return $::locale->text('Request quotation') if $type eq 'request_quotation';
160 return $::locale->text('Sales Order') if $type eq 'sales_order';
161 return $::locale->text('Purchase Order') if $type eq 'purchase_order';
166 sub displayable_name {
167 join ' ', grep $_, map $_[0]->$_, qw(displayable_type record_number);
171 croak 'not an accessor' if @_ > 1;
172 return !!shift->customer_id;
175 sub daily_exchangerate {
176 my ($self, $val) = @_;
178 return 1 if $self->currency_id == $::instance_conf->get_currency_id;
180 my $rate = (any { $self->is_type($_) } qw(sales_quotation sales_order)) ? 'buy'
181 : (any { $self->is_type($_) } qw(request_quotation purchase_order)) ? 'sell'
186 croak t8('exchange rate has to be positive') if $val <= 0;
187 if (!$self->exchangerate_obj) {
188 $self->exchangerate_obj(SL::DB::Exchangerate->new(
189 currency_id => $self->currency_id,
190 transdate => $self->transdate,
193 } elsif (!defined $self->exchangerate_obj->$rate) {
194 $self->exchangerate_obj->$rate($val);
196 croak t8('exchange rate already exists, no update allowed');
199 return $self->exchangerate_obj->$rate if $self->exchangerate_obj;
206 if ($self->quotation) {
209 require SL::DB::Invoice;
210 return SL::DB::Manager::Invoice->get_all(
212 ordnumber => $self->ordnumber,
213 @{ $params{query} || [] },
219 sub displayable_state {
222 return $self->closed ? $::locale->text('closed') : $::locale->text('open');
225 sub abschlag_invoices {
226 return shift()->invoices(query => [ abschlag => 1 ]);
230 return shift()->invoices(query => [ abschlag => 0 ]);
233 sub convert_to_invoice {
234 my ($self, %params) = @_;
236 croak("Conversion to invoices is only supported for sales records") unless $self->customer_id;
239 if (!$self->db->with_transaction(sub {
240 require SL::DB::Invoice;
241 $invoice = SL::DB::Invoice->new_from($self)->post(%params) || die;
242 $self->link_to_record($invoice);
243 $self->update_attributes(closed => 1);
252 sub convert_to_delivery_order {
253 my ($self, @args) = @_;
256 if (!$self->db->with_transaction(sub {
257 require SL::DB::DeliveryOrder;
258 $delivery_order = SL::DB::DeliveryOrder->new_from($self, @args);
259 $delivery_order->save;
260 $self->link_to_record($delivery_order);
261 # TODO extend link_to_record for items, otherwise long-term no d.r.y.
262 foreach my $item (@{ $delivery_order->items }) {
263 foreach (qw(orderitems)) { # expand if needed (delivery_order_items)
264 if ($item->{"converted_from_${_}_id"}) {
265 die unless $item->{id};
266 RecordLinks->create_links('dbh' => $self->db->dbh,
269 'from_ids' => $item->{"converted_from_${_}_id"},
270 'to_table' => 'delivery_order_items',
271 'to_id' => $item->{id},
273 delete $item->{"converted_from_${_}_id"};
278 $self->update_attributes(delivered => 1);
284 return $delivery_order;
287 sub _clone_orderitem_cvar {
290 my $cloned = $_->clone_and_reset;
291 $cloned->sub_module('orderitems');
297 my ($class, $source, %params) = @_;
299 croak("Unsupported source object type '" . ref($source) . "'") unless ref($source) eq 'SL::DB::Order';
300 croak("A destination type must be given as parameter") unless $params{destination_type};
302 my $destination_type = delete $params{destination_type};
305 { from => 'sales_quotation', to => 'sales_order', abbr => 'sqso' },
306 { from => 'request_quotation', to => 'purchase_order', abbr => 'rqpo' },
307 { from => 'sales_quotation', to => 'sales_quotation', abbr => 'sqsq' },
308 { from => 'sales_order', to => 'sales_order', abbr => 'soso' },
309 { from => 'request_quotation', to => 'request_quotation', abbr => 'rqrq' },
310 { from => 'purchase_order', to => 'purchase_order', abbr => 'popo' },
311 { from => 'sales_order', to => 'purchase_order', abbr => 'sopo' },
312 { from => 'purchase_order', to => 'sales_order', abbr => 'poso' },
314 my $from_to = (grep { $_->{from} eq $source->type && $_->{to} eq $destination_type} @from_tos)[0];
315 croak("Cannot convert from '" . $source->type . "' to '" . $destination_type . "'") if !$from_to;
317 my $is_abbr_any = sub {
318 any { $from_to->{abbr} eq $_ } @_;
321 my ($item_parent_id_column, $item_parent_column);
323 if (ref($source) eq 'SL::DB::Order') {
324 $item_parent_id_column = 'trans_id';
325 $item_parent_column = 'order';
328 my %args = ( map({ ( $_ => $source->$_ ) } qw(amount cp_id currency_id cusordnumber customer_id delivery_customer_id delivery_term_id delivery_vendor_id
329 department_id employee_id exchangerate globalproject_id intnotes marge_percent marge_total language_id netamount notes
330 ordnumber payment_id quonumber reqdate salesman_id shippingpoint shipvia taxincluded tax_point taxzone_id
331 transaction_description vendor_id
333 quotation => !!($destination_type =~ m{quotation$}),
336 transdate => DateTime->today_local,
339 if ( $is_abbr_any->(qw(sopo poso)) ) {
340 $args{ordnumber} = undef;
341 $args{quonumber} = undef;
342 $args{reqdate} = DateTime->today_local->next_workday();
343 $args{employee} = SL::DB::Manager::Employee->current;
345 if ( $is_abbr_any->(qw(sopo)) ) {
346 $args{customer_id} = undef;
347 $args{salesman_id} = undef;
348 $args{payment_id} = undef;
349 $args{delivery_term_id} = undef;
351 if ( $is_abbr_any->(qw(poso)) ) {
352 $args{vendor_id} = undef;
354 if ( $is_abbr_any->(qw(soso)) ) {
355 $args{periodic_invoices_config} = $source->periodic_invoices_config->clone_and_reset if $source->periodic_invoices_config;
358 # Custom shipto addresses (the ones specific to the sales/purchase
359 # record and not to the customer/vendor) are only linked from
360 # shipto → order. Meaning order.shipto_id
361 # will not be filled in that case.
362 if (!$source->shipto_id && $source->id) {
363 $args{custom_shipto} = $source->custom_shipto->clone($class) if $source->can('custom_shipto') && $source->custom_shipto;
366 $args{shipto_id} = $source->shipto_id;
369 my $order = $class->new(%args);
370 $order->assign_attributes(%{ $params{attributes} }) if $params{attributes};
371 my $items = delete($params{items}) || $source->items_sorted;
376 my $source_item = $_;
377 my $source_item_id = $_->$item_parent_id_column;
378 my @custom_variables = map { _clone_orderitem_cvar($_) } @{ $source_item->custom_variables };
380 $item_parents{$source_item_id} ||= $source_item->$item_parent_column;
381 my $item_parent = $item_parents{$source_item_id};
383 my $current_oe_item = SL::DB::OrderItem->new(map({ ( $_ => $source_item->$_ ) }
384 qw(active_discount_source active_price_source base_qty cusordnumber
385 description discount lastcost longdescription
386 marge_percent marge_price_factor marge_total
387 ordnumber parts_id price_factor price_factor_id pricegroup_id
388 project_id qty reqdate sellprice serialnumber ship subtotal transdate unit
390 custom_variables => \@custom_variables,
392 if ( $is_abbr_any->(qw(sopo)) ) {
393 $current_oe_item->sellprice($source_item->lastcost);
394 $current_oe_item->discount(0);
396 if ( $is_abbr_any->(qw(poso)) ) {
397 $current_oe_item->lastcost($source_item->sellprice);
399 $current_oe_item->{"converted_from_orderitems_id"} = $_->{id} if ref($item_parent) eq 'SL::DB::Order';
403 @items = grep { $params{item_filter}->($_) } @items if $params{item_filter};
404 @items = grep { $_->qty * 1 } @items if $params{skip_items_zero_qty};
405 @items = grep { $_->qty >=0 } @items if $params{skip_items_negative_qty};
407 $order->items(\@items);
413 my ($class, $sources, %params) = @_;
415 croak("Unsupported object type in sources") if any { ref($_) !~ m{SL::DB::Order} } @$sources;
416 croak("Cannot create order for purchase records") if any { !$_->is_sales } @$sources;
417 croak("Cannot create order from source records of different customers") if any { $_->customer_id != $sources->[0]->customer_id } @$sources;
419 # bb: todo: check shipto: is it enough to check the ids or do we have to compare the entries?
420 if (delete $params{check_same_shipto}) {
421 die "check same shipto address is not implemented yet";
422 die "Source records do not have the same shipto" if 1;
426 if (defined $params{sort_sources_by}) {
427 my $sort_by = delete $params{sort_sources_by};
428 if ($sources->[0]->can($sort_by)) {
429 $sources = [ sort { $a->$sort_by cmp $b->$sort_by } @$sources ];
431 die "Cannot sort source records by $sort_by";
435 # set this entries to undef that yield different information
437 foreach my $attr (qw(ordnumber transdate reqdate tax_point taxincluded shippingpoint
438 shipvia notes closed delivered reqdate quonumber
439 cusordnumber proforma transaction_description
440 order_probability expected_billing_date)) {
441 $attributes{$attr} = undef if any { ($sources->[0]->$attr//'') ne ($_->$attr//'') } @$sources;
443 foreach my $attr (qw(cp_id currency_id employee_id salesman_id department_id
444 delivery_customer_id delivery_vendor_id shipto_id
445 globalproject_id exchangerate)) {
446 $attributes{$attr} = undef if any { ($sources->[0]->$attr||0) != ($_->$attr||0) } @$sources;
449 # set this entries from customer that yield different information
450 foreach my $attr (qw(language_id taxzone_id payment_id delivery_term_id)) {
451 $attributes{$attr} = $sources->[0]->customervendor->$attr if any { ($sources->[0]->$attr||0) != ($_->$attr||0) } @$sources;
453 $attributes{intnotes} = $sources->[0]->customervendor->notes if any { ($sources->[0]->intnotes//'') ne ($_->intnotes//'') } @$sources;
455 # no periodic invoice config for new order
456 $attributes{periodic_invoices_config} = undef;
458 # copy global ordnumber, transdate, cusordnumber into item scope
459 # unless already present there
460 foreach my $attr (qw(ordnumber transdate cusordnumber)) {
461 foreach my $src (@$sources) {
462 foreach my $item (@{ $src->items_sorted }) {
463 $item->$attr($src->$attr) if !$item->$attr;
470 push @items, @{$_->items_sorted} for @$sources;
471 # make order from first source and all items
472 my $order = $class->new_from($sources->[0],
473 destination_type => 'sales_order',
474 attributes => \%attributes,
484 return if !$self->type;
486 my %number_method = (
487 sales_order => 'ordnumber',
488 sales_quotation => 'quonumber',
489 purchase_order => 'ordnumber',
490 request_quotation => 'quonumber',
493 return $self->${ \ $number_method{$self->type} }(@_);
497 $_[0]->is_sales ? $_[0]->customer : $_[0]->vendor;
507 sprintf "%s %s %s (%s)",
509 $self->customervendor->name,
510 $self->amount_as_number,
511 $self->date->to_kivitendo;
524 SL::DB::Order - Order Datenbank Objekt.
530 Returns one of the following string types:
538 =item sales_quotation
540 =item request_quotation
544 =head2 C<is_type TYPE>
546 Returns true if the order is of the given type.
548 =head2 C<daily_exchangerate $val>
550 Gets or sets the exchangerate object's value. This is the value from the
551 table C<exchangerate> depending on the order's currency, the transdate and
552 if it is a sales or purchase order.
554 The order object (respectively the table C<oe>) has an own column
555 C<exchangerate> which can be get or set with the accessor C<exchangerate>.
557 The idea is to drop the legacy table C<exchangerate> in the future and to
558 give all relevant tables it's own C<exchangerate> column.
560 So, this method is here if you need to access the "legacy" exchangerate via
567 (optional) If given, the exchangerate in the "legacy" table is set to this
568 value, depending on currency, transdate and sales or purchase.
572 =head2 C<convert_to_delivery_order %params>
574 Creates a new delivery order with C<$self> as the basis by calling
575 L<SL::DB::DeliveryOrder::new_from>. That delivery order is saved, and
576 C<$self> is linked to the new invoice via
577 L<SL::DB::RecordLink>. C<$self>'s C<delivered> attribute is set to
578 C<true>, and C<$self> is saved.
580 The arguments in C<%params> are passed to
581 L<SL::DB::DeliveryOrder::new_from>.
583 Returns C<undef> on failure. Otherwise the new delivery order will be
586 =head2 C<convert_to_invoice %params>
588 Creates a new invoice with C<$self> as the basis by calling
589 L<SL::DB::Invoice::new_from>. That invoice is posted, and C<$self> is
590 linked to the new invoice via L<SL::DB::RecordLink>. C<$self>'s
591 C<closed> attribute is set to C<true>, and C<$self> is saved.
593 The arguments in C<%params> are passed to L<SL::DB::Invoice::post>.
595 Returns the new invoice instance on success and C<undef> on
596 failure. The whole process is run inside a transaction. On failure
597 nothing is created or changed in the database.
599 At the moment only sales quotations and sales orders can be converted.
601 =head2 C<new_from $source, %params>
603 Creates a new C<SL::DB::Order> instance and copies as much
604 information from C<$source> as possible. At the moment only records with the
605 same destination type as the source type and sales orders from
606 sales quotations and purchase orders from requests for quotations can be
609 The C<transdate> field will be set to the current date.
611 The conversion copies the order items as well.
613 Returns the new order instance. The object returned is not
616 C<%params> can include the following options
617 (C<destination_type> is mandatory):
621 =item C<destination_type>
624 The type of the newly created object. Can be C<sales_quotation>,
625 C<sales_order>, C<purchase_quotation> or C<purchase_order> for now.
629 An optional array reference of RDBO instances for the items to use. If
630 missing then the method C<items_sorted> will be called on
631 C<$source>. This option can be used to override the sorting, to
632 exclude certain positions or to add additional ones.
634 =item C<skip_items_negative_qty>
636 If trueish then items with a negative quantity are skipped. Items with
637 a quantity of 0 are not affected by this option.
639 =item C<skip_items_zero_qty>
641 If trueish then items with a quantity of 0 are skipped.
645 An optional code reference that is called for each item with the item
646 as its sole parameter. Items for which the code reference returns a
647 falsish value will be skipped.
651 An optional hash reference. If it exists then it is passed to C<new>
652 allowing the caller to set certain attributes for the new delivery
657 =head2 C<new_from_multi $sources, %params>
659 Creates a new C<SL::DB::Order> instance from multiple sources and copies as
660 much information from C<$sources> as possible.
661 At the moment only sales orders can be combined and they must be of the same
664 The new order is created from the first one using C<new_from> and the positions
665 of all orders are added to the new order. The orders can be sorted with the
666 parameter C<sort_sources_by>.
668 The orders attributes are kept if they contain the same information for all
669 source orders an will be set to empty if they contain different information.
671 Returns the new order instance. The object returned is not
674 C<params> other then C<sort_sources_by> are passed to C<new_from>.
682 Sven Schöling <s.schoeling@linet-services.de>