1 package SL::Dev::Record;
5 our @EXPORT = qw(create_invoice_item create_sales_invoice create_order_item create_sales_order create_purchase_order create_delivery_order_item create_sales_delivery_order);
8 use SL::DB::InvoiceItem;
11 use SL::Dev::CustomerVendor;
14 my %record_type_to_item_type = ( sales_invoice => 'SL::DB::InvoiceItem',
15 sales_order => 'SL::DB::OrderItem',
16 purchase_order => 'SL::DB::OrderItem',
17 sales_delivery_order => 'SL::DB::DeliveryOrderItem',
20 sub create_sales_invoice {
23 my $record_type = 'sales_invoice';
24 my $invoiceitems = delete $params{invoiceitems} // _create_two_items($record_type);
25 _check_items($invoiceitems, $record_type);
27 my $customer = delete $params{customer} // SL::Dev::CustomerVendor::create_customer(name => 'Testcustomer')->save;
28 die "illegal customer" unless defined $customer && ref($customer) eq 'SL::DB::Customer';
30 my $invoice = SL::DB::Invoice->new(
32 type => 'sales_invoice',
33 customer_id => $customer->id,
34 taxzone_id => $customer->taxzone->id,
35 invnumber => delete $params{invnumber} // undef,
36 currency_id => $params{currency_id} // $::instance_conf->get_currency_id,
37 taxincluded => $params{taxincluded} // 0,
38 employee_id => $params{employee_id} // SL::DB::Manager::Employee->current->id,
39 salesman_id => $params{employee_id} // SL::DB::Manager::Employee->current->id,
40 transdate => $params{transdate} // DateTime->today_local->to_kivitendo,
41 payment_id => $params{payment_id} // undef,
42 gldate => DateTime->today_local->to_kivitendo,
43 invoiceitems => $invoiceitems,
51 sub create_sales_delivery_order {
54 my $record_type = 'sales_delivery_order';
55 my $orderitems = delete $params{orderitems} // _create_two_items($record_type);
56 _check_items($orderitems, $record_type);
58 my $customer = $params{customer} // SL::Dev::CustomerVendor::create_customer(name => 'Testcustomer')->save;
59 die "illegal customer" unless ref($customer) eq 'SL::DB::Customer';
61 my $delivery_order = SL::DB::DeliveryOrder->new(
64 customer_id => $customer->id,
65 taxzone_id => $customer->taxzone_id,
66 donumber => $params{donumber} // undef,
67 currency_id => $params{currency_id} // $::instance_conf->get_currency_id,
68 taxincluded => $params{taxincluded} // 0,
69 employee_id => $params{employee_id} // SL::DB::Manager::Employee->current->id,
70 salesman_id => $params{employee_id} // SL::DB::Manager::Employee->current->id,
71 transdate => $params{transdate} // DateTime->today_local->to_kivitendo,
72 orderitems => $orderitems,
75 $delivery_order->save;
76 return $delivery_order;
79 sub create_sales_order {
82 my $record_type = 'sales_order';
83 my $orderitems = delete $params{orderitems} // _create_two_items($record_type);
84 _check_items($orderitems, $record_type);
86 my $save = delete $params{save} // 0;
88 my $customer = $params{customer} // SL::Dev::CustomerVendor::create_customer(name => 'Testcustomer')->save;
89 die "illegal customer" unless ref($customer) eq 'SL::DB::Customer';
91 my $order = SL::DB::Order->new(
92 customer_id => delete $params{customer_id} // $customer->id,
93 taxzone_id => delete $params{taxzone_id} // $customer->taxzone->id,
94 currency_id => delete $params{currency_id} // $::instance_conf->get_currency_id,
95 taxincluded => delete $params{taxincluded} // 0,
96 # employee_id => delete $params{employee_id} // SL::DB::Manager::Employee->current->id,
97 # salesman_id => delete $params{employee_id} // SL::DB::Manager::Employee->current->id,
98 transdate => delete $params{transdate} // DateTime->today_local->to_kivitendo,
99 orderitems => $orderitems,
104 $order->calculate_prices_and_taxes;
110 sub create_purchase_order {
113 my $record_type = 'purchase_order';
114 my $orderitems = delete $params{orderitems} // _create_two_items($record_type);
115 _check_items($orderitems, $record_type);
117 my $save = delete $params{save} // 0;
119 my $vendor = $params{vendor} // SL::Dev::CustomerVendor::create_vendor(name => 'Testvendor')->save;
120 die "illegal vendor" unless ref($vendor) eq 'SL::DB::Vendor';
122 my $order = SL::DB::Order->new(
123 vendor_id => delete $params{vendor_id} // $vendor->id,
124 taxzone_id => delete $params{taxzone_id} // $vendor->taxzone->id,
125 currency_id => delete $params{currency_id} // $::instance_conf->get_currency_id,
126 taxincluded => delete $params{taxincluded} // 0,
127 transdate => delete $params{transdate} // DateTime->today_local->to_kivitendo,
129 orderitems => $orderitems,
134 $order->calculate_prices_and_taxes; # not tested for purchase orders
141 my ($items, $record_type) = @_;
143 if ( scalar @{$items} == 0 or grep { ref($_) ne $record_type_to_item_type{"$record_type"} } @{$items} ) {
144 die "Error: items must be an arrayref of " . $record_type_to_item_type{"$record_type"} . "objects.";
148 sub create_invoice_item {
151 return _create_item(record_type => 'sales_invoice', %params);
154 sub create_order_item {
157 return _create_item(record_type => 'sales_order', %params);
160 sub create_delivery_order_item {
163 return _create_item(record_type => 'sales_delivery_order', %params);
169 my $record_type = delete($params{record_type});
170 my $part = delete($params{part});
172 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 };
173 die "part missing as param" unless $part && ref($part) eq 'SL::DB::Part';
175 my ($sellprice, $lastcost);
177 if ( $record_type =~ /^sales/ ) {
178 $sellprice = delete $params{sellprice} // $part->sellprice;
179 $lastcost = delete $params{lastcost} // $part->lastcost;
181 $sellprice = delete $params{sellprice} // $part->lastcost;
182 $lastcost = delete $params{lastcost} // 0; # $part->lastcost;
185 my $item = "$record_type_to_item_type{$record_type}"->new(
186 parts_id => $part->id,
187 sellprice => $sellprice,
188 lastcost => $lastcost,
189 description => $part->description,
191 qty => $params{qty} || 5,
197 sub _create_two_items {
198 my ($record_type) = @_;
200 my $part1 = SL::Dev::Part::create_part(description => 'Testpart 1',
203 my $part2 = SL::Dev::Part::create_part(description => 'Testpart 2',
206 my $item1 = _create_item(record_type => $record_type, part => $part1, qty => 5);
207 my $item2 = _create_item(record_type => $record_type, part => $part2, qty => 8);
208 return [ $item1, $item2 ];
217 SL::Dev::Record - create record objects for testing, with minimal defaults
221 =head2 C<create_sales_invoice %PARAMS>
223 Creates a new sales invoice (table ar, invoice = 1).
225 If neither customer nor invoiceitems are passed as params a customer and two
226 parts are created and used for building the invoice.
228 Minimal usage example:
230 my $invoice = SL::Dev::Record::create_sales_invoice();
234 my $invoice2 = SL::Dev::Record::create_sales_invoice(
236 transdate => DateTime->today_local->subtract(days => 7),
240 =head2 C<create_sales_order %PARAMS>
244 Create a sales order and save it directly via rose, without running
245 calculate_prices_and_taxes:
247 my $order = SL::Dev::Record::create_sales_order()->save;
249 Let create_sales_order run calculate_prices_and_taxes and save:
251 my $order = SL::Dev::Record::create_sales_order(save => 1);
254 Example including creation of part and of sales order.
255 my $part1 = SL::Dev::Part::create_part( partnumber => 'T4254')->save;
256 my $part2 = SL::Dev::Part::create_service(partnumber => 'Serv1')->save;
257 my $order = SL::Dev::Record::create_sales_order(
260 orderitems => [ SL::Dev::Record::create_order_item(part => $part1, qty => 3, sellprice => 70),
261 SL::Dev::Record::create_order_item(part => $part2, qty => 10, sellprice => 50),
265 =head2 C<create_purchase_order %PARAMS>
267 See comments for C<create_sales_order>.
270 my $purchase_order = SL::Dev::Record::create_purchase_order(save => 1);
273 =head2 C<create_item %PARAMS>
275 Creates an item from a part object that can be added to a record.
277 Required params: record_type (sales_invoice, sales_order, sales_delivery_order)
278 part (an SL::DB::Part object)
280 Example including creation of part and of invoice:
281 my $part = SL::Dev::Part::create_part( partnumber => 'T4254')->save;
282 my $item = SL::Dev::Record::create_item(record_type => 'sales_invoice', part => $part, qty => 2.5);
283 my $invoice = SL::Dev::Record::create_sales_invoice(
285 invoiceitems => [ $item ],
296 G. Richardson E<lt>grichardson@kivitendo-premium.deE<gt>