Kommentar zur Namensgebung der PDF-Dateien
[kivitendo-erp.git] / SL / DB / Order.pm
1 package SL::DB::Order;
2
3 use utf8;
4 use strict;
5
6 use Carp;
7 use DateTime;
8 use List::Util qw(max);
9
10 use SL::DB::MetaSetup::Order;
11 use SL::DB::Manager::Order;
12 use SL::DB::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::RecordLinks;
19
20 __PACKAGE__->meta->add_relationship(
21   orderitems => {
22     type         => 'one to many',
23     class        => 'SL::DB::OrderItem',
24     column_map   => { id => 'trans_id' },
25     manager_args => {
26       with_objects => [ 'part' ]
27     }
28   },
29   periodic_invoices_config => {
30     type                   => 'one to one',
31     class                  => 'SL::DB::PeriodicInvoicesConfig',
32     column_map             => { id => 'oe_id' },
33   },
34   periodic_invoices        => {
35     type                   => 'one to many',
36     class                  => 'SL::DB::PeriodicInvoice',
37     column_map             => { id => 'oe_id' },
38   },
39   payment_term => {
40     type       => 'one to one',
41     class      => 'SL::DB::PaymentTerm',
42     column_map => { payment_id => 'id' },
43   },
44   contact      => {
45     type       => 'one to one',
46     class      => 'SL::DB::Contact',
47     column_map => { cp_id => 'cp_id' },
48   },
49   shipto       => {
50     type       => 'one to one',
51     class      => 'SL::DB::Shipto',
52     column_map => { shipto_id => 'shipto_id' },
53   },
54   department   => {
55     type       => 'one to one',
56     class      => 'SL::DB::Department',
57     column_map => { department_id => 'id' },
58   },
59   language     => {
60     type       => 'one to one',
61     class      => 'SL::DB::Language',
62     column_map => { language_id => 'id' },
63   },
64 );
65
66 __PACKAGE__->meta->initialize;
67
68 # methods
69
70 sub items { goto &orderitems; }
71
72 sub type {
73   my $self = shift;
74
75   return 'sales_order'       if $self->customer_id && ! $self->quotation;
76   return 'purchase_order'    if $self->vendor_id   && ! $self->quotation;
77   return 'sales_quotation'   if $self->customer_id &&   $self->quotation;
78   return 'request_quotation' if $self->vendor_id   &&   $self->quotation;
79
80   return;
81 }
82
83 sub is_type {
84   return shift->type eq shift;
85 }
86
87 sub invoices {
88   my $self   = shift;
89   my %params = @_;
90
91   if ($self->quotation) {
92     return [];
93   } else {
94     return SL::DB::Manager::Invoice->get_all(
95       query => [
96         ordnumber => $self->ordnumber,
97         @{ $params{query} || [] },
98       ]
99     );
100   }
101 }
102
103 sub abschlag_invoices {
104   return shift()->invoices(query => [ abschlag => 1 ]);
105 }
106
107 sub end_invoice {
108   return shift()->invoices(query => [ abschlag => 0 ]);
109 }
110
111 sub convert_to_invoice {
112   my ($self, %params) = @_;
113
114   croak("Conversion to invoices is only supported for sales records") unless $self->customer_id;
115
116   my $invoice;
117   if (!$self->db->do_transaction(sub {
118     $invoice = SL::DB::Invoice->new_from($self)->post(%params) || die;
119     $self->link_to_record($invoice);
120     $self->update_attributes(closed => 1);
121     # die;
122   })) {
123     return undef;
124   }
125
126   return $invoice;
127 }
128
129 1;
130
131 __END__
132
133 =head1 NAME
134
135 SL::DB::Order - Order Datenbank Objekt.
136
137 =head1 FUNCTIONS
138
139 =head2 C<type>
140
141 Returns one of the following string types:
142
143 =over 4
144
145 =item sales_order
146
147 =item purchase_order
148
149 =item sales_quotation
150
151 =item request_quotation
152
153 =back
154
155 =head2 C<is_type TYPE>
156
157 Returns true if the order is of the given type.
158
159 =head2 C<convert_to_invoice %params>
160
161 Creates a new invoice with C<$self> as the basis by calling
162 L<SL::DB::Invoice::new_from>. That invoice is posted, and C<$self> is
163 linked to the new invoice via L<SL::DB::RecordLink>. C<$self>'s
164 C<closed> attribute is set to C<true>, and C<$self> is saved.
165
166 The arguments in C<%params> are passed to L<SL::DB::Invoice::post>.
167
168 Returns the new invoice instance on success and C<undef> on
169 failure. The whole process is run inside a transaction. On failure
170 nothing is created or changed in the database.
171
172 At the moment only sales quotations and sales orders can be converted.
173
174 =head2 C<create_sales_process>
175
176 Creates and saves a new sales process. Can only be called for sales
177 orders.
178
179 The newly created process will be linked bidirectionally to both
180 C<$self> and to all sales quotations that are linked to C<$self>.
181
182 Returns the newly created process instance.
183
184 =head1 BUGS
185
186 Nothing here yet.
187
188 =head1 AUTHOR
189
190 Sven Schöling <s.schoeling@linet-services.de>
191
192 =cut