1 function openerp_pos_models(instance, module){ //module is instance.point_of_sale
2 var QWeb = instance.web.qweb;
3 var _t = instance.web._t;
5 var round_di = instance.web.round_decimals;
6 var round_pr = instance.web.round_precision
8 // The PosModel contains the Point Of Sale's representation of the backend.
9 // Since the PoS must work in standalone ( Without connection to the server )
10 // it must contains a representation of the server's PoS backend.
11 // (taxes, product list, configuration options, etc.) this representation
12 // is fetched and stored by the PosModel at the initialisation.
13 // this is done asynchronously, a ready deferred alows the GUI to wait interactively
14 // for the loading to be completed
15 // There is a single instance of the PosModel for each Front-End instance, it is usually called
16 // 'pos' and is available to all widgets extending PosWidget.
18 module.PosModel = Backbone.Model.extend({
19 initialize: function(session, attributes) {
20 Backbone.Model.prototype.initialize.call(this, attributes);
22 this.session = session;
23 this.flush_mutex = new $.Mutex(); // used to make sure the orders are sent to the server once at time
24 this.pos_widget = attributes.pos_widget;
26 this.proxy = new module.ProxyDevice(this); // used to communicate to the hardware devices via a local proxy
27 this.barcode_reader = new module.BarcodeReader({'pos': this, proxy:this.proxy, patterns: {}}); // used to read barcodes
28 this.proxy_queue = new module.JobQueue(); // used to prevent parallels communications to the proxy
29 this.db = new module.PosDB(); // a local database used to search trough products and categories & store pending orders
30 this.debug = jQuery.deparam(jQuery.param.querystring()).debug !== undefined; //debug mode
32 // Business data; loaded from the server at launch
33 this.accounting_precision = 2; //TODO
34 this.company_logo = null;
35 this.company_logo_base64 = '';
43 this.cashregisters = [];
44 this.bankstatements = [];
46 this.pos_session = null;
49 this.units_by_id = {};
50 this.pricelist = null;
51 this.order_sequence = 1;
52 window.posmodel = this;
54 // these dynamic attributes can be watched for change by other models or widgets
56 'synch': { state:'connected', pending:0 },
57 'orders': new module.OrderCollection(),
58 'selectedOrder': null,
61 this.bind('change:synch',function(pos,synch){
62 clearTimeout(self.synch_timeout);
63 self.synch_timeout = setTimeout(function(){
64 if(synch.state !== 'disconnected' && synch.pending > 0){
65 self.set('synch',{state:'disconnected', pending:synch.pending});
70 this.get('orders').bind('remove', function(order,_unused_,options){
71 self.on_removed_order(order,options.index,options.reason);
74 // We fetch the backend data on the server asynchronously. this is done only when the pos user interface is launched,
75 // Any change on this data made on the server is thus not reflected on the point of sale until it is relaunched.
76 // when all the data has loaded, we compute some stuff, and declare the Pos ready to be used.
77 this.ready = this.load_server_data()
79 if(self.config.use_proxy){
80 return self.connect_to_proxy();
86 // releases ressources holds by the model at the end of life of the posmodel
88 // FIXME, should wait for flushing, return a deferred to indicate successfull destruction
91 this.barcode_reader.disconnect();
92 this.barcode_reader.disconnect_from_proxy();
94 connect_to_proxy: function(){
96 var done = new $.Deferred();
97 this.barcode_reader.disconnect_from_proxy();
98 this.pos_widget.loading_message(_t('Connecting to the PosBox'),0);
99 this.pos_widget.loading_skip(function(){
100 self.proxy.stop_searching();
102 this.proxy.autoconnect({
103 force_ip: self.config.proxy_ip || undefined,
104 progress: function(prog){
105 self.pos_widget.loading_progress(prog);
108 if(self.config.iface_scan_via_proxy){
109 self.barcode_reader.connect_to_proxy();
111 }).always(function(){
117 // helper function to load data from the server. Obsolete use the models loader below.
118 fetch: function(model, fields, domain, ctx){
119 this._load_progress = (this._load_progress || 0) + 0.05;
120 this.pos_widget.loading_message(_t('Loading')+' '+model,this._load_progress);
121 return new instance.web.Model(model).query(fields).filter(domain).context(ctx).all()
124 // Server side model loaders. This is the list of the models that need to be loaded from
125 // the server. The models are loaded one by one by this list's order. The 'loaded' callback
126 // is used to store the data in the appropriate place once it has been loaded. This callback
127 // can return a deferred that will pause the loading of the next module.
128 // a shared temporary dictionary is available for loaders to communicate private variables
129 // used during loading such as object ids, etc.
133 fields: ['name','company_id'],
134 ids: function(self){ return [self.session.uid]; },
135 loaded: function(self,users){ self.user = users[0]; },
137 model: 'res.company',
138 fields: [ 'currency_id', 'email', 'website', 'company_registry', 'vat', 'name', 'phone', 'partner_id' , 'country_id'],
139 ids: function(self){ return [self.user.company_id[0]] },
140 loaded: function(self,companies){ self.company = companies[0]; },
142 model: 'decimal.precision',
143 fields: ['name','digits'],
144 loaded: function(self,dps){
146 for (var i = 0; i < dps.length; i++) {
147 self.dp[dps[i].name] = dps[i].digits;
151 model: 'product.uom',
154 loaded: function(self,units){
156 var units_by_id = {};
157 for(var i = 0, len = units.length; i < len; i++){
158 units_by_id[units[i].id] = units[i];
159 units[i].groupable = ( units[i].category_id[0] === 1 );
160 units[i].is_unit = ( units[i].id === 1 );
162 self.units_by_id = units_by_id;
166 fields: ['name','ean13'],
168 loaded: function(self,users){ self.users = users; },
170 model: 'res.partner',
171 fields: ['name','street','city','state_id','country_id','vat','phone','zip','mobile','email','ean13','write_date'],
173 loaded: function(self,partners){
174 self.partners = partners;
175 self.db.add_partners(partners);
178 model: 'res.country',
180 loaded: function(self,countries){
181 self.countries = countries;
182 self.company.country = null;
183 for (var i = 0; i < countries.length; i++) {
184 if (countries[i].id === self.company.country_id[0]){
185 self.company.country = countries[i];
190 model: 'account.tax',
191 fields: ['name','amount', 'price_include', 'type'],
193 loaded: function(self,taxes){ self.taxes = taxes; },
195 model: 'pos.session',
196 fields: ['id', 'journal_ids','name','user_id','config_id','start_at','stop_at','sequence_number','login_number'],
197 domain: function(self){ return [['state','=','opened'],['user_id','=',self.session.uid]]; },
198 loaded: function(self,pos_sessions){
199 self.pos_session = pos_sessions[0];
201 var orders = self.db.get_orders();
202 for (var i = 0; i < orders.length; i++) {
203 self.pos_session.sequence_number = Math.max(self.pos_session.sequence_number, orders[i].data.sequence_number+1);
209 domain: function(self){ return [['id','=', self.pos_session.config_id[0]]]; },
210 loaded: function(self,configs){
211 self.config = configs[0];
212 self.config.use_proxy = self.config.iface_payment_terminal ||
213 self.config.iface_electronic_scale ||
214 self.config.iface_print_via_proxy ||
215 self.config.iface_scan_via_proxy ||
216 self.config.iface_cashdrawer;
218 self.barcode_reader.add_barcode_patterns({
219 'product': self.config.barcode_product,
220 'cashier': self.config.barcode_cashier,
221 'client': self.config.barcode_customer,
222 'weight': self.config.barcode_weight,
223 'discount': self.config.barcode_discount,
224 'price': self.config.barcode_price,
227 if (self.config.company_id[0] !== self.user.company_id[0]) {
228 throw new Error(_t("Error: The Point of Sale User must belong to the same company as the Point of Sale. You are probably trying to load the point of sale as an administrator in a multi-company setup, with the administrator account set to the wrong company."));
232 model: 'stock.location',
234 ids: function(self){ return [self.config.stock_location_id[0]]; },
235 loaded: function(self, locations){ self.shop = locations[0]; },
237 model: 'product.pricelist',
238 fields: ['currency_id'],
239 ids: function(self){ return [self.config.pricelist_id[0]]; },
240 loaded: function(self, pricelists){ self.pricelist = pricelists[0]; },
242 model: 'res.currency',
243 fields: ['symbol','position','rounding','accuracy'],
244 ids: function(self){ return [self.pricelist.currency_id[0]]; },
245 loaded: function(self, currencies){
246 self.currency = currencies[0];
247 if (self.currency.rounding > 0) {
248 self.currency.decimals = Math.ceil(Math.log(1.0 / self.currency.rounding) / Math.log(10));
250 self.currency.decimals = 0;
255 model: 'product.packaging',
256 fields: ['ean','product_tmpl_id'],
258 loaded: function(self, packagings){
259 self.db.add_packagings(packagings);
262 model: 'pos.category',
263 fields: ['id','name','parent_id','child_id','image'],
265 loaded: function(self, categories){
266 self.db.add_categories(categories);
269 model: 'product.product',
270 fields: ['display_name', 'list_price','price','pos_categ_id', 'taxes_id', 'ean13', 'default_code',
271 'to_weight', 'uom_id', 'uos_id', 'uos_coeff', 'mes_type', 'description_sale', 'description',
273 domain: function(self){ return [['sale_ok','=',true],['available_in_pos','=',true]]; },
274 context: function(self){ return { pricelist: self.pricelist.id, display_default_code: false }; },
275 loaded: function(self, products){
276 self.db.add_products(products);
279 model: 'account.bank.statement',
280 fields: ['account_id','currency','journal_id','state','name','user_id','pos_session_id'],
281 domain: function(self){ return [['state', '=', 'open'],['pos_session_id', '=', self.pos_session.id]]; },
282 loaded: function(self, bankstatements, tmp){
283 self.bankstatements = bankstatements;
286 _.each(bankstatements,function(statement){
287 tmp.journals.push(statement.journal_id[0]);
291 model: 'account.journal',
293 domain: function(self,tmp){ return [['id','in',tmp.journals]]; },
294 loaded: function(self, journals){
295 self.journals = journals;
297 // associate the bank statements with their journals.
298 var bankstatements = self.bankstatements;
299 for(var i = 0, ilen = bankstatements.length; i < ilen; i++){
300 for(var j = 0, jlen = journals.length; j < jlen; j++){
301 if(bankstatements[i].journal_id[0] === journals[j].id){
302 bankstatements[i].journal = journals[j];
306 self.cashregisters = bankstatements;
310 loaded: function(self){
311 var fonts_loaded = new $.Deferred();
313 // Waiting for fonts to be loaded to prevent receipt printing
314 // from printing empty receipt while loading Inconsolata
315 // ( The font used for the receipt )
316 waitForWebfonts(['Lato','Inconsolata'], function(){
317 fonts_loaded.resolve();
320 // The JS used to detect font loading is not 100% robust, so
321 // do not wait more than 5sec
322 setTimeout(function(){
323 fonts_loaded.resolve();
330 loaded: function(self){
331 self.company_logo = new Image();
332 var logo_loaded = new $.Deferred();
333 self.company_logo.onload = function(){
334 var img = self.company_logo;
336 var targetwidth = 300;
338 if( img.width !== targetwidth ){
339 ratio = targetwidth / img.width;
341 if( img.height * ratio > maxheight ){
342 ratio = maxheight / img.height;
344 var width = Math.floor(img.width * ratio);
345 var height = Math.floor(img.height * ratio);
346 var c = document.createElement('canvas');
349 var ctx = c.getContext('2d');
350 ctx.drawImage(self.company_logo,0,0, width, height);
352 self.company_logo_base64 = c.toDataURL();
353 logo_loaded.resolve();
355 self.company_logo.onerror = function(){
356 logo_loaded.reject();
358 self.company_logo.crossOrigin = "anonymous";
359 self.company_logo.src = '/web/binary/company_logo' +'?_'+Math.random();
366 // loads all the needed data on the sever. returns a deferred indicating when all the data has loaded.
367 load_server_data: function(){
369 var loaded = new $.Deferred();
371 var progress_step = 1.0 / self.models.length;
372 var tmp = {}; // this is used to share a temporary state between models loaders
374 function load_model(index){
375 if(index >= self.models.length){
378 var model = self.models[index];
379 self.pos_widget.loading_message(_t('Loading')+' '+(model.label || model.model || ''), progress);
380 var fields = typeof model.fields === 'function' ? model.fields(self,tmp) : model.fields;
381 var domain = typeof model.domain === 'function' ? model.domain(self,tmp) : model.domain;
382 var context = typeof model.context === 'function' ? model.context(self,tmp) : model.context;
383 var ids = typeof model.ids === 'function' ? model.ids(self,tmp) : model.ids;
384 progress += progress_step;
389 var records = new instance.web.Model(model.model).call('read',[ids,fields],context);
391 var records = new instance.web.Model(model.model).query(fields).filter(domain).context(context).all()
393 records.then(function(result){
394 try{ // catching exceptions in model.loaded(...)
395 $.when(model.loaded(self,result,tmp))
396 .then(function(){ load_model(index + 1); },
397 function(err){ loaded.reject(err); });
404 }else if( model.loaded ){
405 try{ // catching exceptions in model.loaded(...)
406 $.when(model.loaded(self,tmp))
407 .then( function(){ load_model(index +1); },
408 function(err){ loaded.reject(err); });
413 load_model(index + 1);
427 // reload the list of partner, returns as a deferred that resolves if there were
428 // updated partners, and fails if not
429 load_new_partners: function(){
431 var def = new $.Deferred();
432 var fields = _.find(this.models,function(model){ return model.model === 'res.partner'; }).fields;
433 new instance.web.Model('res.partner')
435 .filter([['write_date','>',this.db.get_partner_write_date()]])
436 .all({'timeout':3000, 'shadow': true})
437 .then(function(partners){
438 if (self.db.add_partners(partners)) { // check if the partners we got were real updates
443 }, function(){ def.reject(); });
447 // this is called when an order is removed from the order collection. It ensures that there is always an existing
448 // order and a valid selected order
449 on_removed_order: function(removed_order,index,reason){
450 if( (reason === 'abandon' || removed_order.temporary) && this.get('orders').size() > 0){
451 // when we intentionally remove an unfinished order, and there is another existing one
452 this.set({'selectedOrder' : this.get('orders').at(index) || this.get('orders').last()});
454 // when the order was automatically removed after completion,
455 // or when we intentionally delete the only concurrent order
456 this.add_new_order();
460 //creates a new empty order and sets it as the current order
461 add_new_order: function(){
462 var order = new module.Order({pos:this});
463 this.get('orders').add(order);
464 this.set('selectedOrder', order);
467 get_order: function(){
468 return this.get('selectedOrder');
471 //removes the current order
472 delete_current_order: function(){
473 this.get('selectedOrder').destroy({'reason':'abandon'});
476 // saves the order locally and try to send it to the backend.
477 // it returns a deferred that succeeds after having tried to send the order and all the other pending orders.
478 push_order: function(order) {
482 this.proxy.log('push_order',order.export_as_JSON());
483 this.db.add_order(order.export_as_JSON());
486 var pushed = new $.Deferred();
488 this.flush_mutex.exec(function(){
489 var flushed = self._flush_orders(self.db.get_orders());
491 flushed.always(function(ids){
498 // saves the order locally and try to send it to the backend and make an invoice
499 // returns a deferred that succeeds when the order has been posted and successfully generated
500 // an invoice. This method can fail in various ways:
501 // error-no-client: the order must have an associated partner_id. You can retry to make an invoice once
502 // this error is solved
503 // error-transfer: there was a connection error during the transfer. You can retry to make the invoice once
504 // the network connection is up
506 push_and_invoice_order: function(order){
508 var invoiced = new $.Deferred();
510 if(!order.get_client()){
511 invoiced.reject('error-no-client');
515 var order_id = this.db.add_order(order.export_as_JSON());
517 this.flush_mutex.exec(function(){
518 var done = new $.Deferred(); // holds the mutex
520 // send the order to the server
521 // we have a 30 seconds timeout on this push.
522 // FIXME: if the server takes more than 30 seconds to accept the order,
523 // the client will believe it wasn't successfully sent, and very bad
524 // things will happen as a duplicate will be sent next time
525 // so we must make sure the server detects and ignores duplicated orders
527 var transfer = self._flush_orders([self.db.get_order(order_id)], {timeout:30000, to_invoice:true});
529 transfer.fail(function(){
530 invoiced.reject('error-transfer');
534 // on success, get the order id generated by the server
535 transfer.pipe(function(order_server_id){
537 // generate the pdf and download it
538 self.pos_widget.do_action('point_of_sale.pos_invoice_report',{additional_context:{
539 active_ids:order_server_id,
553 // wrapper around the _save_to_server that updates the synch status widget
554 _flush_orders: function(orders, options) {
557 this.set('synch',{ state: 'connecting', pending: orders.length});
559 return self._save_to_server(orders, options).done(function (server_ids) {
560 var pending = self.db.get_orders().length;
563 state: pending ? 'connecting' : 'connected',
571 // send an array of orders to the server
572 // available options:
573 // - timeout: timeout for the rpc call in ms
574 // returns a deferred that resolves with the list of
575 // server generated ids for the sent orders
576 _save_to_server: function (orders, options) {
577 if (!orders || !orders.length) {
578 var result = $.Deferred();
583 options = options || {};
586 var timeout = typeof options.timeout === 'number' ? options.timeout : 7500 * orders.length;
588 // we try to send the order. shadow prevents a spinner if it takes too long. (unless we are sending an invoice,
589 // then we want to notify the user that we are waiting on something )
590 var posOrderModel = new instance.web.Model('pos.order');
591 return posOrderModel.call('create_from_ui',
592 [_.map(orders, function (order) {
593 order.to_invoice = options.to_invoice || false;
598 shadow: !options.to_invoice,
601 ).then(function (server_ids) {
602 _.each(orders, function (order) {
603 self.db.remove_order(order.id);
606 }).fail(function (error, event){
607 if(error.code === 200 ){ // Business Logic Error, not a connection problem
608 self.pos_widget.screen_selector.show_popup('error-traceback',{
609 message: error.data.message,
610 comment: error.data.debug
613 // prevent an error popup creation by the rpc failure
614 // we want the failure to be silent as we send the orders in the background
615 event.preventDefault();
616 console.error('Failed to send orders:', orders);
620 scan_product: function(parsed_code){
622 var selectedOrder = this.get('selectedOrder');
623 if(parsed_code.encoding === 'ean13'){
624 var product = this.db.get_product_by_ean13(parsed_code.base_code);
625 }else if(parsed_code.encoding === 'reference'){
626 var product = this.db.get_product_by_reference(parsed_code.code);
633 if(parsed_code.type === 'price'){
634 selectedOrder.addProduct(product, {price:parsed_code.value});
635 }else if(parsed_code.type === 'weight'){
636 selectedOrder.addProduct(product, {quantity:parsed_code.value, merge:false});
637 }else if(parsed_code.type === 'discount'){
638 selectedOrder.addProduct(product, {discount:parsed_code.value, merge:false});
640 selectedOrder.addProduct(product);
646 var orderline_id = 1;
648 // An orderline represent one element of the content of a client's shopping cart.
649 // An orderline contains a product, its quantity, its price, discount. etc.
650 // An Order contains zero or more Orderlines.
651 module.Orderline = Backbone.Model.extend({
652 initialize: function(attr,options){
653 this.pos = options.pos;
654 this.order = options.order;
655 this.product = options.product;
656 this.price = options.product.price;
658 this.quantityStr = '1';
660 this.discountStr = '0';
662 this.selected = false;
663 this.id = orderline_id++;
666 var orderline = new module.Orderline({},{
669 product: this.product,
672 orderline.quantity = this.quantity;
673 orderline.quantityStr = this.quantityStr;
674 orderline.discount = this.discount;
675 orderline.type = this.type;
676 orderline.selected = false;
679 // sets a discount [0,100]%
680 set_discount: function(discount){
681 var disc = Math.min(Math.max(parseFloat(discount) || 0, 0),100);
682 this.discount = disc;
683 this.discountStr = '' + disc;
684 this.trigger('change',this);
686 // returns the discount [0,100]%
687 get_discount: function(){
688 return this.discount;
690 get_discount_str: function(){
691 return this.discountStr;
693 get_product_type: function(){
696 // sets the quantity of the product. The quantity will be rounded according to the
697 // product's unity of measure properties. Quantities greater than zero will not get
699 set_quantity: function(quantity){
700 if(quantity === 'remove'){
701 this.order.removeOrderline(this);
704 var quant = parseFloat(quantity) || 0;
705 var unit = this.get_unit();
708 this.quantity = round_pr(quant, unit.rounding);
709 this.quantityStr = this.quantity.toFixed(Math.ceil(Math.log(1.0 / unit.rounding) / Math.log(10)));
711 this.quantity = round_pr(quant, 1);
712 this.quantityStr = this.quantity.toFixed(0);
715 this.quantity = quant;
716 this.quantityStr = '' + this.quantity;
719 this.trigger('change',this);
721 // return the quantity of product
722 get_quantity: function(){
723 return this.quantity;
725 get_quantity_str: function(){
726 return this.quantityStr;
728 get_quantity_str_with_unit: function(){
729 var unit = this.get_unit();
730 if(unit && !unit.is_unit){
731 return this.quantityStr + ' ' + unit.name;
733 return this.quantityStr;
736 // return the unit of measure of the product
737 get_unit: function(){
738 var unit_id = (this.product.uos_id || this.product.uom_id);
742 unit_id = unit_id[0];
746 return this.pos.units_by_id[unit_id];
748 // return the product of this orderline
749 get_product: function(){
752 // selects or deselects this orderline
753 set_selected: function(selected){
754 this.selected = selected;
755 this.trigger('change',this);
757 // returns true if this orderline is selected
758 is_selected: function(){
759 return this.selected;
761 // when we add an new orderline we want to merge it with the last line to see reduce the number of items
762 // in the orderline. This returns true if it makes sense to merge the two
763 can_be_merged_with: function(orderline){
764 if( this.get_product().id !== orderline.get_product().id){ //only orderline of the same product can be merged
766 }else if(!this.get_unit() || !this.get_unit().groupable){
768 }else if(this.get_product_type() !== orderline.get_product_type()){
770 }else if(this.get_discount() > 0){ // we don't merge discounted orderlines
772 }else if(this.price !== orderline.price){
778 merge: function(orderline){
779 this.set_quantity(this.get_quantity() + orderline.get_quantity());
781 export_as_JSON: function() {
783 qty: this.get_quantity(),
784 price_unit: this.get_unit_price(),
785 discount: this.get_discount(),
786 product_id: this.get_product().id,
789 //used to create a json of the ticket, to be sent to the printer
790 export_for_printing: function(){
792 quantity: this.get_quantity(),
793 unit_name: this.get_unit().name,
794 price: this.get_unit_price(),
795 discount: this.get_discount(),
796 product_name: this.get_product().display_name,
797 price_display : this.get_display_price(),
798 price_with_tax : this.get_price_with_tax(),
799 price_without_tax: this.get_price_without_tax(),
801 product_description: this.get_product().description,
802 product_description_sale: this.get_product().description_sale,
805 // changes the base price of the product for this orderline
806 set_unit_price: function(price){
807 this.price = round_di(parseFloat(price) || 0, this.pos.dp['Product Price']);
808 this.trigger('change',this);
810 get_unit_price: function(){
813 get_display_price: function(){
814 var rounding = this.pos.currency.rounding;
815 return round_pr(round_pr(this.get_unit_price() * this.get_quantity(),rounding) * (1- this.get_discount()/100.0),rounding);
817 get_price_without_tax: function(){
818 return this.get_all_prices().priceWithoutTax;
820 get_price_with_tax: function(){
821 return this.get_all_prices().priceWithTax;
824 return this.get_all_prices().tax;
826 get_tax_details: function(){
827 return this.get_all_prices().taxDetails;
829 get_all_prices: function(){
831 var currency_rounding = this.pos.currency.rounding;
832 var base = round_pr(this.get_quantity() * this.get_unit_price() * (1.0 - (this.get_discount() / 100.0)), currency_rounding);
834 var totalNoTax = base;
836 var product = this.get_product();
837 var taxes_ids = product.taxes_id;
838 var taxes = self.pos.taxes;
841 _.each(taxes_ids, function(el) {
842 var tax = _.detect(taxes, function(t) {return t.id === el;});
843 if (tax.price_include) {
845 if (tax.type === "percent") {
846 tmp = base - round_pr(base / (1 + tax.amount),currency_rounding);
847 } else if (tax.type === "fixed") {
848 tmp = round_pr(tax.amount * self.get_quantity(),currency_rounding);
850 throw "This type of tax is not supported by the point of sale: " + tax.type;
852 tmp = round_pr(tmp,currency_rounding);
855 taxdetail[tax.id] = tmp;
858 if (tax.type === "percent") {
859 tmp = tax.amount * base;
860 } else if (tax.type === "fixed") {
861 tmp = tax.amount * self.get_quantity();
863 throw "This type of tax is not supported by the point of sale: " + tax.type;
865 tmp = round_pr(tmp,currency_rounding);
868 taxdetail[tax.id] = tmp;
872 "priceWithTax": totalTax,
873 "priceWithoutTax": totalNoTax,
875 "taxDetails": taxdetail,
880 module.OrderlineCollection = Backbone.Collection.extend({
881 model: module.Orderline,
884 // Every Paymentline contains a cashregister and an amount of money.
885 module.Paymentline = Backbone.Model.extend({
886 initialize: function(attributes, options) {
888 this.cashregister = options.cashregister;
889 this.name = this.cashregister.journal_id[1];
890 this.selected = false;
891 this.pos = options.pos;
893 //sets the amount of money on this payment line
894 set_amount: function(value){
895 this.amount = round_di(parseFloat(value) || 0, this.pos.currency.decimals);
896 this.trigger('change:amount',this);
898 // returns the amount of money on this paymentline
899 get_amount: function(){
902 get_amount_str: function(){
903 return this.amount.toFixed(this.pos.currency.decimals);
905 set_selected: function(selected){
906 if(this.selected !== selected){
907 this.selected = selected;
908 this.trigger('change:selected',this);
911 // returns the associated cashregister
912 //exports as JSON for server communication
913 export_as_JSON: function(){
915 name: instance.web.datetime_to_str(new Date()),
916 statement_id: this.cashregister.id,
917 account_id: this.cashregister.account_id[0],
918 journal_id: this.cashregister.journal_id[0],
919 amount: this.get_amount()
922 //exports as JSON for receipt printing
923 export_for_printing: function(){
925 amount: this.get_amount(),
926 journal: this.cashregister.journal_id[1],
931 module.PaymentlineCollection = Backbone.Collection.extend({
932 model: module.Paymentline,
936 // An order more or less represents the content of a client's shopping cart (the OrderLines)
937 // plus the associated payment information (the Paymentlines)
938 // there is always an active ('selected') order in the Pos, a new one is created
939 // automaticaly once an order is completed and sent to the server.
940 module.Order = Backbone.Model.extend({
941 initialize: function(attributes){
942 Backbone.Model.prototype.initialize.apply(this, arguments);
943 this.pos = attributes.pos;
944 this.sequence_number = this.pos.pos_session.sequence_number++;
945 this.uid = this.generateUniqueId();
947 creationDate: new Date(),
948 orderLines: new module.OrderlineCollection(),
949 paymentLines: new module.PaymentlineCollection(),
950 name: _t("Order ") + this.uid,
953 this.selected_orderline = undefined;
954 this.selected_paymentline = undefined;
955 this.screen_data = {}; // see ScreenSelector
956 this.receipt_type = 'receipt'; // 'receipt' || 'invoice'
957 this.temporary = attributes.temporary || false;
960 is_empty: function(){
961 return (this.get('orderLines').models.length === 0);
963 // Generates a public identification number for the order.
964 // The generated number must be unique and sequential. They are made 12 digit long
965 // to fit into EAN-13 barcodes, should it be needed
966 generateUniqueId: function() {
967 function zero_pad(num,size){
969 while (s.length < size) {
974 return zero_pad(this.pos.pos_session.id,5) +'-'+
975 zero_pad(this.pos.pos_session.login_number,3) +'-'+
976 zero_pad(this.sequence_number,4);
978 addOrderline: function(line){
980 order.removeOrderline(line);
983 this.get('orderLines').add(line);
984 this.selectLine(this.getLastOrderline());
986 addProduct: function(product, options){
987 options = options || {};
988 var attr = JSON.parse(JSON.stringify(product));
991 var line = new module.Orderline({}, {pos: this.pos, order: this, product: product});
993 if(options.quantity !== undefined){
994 line.set_quantity(options.quantity);
996 if(options.price !== undefined){
997 line.set_unit_price(options.price);
999 if(options.discount !== undefined){
1000 line.set_discount(options.discount);
1003 var last_orderline = this.getLastOrderline();
1004 if( last_orderline && last_orderline.can_be_merged_with(line) && options.merge !== false){
1005 last_orderline.merge(line);
1007 this.get('orderLines').add(line);
1009 this.selectLine(this.getLastOrderline());
1011 removeOrderline: function( line ){
1012 this.get('orderLines').remove(line);
1013 this.selectLine(this.getLastOrderline());
1015 getOrderline: function(id){
1016 var orderlines = this.get('orderLines').models;
1017 for(var i = 0; i < orderlines.length; i++){
1018 if(orderlines[i].id === id){
1019 return orderlines[i];
1024 getLastOrderline: function(){
1025 return this.get('orderLines').at(this.get('orderLines').length -1);
1027 addPaymentline: function(cashregister) {
1028 var paymentLines = this.get('paymentLines');
1029 var newPaymentline = new module.Paymentline({},{cashregister:cashregister, pos:this.pos});
1030 if(cashregister.journal.type !== 'cash'){
1031 newPaymentline.set_amount( Math.max(this.getDueLeft(),0) );
1033 paymentLines.add(newPaymentline);
1034 this.selectPaymentline(newPaymentline);
1037 removePaymentline: function(line){
1038 if(this.selected_paymentline === line){
1039 this.selectPaymentline(undefined);
1041 this.get('paymentLines').remove(line);
1043 getName: function() {
1044 return this.get('name');
1046 getSubtotal : function(){
1047 return (this.get('orderLines')).reduce((function(sum, orderLine){
1048 return sum + orderLine.get_display_price();
1051 getTotalTaxIncluded: function() {
1052 return (this.get('orderLines')).reduce((function(sum, orderLine) {
1053 return sum + orderLine.get_price_with_tax();
1056 getDiscountTotal: function() {
1057 return (this.get('orderLines')).reduce((function(sum, orderLine) {
1058 return sum + (orderLine.get_unit_price() * (orderLine.get_discount()/100) * orderLine.get_quantity());
1061 getTotalTaxExcluded: function() {
1062 return (this.get('orderLines')).reduce((function(sum, orderLine) {
1063 return sum + orderLine.get_price_without_tax();
1066 getTax: function() {
1067 return (this.get('orderLines')).reduce((function(sum, orderLine) {
1068 return sum + orderLine.get_tax();
1071 getTaxDetails: function(){
1073 var fulldetails = [];
1074 var taxes_by_id = {};
1076 for(var i = 0; i < this.pos.taxes.length; i++){
1077 taxes_by_id[this.pos.taxes[i].id] = this.pos.taxes[i];
1080 this.get('orderLines').each(function(line){
1081 var ldetails = line.get_tax_details();
1082 for(var id in ldetails){
1083 if(ldetails.hasOwnProperty(id)){
1084 details[id] = (details[id] || 0) + ldetails[id];
1089 for(var id in details){
1090 if(details.hasOwnProperty(id)){
1091 fulldetails.push({amount: details[id], tax: taxes_by_id[id], name: taxes_by_id[id].name});
1097 getPaidTotal: function() {
1098 return (this.get('paymentLines')).reduce((function(sum, paymentLine) {
1099 return sum + paymentLine.get_amount();
1102 getChange: function() {
1103 return this.getPaidTotal() - this.getTotalTaxIncluded();
1105 getDueLeft: function() {
1106 return this.getTotalTaxIncluded() - this.getPaidTotal();
1108 // sets the type of receipt 'receipt'(default) or 'invoice'
1109 set_receipt_type: function(type){
1110 this.receipt_type = type;
1112 get_receipt_type: function(){
1113 return this.receipt_type;
1115 // the client related to the current order.
1116 set_client: function(client){
1117 this.set('client',client);
1119 get_client: function(){
1120 return this.get('client');
1122 get_client_name: function(){
1123 var client = this.get('client');
1124 return client ? client.name : "";
1126 // the order also stores the screen status, as the PoS supports
1127 // different active screens per order. This method is used to
1128 // store the screen status.
1129 set_screen_data: function(key,value){
1130 if(arguments.length === 2){
1131 this.screen_data[key] = value;
1132 }else if(arguments.length === 1){
1133 for(key in arguments[0]){
1134 this.screen_data[key] = arguments[0][key];
1138 //see set_screen_data
1139 get_screen_data: function(key){
1140 return this.screen_data[key];
1142 // exports a JSON for receipt printing
1143 export_for_printing: function(){
1144 var orderlines = [];
1145 this.get('orderLines').each(function(orderline){
1146 orderlines.push(orderline.export_for_printing());
1149 var paymentlines = [];
1150 this.get('paymentLines').each(function(paymentline){
1151 paymentlines.push(paymentline.export_for_printing());
1153 var client = this.get('client');
1154 var cashier = this.pos.cashier || this.pos.user;
1155 var company = this.pos.company;
1156 var shop = this.pos.shop;
1157 var date = new Date();
1160 orderlines: orderlines,
1161 paymentlines: paymentlines,
1162 subtotal: this.getSubtotal(),
1163 total_with_tax: this.getTotalTaxIncluded(),
1164 total_without_tax: this.getTotalTaxExcluded(),
1165 total_tax: this.getTax(),
1166 total_paid: this.getPaidTotal(),
1167 total_discount: this.getDiscountTotal(),
1168 tax_details: this.getTaxDetails(),
1169 change: this.getChange(),
1170 name : this.getName(),
1171 client: client ? client.name : null ,
1172 invoice_id: null, //TODO
1173 cashier: cashier ? cashier.name : null,
1174 header: this.pos.config.receipt_header || '',
1175 footer: this.pos.config.receipt_footer || '',
1182 year: date.getFullYear(),
1183 month: date.getMonth(),
1184 date: date.getDate(), // day of the month
1185 day: date.getDay(), // day of the week
1186 hour: date.getHours(),
1187 minute: date.getMinutes() ,
1188 isostring: date.toISOString(),
1189 localestring: date.toLocaleString(),
1192 email: company.email,
1193 website: company.website,
1194 company_registry: company.company_registry,
1195 contact_address: company.partner_id[1],
1198 phone: company.phone,
1199 logo: this.pos.company_logo_base64,
1204 currency: this.pos.currency,
1207 export_as_JSON: function() {
1208 var orderLines, paymentLines;
1210 (this.get('orderLines')).each(_.bind( function(item) {
1211 return orderLines.push([0, 0, item.export_as_JSON()]);
1214 (this.get('paymentLines')).each(_.bind( function(item) {
1215 return paymentLines.push([0, 0, item.export_as_JSON()]);
1218 name: this.getName(),
1219 amount_paid: this.getPaidTotal(),
1220 amount_total: this.getTotalTaxIncluded(),
1221 amount_tax: this.getTax(),
1222 amount_return: this.getChange(),
1224 statement_ids: paymentLines,
1225 pos_session_id: this.pos.pos_session.id,
1226 partner_id: this.get_client() ? this.get_client().id : false,
1227 user_id: this.pos.cashier ? this.pos.cashier.id : this.pos.user.id,
1229 sequence_number: this.sequence_number,
1232 getSelectedLine: function(){
1233 return this.selected_orderline;
1235 selectLine: function(line){
1237 if(line !== this.selected_orderline){
1238 if(this.selected_orderline){
1239 this.selected_orderline.set_selected(false);
1241 this.selected_orderline = line;
1242 this.selected_orderline.set_selected(true);
1245 this.selected_orderline = undefined;
1248 deselectLine: function(){
1249 if(this.selected_orderline){
1250 this.selected_orderline.set_selected(false);
1251 this.selected_orderline = undefined;
1254 selectPaymentline: function(line){
1255 if(line !== this.selected_paymentline){
1256 if(this.selected_paymentline){
1257 this.selected_paymentline.set_selected(false);
1259 this.selected_paymentline = line;
1260 if(this.selected_paymentline){
1261 this.selected_paymentline.set_selected(true);
1263 this.trigger('change:selected_paymentline',this.selected_paymentline);
1268 module.OrderCollection = Backbone.Collection.extend({
1269 model: module.Order,
1273 The numpad handles both the choice of the property currently being modified
1274 (quantity, price or discount) and the edition of the corresponding numeric value.
1276 module.NumpadState = Backbone.Model.extend({
1281 appendNewChar: function(newChar) {
1283 oldBuffer = this.get('buffer');
1284 if (oldBuffer === '0') {
1288 } else if (oldBuffer === '-0') {
1290 buffer: "-" + newChar
1294 buffer: (this.get('buffer')) + newChar
1297 this.trigger('set_value',this.get('buffer'));
1299 deleteLastChar: function() {
1300 if(this.get('buffer') === ""){
1301 if(this.get('mode') === 'quantity'){
1302 this.trigger('set_value','remove');
1304 this.trigger('set_value',this.get('buffer'));
1307 var newBuffer = this.get('buffer').slice(0,-1) || "";
1308 this.set({ buffer: newBuffer });
1309 this.trigger('set_value',this.get('buffer'));
1312 switchSign: function() {
1314 oldBuffer = this.get('buffer');
1316 buffer: oldBuffer[0] === '-' ? oldBuffer.substr(1) : "-" + oldBuffer
1318 this.trigger('set_value',this.get('buffer'));
1320 changeMode: function(newMode) {
1332 resetValue: function(){
1333 this.set({buffer:'0'});