1 package SL::Dev::Record;
5 our @EXPORT_OK = qw(create_invoice_item create_sales_invoice create_credit_note create_order_item create_sales_order create_purchase_order create_delivery_order_item create_sales_delivery_order create_purchase_delivery_order create_project create_department);
6 our %EXPORT_TAGS = (ALL => \@EXPORT_OK);
9 use SL::DB::InvoiceItem;
11 use SL::Dev::Part qw(new_part);
12 use SL::Dev::CustomerVendor qw(new_vendor new_customer);
14 use SL::DB::ProjectStatus;
15 use SL::DB::ProjectType;
18 my %record_type_to_item_type = ( sales_invoice => 'SL::DB::InvoiceItem',
19 credit_note => 'SL::DB::InvoiceItem',
20 sales_order => 'SL::DB::OrderItem',
21 purchase_order => 'SL::DB::OrderItem',
22 sales_delivery_order => 'SL::DB::DeliveryOrderItem',
25 sub create_sales_invoice {
28 my $record_type = 'sales_invoice';
29 my $invoiceitems = delete $params{invoiceitems} // _create_two_items($record_type);
30 _check_items($invoiceitems, $record_type);
32 my $customer = delete $params{customer} // new_customer(name => 'Testcustomer')->save;
33 die "illegal customer" unless defined $customer && ref($customer) eq 'SL::DB::Customer';
35 my $invoice = SL::DB::Invoice->new(
38 customer_id => $customer->id,
39 taxzone_id => $customer->taxzone->id,
40 invnumber => delete $params{invnumber} // undef,
41 currency_id => $params{currency_id} // $::instance_conf->get_currency_id,
42 taxincluded => $params{taxincluded} // 0,
43 employee_id => $params{employee_id} // SL::DB::Manager::Employee->current->id,
44 salesman_id => $params{employee_id} // SL::DB::Manager::Employee->current->id,
45 transdate => $params{transdate} // DateTime->today_local->to_kivitendo,
46 payment_id => $params{payment_id} // undef,
47 gldate => DateTime->today,
48 invoiceitems => $invoiceitems,
50 $invoice->assign_attributes(%params) if %params;
56 sub create_credit_note {
59 my $record_type = 'credit_note';
60 my $invoiceitems = delete $params{invoiceitems} // _create_two_items($record_type);
61 _check_items($invoiceitems, $record_type);
63 my $customer = delete $params{customer} // new_customer(name => 'Testcustomer')->save;
64 die "illegal customer" unless defined $customer && ref($customer) eq 'SL::DB::Customer';
66 # adjust qty for credit note items
67 $_->qty( $_->qty * -1) foreach @{$invoiceitems};
69 my $invoice = SL::DB::Invoice->new(
71 type => 'credit_note',
72 customer_id => $customer->id,
73 taxzone_id => $customer->taxzone->id,
74 invnumber => delete $params{invnumber} // undef,
75 currency_id => $params{currency_id} // $::instance_conf->get_currency_id,
76 taxincluded => $params{taxincluded} // 0,
77 employee_id => $params{employee_id} // SL::DB::Manager::Employee->current->id,
78 salesman_id => $params{employee_id} // SL::DB::Manager::Employee->current->id,
79 transdate => $params{transdate} // DateTime->today_local->to_kivitendo,
80 payment_id => $params{payment_id} // undef,
81 gldate => DateTime->today,
82 invoiceitems => $invoiceitems,
84 $invoice->assign_attributes(%params) if %params;
90 sub create_sales_delivery_order {
93 my $record_type = 'sales_delivery_order';
94 my $orderitems = delete $params{orderitems} // _create_two_items($record_type);
95 _check_items($orderitems, $record_type);
97 my $customer = $params{customer} // new_customer(name => 'Testcustomer')->save;
98 die "illegal customer" unless ref($customer) eq 'SL::DB::Customer';
100 my $delivery_order = SL::DB::DeliveryOrder->new(
101 'is_sales' => 'true',
103 customer_id => $customer->id,
104 taxzone_id => $customer->taxzone_id,
105 donumber => $params{donumber} // undef,
106 currency_id => $params{currency_id} // $::instance_conf->get_currency_id,
107 taxincluded => $params{taxincluded} // 0,
108 employee_id => $params{employee_id} // SL::DB::Manager::Employee->current->id,
109 salesman_id => $params{employee_id} // SL::DB::Manager::Employee->current->id,
110 transdate => $params{transdate} // DateTime->today,
111 orderitems => $orderitems,
113 $delivery_order->assign_attributes(%params) if %params;
114 $delivery_order->save;
115 return $delivery_order;
118 sub create_purchase_delivery_order {
121 my $record_type = 'purchase_delivery_order';
122 my $orderitems = delete $params{orderitems} // _create_two_items($record_type);
123 _check_items($orderitems, $record_type);
125 my $vendor = $params{vendor} // new_vendor(name => 'Testvendor')->save;
126 die "illegal customer" unless ref($vendor) eq 'SL::DB::Vendor';
128 my $delivery_order = SL::DB::DeliveryOrder->new(
129 'is_sales' => 'false',
131 vendor_id => $vendor->id,
132 taxzone_id => $vendor->taxzone_id,
133 donumber => $params{donumber} // undef,
134 currency_id => $params{currency_id} // $::instance_conf->get_currency_id,
135 taxincluded => $params{taxincluded} // 0,
136 employee_id => $params{employee_id} // SL::DB::Manager::Employee->current->id,
137 salesman_id => $params{employee_id} // SL::DB::Manager::Employee->current->id,
138 transdate => $params{transdate} // DateTime->today,
139 orderitems => $orderitems,
141 $delivery_order->assign_attributes(%params) if %params;
142 $delivery_order->save;
143 return $delivery_order;
146 sub create_sales_order {
149 my $record_type = 'sales_order';
150 my $orderitems = delete $params{orderitems} // _create_two_items($record_type);
151 _check_items($orderitems, $record_type);
153 my $save = delete $params{save} // 0;
155 my $customer = $params{customer} // new_customer(name => 'Testcustomer')->save;
156 die "illegal customer" unless ref($customer) eq 'SL::DB::Customer';
158 my $order = SL::DB::Order->new(
159 customer_id => delete $params{customer_id} // $customer->id,
160 taxzone_id => delete $params{taxzone_id} // $customer->taxzone->id,
161 currency_id => delete $params{currency_id} // $::instance_conf->get_currency_id,
162 taxincluded => delete $params{taxincluded} // 0,
163 employee_id => delete $params{employee_id} // SL::DB::Manager::Employee->current->id,
164 salesman_id => delete $params{employee_id} // SL::DB::Manager::Employee->current->id,
165 transdate => delete $params{transdate} // DateTime->today,
166 orderitems => $orderitems,
168 $order->assign_attributes(%params) if %params;
171 $order->calculate_prices_and_taxes;
177 sub create_purchase_order {
180 my $record_type = 'purchase_order';
181 my $orderitems = delete $params{orderitems} // _create_two_items($record_type);
182 _check_items($orderitems, $record_type);
184 my $save = delete $params{save} // 0;
186 my $vendor = $params{vendor} // new_vendor(name => 'Testvendor')->save;
187 die "illegal vendor" unless ref($vendor) eq 'SL::DB::Vendor';
189 my $order = SL::DB::Order->new(
190 vendor_id => delete $params{vendor_id} // $vendor->id,
191 taxzone_id => delete $params{taxzone_id} // $vendor->taxzone->id,
192 currency_id => delete $params{currency_id} // $::instance_conf->get_currency_id,
193 taxincluded => delete $params{taxincluded} // 0,
194 transdate => delete $params{transdate} // DateTime->today,
196 orderitems => $orderitems,
198 $order->assign_attributes(%params) if %params;
201 $order->calculate_prices_and_taxes; # not tested for purchase orders
208 my ($items, $record_type) = @_;
210 if ( scalar @{$items} == 0 or grep { ref($_) ne $record_type_to_item_type{"$record_type"} } @{$items} ) {
211 die "Error: items must be an arrayref of " . $record_type_to_item_type{"$record_type"} . "objects.";
215 sub create_invoice_item {
218 return _create_item(record_type => 'sales_invoice', %params);
221 sub create_order_item {
224 return _create_item(record_type => 'sales_order', %params);
227 sub create_delivery_order_item {
230 return _create_item(record_type => 'sales_delivery_order', %params);
236 my $record_type = delete($params{record_type});
237 my $part = delete($params{part});
239 die "illegal record type: $record_type, must be one of: " . join(' ', keys %record_type_to_item_type) unless $record_type_to_item_type{ $record_type };
240 die "part missing as param" unless $part && ref($part) eq 'SL::DB::Part';
242 my ($sellprice, $lastcost);
244 if ( $record_type =~ /^sales/ ) {
245 $sellprice = delete $params{sellprice} // $part->sellprice;
246 $lastcost = delete $params{lastcost} // $part->lastcost;
248 $sellprice = delete $params{sellprice} // $part->lastcost;
249 $lastcost = delete $params{lastcost} // 0; # $part->lastcost;
252 my $item = "$record_type_to_item_type{$record_type}"->new(
253 parts_id => $part->id,
254 sellprice => $sellprice,
255 lastcost => $lastcost,
256 description => $part->description,
258 qty => $params{qty} || 5,
260 $item->assign_attributes(%params) if %params;
264 sub _create_two_items {
265 my ($record_type) = @_;
267 my $part1 = new_part(description => 'Testpart 1',
270 my $part2 = new_part(description => 'Testpart 2',
273 my $item1 = _create_item(record_type => $record_type, part => $part1, qty => 5);
274 my $item2 = _create_item(record_type => $record_type, part => $part2, qty => 8);
275 return [ $item1, $item2 ];
280 my $project = SL::DB::Project->new(
281 projectnumber => delete $params{projectnumber} // 1,
282 description => delete $params{description} // "Test project",
285 project_status_id => SL::DB::Manager::ProjectStatus->find_by(name => "running")->id,
286 project_type_id => SL::DB::Manager::ProjectType->find_by(description => "Standard")->id,
288 $project->assign_attributes(%params) if %params;
292 sub create_department {
295 my $department = SL::DB::Department->new(
296 'description' => delete $params{description} // 'Test Department',
299 $department->assign_attributes(%params) if %params;
309 SL::Dev::Record - create record objects for testing, with minimal defaults
313 =head2 C<create_sales_invoice %PARAMS>
315 Creates a new sales invoice (table ar, invoice = 1).
317 If neither customer nor invoiceitems are passed as params a customer and two
318 parts are created and used for building the invoice.
320 Minimal usage example:
322 my $invoice = SL::Dev::Record::create_sales_invoice();
326 my $invoice2 = SL::Dev::Record::create_sales_invoice(
328 transdate => DateTime->today->subtract(days => 7),
332 =head2 C<create_credit_note %PARAMS>
334 Create a credit note (sales). Use positive quantities when adding items.
336 Example including creation of parts and of credit_note:
338 my $part1 = SL::Dev::Part::new_part( partnumber => 'T4254')->save;
339 my $part2 = SL::Dev::Part::new_service(partnumber => 'Serv1')->save;
340 my $credit_note = SL::Dev::Record::create_credit_note(
343 invoiceitems => [ SL::Dev::Record::create_invoice_item(part => $part1, qty => 3, sellprice => 70),
344 SL::Dev::Record::create_invoice_item(part => $part2, qty => 10, sellprice => 50),
348 =head2 C<create_sales_order %PARAMS>
352 Create a sales order and save it directly via rose, without running
353 calculate_prices_and_taxes:
355 my $order = SL::Dev::Record::create_sales_order()->save;
357 Let create_sales_order run calculate_prices_and_taxes and save:
359 my $order = SL::Dev::Record::create_sales_order(save => 1);
362 Example including creation of part and of sales order:
364 my $part1 = SL::Dev::Part::new_part( partnumber => 'T4254')->save;
365 my $part2 = SL::Dev::Part::new_service(partnumber => 'Serv1')->save;
366 my $order = SL::Dev::Record::create_sales_order(
369 orderitems => [ SL::Dev::Record::create_order_item(part => $part1, qty => 3, sellprice => 70),
370 SL::Dev::Record::create_order_item(part => $part2, qty => 10, sellprice => 50),
374 Example: create 100 orders with the same part for 100 new customers:
376 my $part1 = SL::Dev::Part::new_part(partnumber => 'T6256')->save;
377 SL::Dev::Record::create_sales_order(
380 orderitems => [ SL::Dev::Record::create_order_item(part => $part1, qty => 1, sellprice => 9) ]
383 =head2 C<create_purchase_order %PARAMS>
385 See comments for C<create_sales_order>.
389 my $purchase_order = SL::Dev::Record::create_purchase_order(save => 1);
392 =head2 C<create_item %PARAMS>
394 Creates an item from a part object that can be added to a record.
398 record_type (sales_invoice, sales_order, sales_delivery_order)
399 part (an SL::DB::Part object)
401 Example including creation of part and of invoice:
403 my $part = SL::Dev::Part::new_part( partnumber => 'T4254')->save;
404 my $item = SL::Dev::Record::create_invoice_item(part => $part, qty => 2.5);
405 my $invoice = SL::Dev::Record::create_sales_invoice(
407 invoiceitems => [ $item ],
410 =head2 C<create_project %PARAMS>
412 Creates a default project.
414 Minimal example, creating a project with status "running" and type "Standard":
416 my $project = SL::Dev::Record::create_project();
418 $project = SL::Dev::Record::create_project(
419 projectnumber => 'p1',
420 description => 'Test project',
423 If C<$params{description}> or C<$params{projectnumber}> exists, this will override the
424 default value 'Test project'.
426 C<%params> should only contain alterable keys from the object Project.
428 =head2 C<create_department %PARAMS>
430 Creates a default department.
434 my $department = SL::Dev::Record::create_department();
436 my $department = SL::Dev::Record::create_department(
437 description => 'Hawaii',
440 If C<$params{description}> exists, this will override the
441 default value 'Test Department'.
443 C<%params> should only contain alterable keys from the object Department.
452 G. Richardson E<lt>grichardson@kivitendo-premium.deE<gt>