1 /*jshint indent:2, curly:true, eqeqeq:true, immed:true, latedef:true,
2 newcap:true, noarg:true, regexp:true, undef:true, strict:true, trailing:true,
4 /*global XV:true, XT:true, _:true, console:true, XM:true, Backbone:true,
5 require:true, assert:true, setTimeout:true, clearTimeout:true, exports:true,
6 it:true, describe:true, beforeEach:true, before:true, enyo:true */
12 TODO: the following items are not yet done but need to be done by release
14 1. tax type defaults to item tax type if user has no OverrideTax privilege
18 TODO deferred to later sprint:
20 * filter invoice list by customer group
21 * print invoices (support printing more that 1 on the same screen)
22 * inventory extensions
23 * manufacturing extensions
24 * get the tax summary and tax adjustment boxes in the same panel
25 * Include a panel that displays credit allocations.
26 - When clicked a "new" button should allow the user to create a new minimalized version
27 of cash receipt on-the-fly. The cash receipt need only record the amount, currency,
28 document number, document date, distribution date and whether the balance should
29 generate a credit memo or a customer deposit, depending on global customer deposit metrics.
30 "EnableCustomerDeposit"
31 - When clicked, an "allocate" button should present a list of open receivables that are
32 credits that can be associated with the invoice.
33 - The 2 buttons above should only be enabled if the user has the "ApplyARMemos" privilege.
35 var async = require("async"),
36 _ = require("underscore"),
37 smoke = require("../lib/smoke"),
38 common = require("../lib/common"),
39 assert = require("chai").assert,
55 Here is some high-level description of what an invoice is supposed to do.
58 @property {String} number [that is the documentKey and idAttribute.] (Next available Invoice Number will automatically display, unless your system requires you to enter Invoice Numbers manually. Default values and input parameters for Invoice Numbers are configurable at the system level.)
59 @property {Date} invoiceDate [required default today] (By default, the current day's date will be entered.)
60 @property {Boolean} isPosted [required, defaulting to false, read only]
61 @property {Boolean} isVoid [required, defaulting to false, read only]
62 @property {BillingCustomer} customer [required] (Enter the Customer Number of the Customer to be billed. The lookup feature located to the right of the field leads to a searchable Customers list. You may also access this list using the keyboard shortcut "CTRL + L". Once a Customer Number is entered, the Customer name and billing address will display. Select the "?" or "$" symbol to view Customer information for the specified Customer. If a Customer's credit is "In Good Standing," the button will feature a black question mark ("?") icon. If the icon turns to an orange dollar sign ("$"), the Customer's credit Status is "On Credit Warning." A red dollar sign ("$") indicates the Customer's credit Status is "On Credit Hold.")
63 @property {String} billtoName
64 @property {String} billtoAddress1 (Enter the Customer address where bills should be sent. By default, the billing address defined on the Customer master will be entered here.)
65 @property {String} billtoAddress2 ()
66 @property {String} billtoAddress3 ()
67 @property {String} billtoCity ()
68 @property {String} billtoState ()
69 @property {String} billtoPostalCode ()
70 @property {String} billtoCountry ()
71 @property {String} billtoPhone ()
72 @property {Currency} currency
73 @property {Terms} terms (Specify the billing Terms for the Invoice. By default, the Customer's standard billing terms will appear in the field.)
74 @property {SalesRep} salesRep (Specify the Sales Representative for the Invoice. By default, the Customer's designated Sales Representative will appear in the field.)
75 @property {Percent} commission [required, default 0] By default, the commission percentage recorded on the Customer master will be automatically entered in this field. If for some reason you select a non-default Sales Representative at Order entry, the commission rate will not change. To adjust the commission rate, you must make the change manually.
76 @property {SaleType} saleType
77 @property {String} customerPurchaseOrderNumber PO #: Enter a Customer Purchase Order Number, as needed
78 @property {TaxZone} taxZone (Specify the Tax Zone for the Invoice. By default, the main Tax Zone for the Customer will appear in the field. The Ship-To Address Tax Zone will be shown if a Ship-To Address is being used.)
79 @property {String} notes (This is a scrolling text field with word-wrapping for entering Notes related to the Invoice. Notes entered on this screen will follow the Invoice through the billing process. For example, you may view notes associated with a posted Invoice within the Invoice Information report.)
80 @property {InvoiceRelation} recurringInvoice
81 @property {Money} allocatedCredit the sum of all allocated credits
82 @property {Money} outstandingCredit the sum of all unallocated credits, not including
84 @property {Money} subtotal the sum of the extended price of all line items
85 @property {Money} taxTotal the sum of all taxes inluding line items, freight and
87 @property {Money} miscCharge read only (will be re-implemented as editable by Ledger)
88 @property {Money} total the calculated total of subtotal + freight + tax + miscCharge
89 @property {Money} balance the sum of total - allocatedCredit - authorizedCredit -
91 - If sum calculates to less than zero, then the balance is zero.
92 @property {InvoiceAllocation} allocations (Displays the monetary value of any Credit Memos and/or Credit Card charges which have been specifically allocated to the Invoice. To allocate Credit Memos to the Invoice, select the "Allocated C/M's" link.)
93 @property {InvoiceTax} taxAdjustments
94 @property {InvoiceLine} lineItems Display lists Line Items for this Invoice. A valid Customer Number must be entered in the "Customer #" field before Line Items can be added to the Order.
95 @property {InvoiceCharacteristic} characteristics
96 @property {InvoiceContact} contacts
97 @property {InvoiceAccount} accounts
98 @property {InvoiceCustomer} customers
99 @property {InvoiceFile} files
100 @property {InvoiceUrl} urls
101 @property {InvoiceItem} items
102 @property {String} orderNumber [Added by sales extension] (Will display the relevant Sales Order Number for Invoices generated from the Select for Billing process flow. If the Invoice is miscellaneous and was not generated by the Select for Billing process, then use this field for informational or reference purposes. Possible references might include Sales Order Number or Customer Purchase Order Number.)
103 @property {Date} orderDate [Added by sales extension] By default, the current day's date will be entered.
104 @property {InvoiceSalesOrder} salesOrders [Added by sales extension]
105 @property {InvoiceIncident} incidents [Added by crm extension]
106 @property {InvoiceOpportunity} opportunities [Added by crm extension]
109 recordType: "XM.Invoice",
110 collectionType: "XM.InvoiceListItemCollection",
114 @description The invoice collection is not cached.
117 listKind: "XV.InvoiceList",
118 instanceOf: "XM.Document",
122 @description Invoice is lockable.
128 @description The ID attribute is "number", which will be automatically uppercased.
130 idAttribute: "number",
131 enforceUpperKey: true,
132 attributes: ["number", "invoiceDate", "isPosted", "isVoid", "customer",
133 "billtoName", "billtoAddress1", "billtoAddress2", "billtoAddress3",
134 "billtoCity", "billtoState", "billtoPostalCode", "billtoCountry",
135 "billtoPhone", "currency", "terms", "salesRep", "commission",
136 "saleType", "customerPurchaseOrderNumber", "taxZone", "notes",
137 "recurringInvoice", "allocatedCredit", "outstandingCredit", "subtotal",
138 "taxTotal", "miscCharge", "total", "balance", "allocations",
139 "taxAdjustments", "lineItems", "characteristics", "contacts",
140 "accounts", "customers", "files", "urls", "items",
141 "orderNumber", "orderDate", "salesOrders", // these 3 from sales extension
142 "incidents", "opportunities", // these 2 from crm
143 "project", "projects"], // these 2 from project
144 requiredAttributes: ["number", "invoiceDate", "isPosted", "isVoid",
145 "customer", "commission"],
147 invoiceDate: new Date(),
155 @description Used in the billing module
157 extensions: ["billing"],
161 @description Users can create, update, and delete invoices if they have the
162 MaintainMiscInvoices privilege.
167 @description Users can read invoices if they have the ViewMiscInvoices privilege.
170 createUpdateDelete: "MaintainMiscInvoices",
171 read: "ViewMiscInvoices"
174 number: "30" + (100 + Math.round(Math.random() * 900)),
175 customer: {number: "TTOYS"}
177 updatableField: "notes",
178 beforeSaveActions: [{it: 'sets up a valid line item',
179 action: require("./sales_order").getBeforeSaveAction("XM.InvoiceLine")}],
181 beforeSaveUIActions: [{it: 'sets up a valid line item',
182 action: function (workspace, done) {
185 workspace.value.on("change:total", done);
186 workspace.$.lineItemBox.newItem();
187 gridRow = workspace.$.lineItemBox.$.editableGridRow;
189 //gridRow.$.itemSiteWidget.doValueChange({value: {item: submodels.itemModel,
190 //site: submodels.siteModel}});
191 gridRow.$.quantityWidget.doValueChange({value: 5});
197 var additionalTests = function () {
201 @description There is a setting "Valid Credit Card Days"
204 describe("Setup for Invoice", function () {
205 it("The system settings option CCValidDays will default to 7 if " +
206 "not already in the db", function () {
207 assert.equal(XT.session.settings.get("CCValidDays"), 7);
212 @description Characteristics can be assigned as being for invoices
214 it("XM.Characteristic includes isInvoices as a context attribute", function () {
215 var characteristic = new XM.Characteristic();
216 assert.isBoolean(characteristic.get("isInvoices"));
219 @member InvoiceCharacteristic
221 @description Follows the convention for characteristics
224 it("convention for characteristic assignments", function () {
227 assert.isFunction(XM.InvoiceCharacteristic);
228 model = new XM.InvoiceCharacteristic();
229 assert.isTrue(model instanceof XM.CharacteristicAssignment);
231 it("can be set by a widget in the characteristics workspace", function () {
232 var characteristicWorkspace = new XV.CharacteristicWorkspace();
233 assert.include(_.map(characteristicWorkspace.$, function (control) {
241 @description Documents should exist to connect an invoice to:
242 Contact, Account, Customer, File, Url, Item
244 describe("Nested-only Document associations per the document convention", function () {
245 it("XM.InvoiceContact", function () {
246 assert.isFunction(XM.InvoiceContact);
247 assert.isTrue(XM.InvoiceContact.prototype.isDocumentAssignment);
249 it("XM.InvoiceAccount", function () {
250 assert.isFunction(XM.InvoiceAccount);
251 assert.isTrue(XM.InvoiceAccount.prototype.isDocumentAssignment);
253 it("XM.InvoiceCustomer", function () {
254 assert.isFunction(XM.InvoiceCustomer);
255 assert.isTrue(XM.InvoiceCustomer.prototype.isDocumentAssignment);
257 it("XM.InvoiceFile", function () {
258 assert.isFunction(XM.InvoiceFile);
259 assert.isTrue(XM.InvoiceFile.prototype.isDocumentAssignment);
261 it("XM.InvoiceUrl", function () {
262 assert.isFunction(XM.InvoiceUrl);
263 assert.isTrue(XM.InvoiceUrl.prototype.isDocumentAssignment);
265 it("XM.InvoiceItem", function () {
266 assert.isFunction(XM.InvoiceItem);
267 assert.isTrue(XM.InvoiceItem.prototype.isDocumentAssignment);
270 describe("InvoiceLine", function () {
271 before(function (done) {
274 common.fetchModel(bpaint, XM.ItemRelation, {number: "BPAINT1"}, function (err, model) {
280 common.fetchModel(btruck, XM.ItemRelation, {number: "BTRUCK1"}, function (err, model) {
286 common.initializeModel(invoiceModel, XM.Invoice, function (err, model) {
287 invoiceModel = model;
292 common.initializeModel(lineModel, XM.InvoiceLine, function (err, model) {
298 usd = _.find(XM.currencies.models, function (model) {
299 return model.get("abbreviation") === "USD";
301 gbp = _.find(XM.currencies.models, function (model) {
302 return model.get("abbreviation") === "GBP";
309 @member InvoiceLineTax
310 @memberof InvoiceLine
311 @description Contains the tax of an invoice line.
312 @property {String} uuid The ID attribute ()
313 @property {TaxType} taxType
314 @property {TaxCode} taxCode
315 @property {Money} amount
317 it("has InvoiceLineTax as a nested-only model extending XM.Model", function () {
318 var attrs = ["uuid", "taxType", "taxCode", "amount"],
321 assert.isFunction(XM.InvoiceLineTax);
322 model = new XM.InvoiceLineTax();
323 assert.isTrue(model instanceof XM.Model);
324 assert.equal(model.idAttribute, "uuid");
325 assert.equal(_.difference(attrs, model.getAttributeNames()).length, 0);
327 it.skip("XM.InvoiceLineTax can be created, updated and deleted", function () {
328 // TODO: put under test (code is written)
330 it.skip("A view should be used underlying XM.InvoiceLineTax that does nothing " +
331 "after insert, update or delete (existing table triggers for line items will " +
332 "take care of populating this data correctly)", function () {
333 // TODO: put under test (code is written)
338 @description Represents a line of an invoice. Only ever used within the context of an
340 @property {String} uuid [The ID attribute] ()
341 @property {Number} lineNumber required
342 @property {ItemRelation} item
343 @property {SiteRelation} site defaults to the system default site
344 @property {String} customerPartNumber
345 @property {Boolean} isMiscellaneous false if item number set, true if not.
346 @property {String} itemNumber
347 @property {String} itemDescription
348 @property {SalesCategory} salesCategory
349 @property {Quantity} quantity
350 @property {Unit} quantityUnit
351 @property {Number} quantityUnitRatio
352 @property {Quantity} billed
353 @property {Number} customerPrice
354 @property {SalesPrice} price
355 @property {Unit} priceUnit
356 @property {Number} priceUnitRatio
357 @property {ExtendedPrice} extendedPrice billed * quantityUnitRatio *
358 (price / priceUnitRatio)
359 @property {Number} notes
360 @property {TaxType} taxType
361 @property {Money} taxTotal sum of all taxes
362 @property {InvoiceLineTax} taxes
364 var invoiceLine = it("A nested only model called XM.InvoiceLine extending " +
365 "XM.Model should exist", function () {
367 assert.isFunction(XM.InvoiceLine);
368 lineModel = new XM.InvoiceLine();
369 assert.isTrue(lineModel instanceof XM.Model);
370 assert.equal(lineModel.idAttribute, "uuid");
372 it.skip("InvoiceLine should include attributes x, y, and z", function () {
373 // TODO: put under test (code is written)
377 @memberof InvoiceLine
378 @description InvoiceLine keeps track of the available selling units of measure
379 based on the selected item, in the "sellingUnits" property
381 it("should include a property \"sellingUnits\" that is an array of available selling " +
382 "units of measure based on the selected item", function () {
383 var lineModel = new XM.InvoiceLine();
384 assert.isObject(lineModel.sellingUnits);
388 @memberof InvoiceLine
389 @description When the item is changed the following should be updated from item information:
390 sellingUnits, quantityUnit, quantityUnitRatio, priceUnit, priceUnitRatio, unitCost
391 and taxType. Then, the price should be recalculated.
393 it("XM.InvoiceLine should have a fetchSellingUnits function that updates " +
394 "sellingUnits based on the item selected", function () {
395 assert.isFunction(lineModel.fetchSellingUnits);
397 it("itemDidChange should recalculate sellingUnits, quantityUnit, quantityUnitRatio, " +
398 "priceUnit, priceUnitRatio, " +
399 "and taxType. Also calculatePrice should be executed.", function (done) {
402 assert.equal(lineModel.sellingUnits.length, 0);
403 assert.isNull(lineModel.get("quantityUnit"));
404 assert.isNull(lineModel.get("priceUnit"));
405 assert.isNull(lineModel.get("taxType"));
406 lineModel.set({item: btruck});
408 setTimeout(function () {
409 assert.equal(lineModel.sellingUnits.length, 1);
410 assert.equal(lineModel.sellingUnits.models[0].id, "EA");
411 assert.equal(lineModel.get("quantityUnit").id, "EA");
412 assert.equal(lineModel.get("priceUnit").id, "EA");
413 assert.equal(lineModel.get("priceUnitRatio"), 1);
414 assert.equal(lineModel.get("quantityUnitRatio"), 1);
415 assert.equal(lineModel.get("taxType").id, "Taxable");
417 }, 3000); // TODO: use an event. headache because we have to wait for several
421 @memberof InvoiceLine
422 @description Quantity and billed values can be fractional only if the item allows it
424 it("When the item isFractional attribute === false, decimal numbers should not be allowed " +
425 "for quantity and billed values.", function () {
426 lineModel.set({billed: 1, quantity: 1.5});
427 assert.isObject(lineModel.validate(lineModel.attributes));
428 lineModel.set({quantity: 2});
429 assert.isUndefined(JSON.stringify(lineModel.validate(lineModel.attributes)));
430 lineModel.set({billed: 1.5});
431 assert.isObject(lineModel.validate(lineModel.attributes));
432 lineModel.set({billed: 2});
433 assert.isUndefined(JSON.stringify(lineModel.validate(lineModel.attributes)));
435 it("When the item isFractional attribute === true, decimal numbers should be allowed " +
436 "for quantity values.", function (done) {
437 lineModel.set({item: bpaint, quantity: 1.5});
438 setTimeout(function () {
439 assert.isUndefined(JSON.stringify(lineModel.validate(lineModel.attributes)));
441 }, 1900); // wait for line._isItemFractional to get updated from the item
443 it("When the item isFractional attribute === true, decimal numbers should be allowed " +
444 "for billed values.", function () {
445 lineModel.set({billed: 1.5, quantity: 2});
446 assert.isUndefined(JSON.stringify(lineModel.validate(lineModel.attributes)));
450 @memberof InvoiceLine
451 @description The "ordered" and "billed" amounts must be positive
453 it("Ordered should only allow positive values", function () {
454 lineModel.set({quantity: -1});
455 assert.isObject(lineModel.validate(lineModel.attributes));
456 lineModel.set({quantity: 0});
457 assert.isObject(lineModel.validate(lineModel.attributes));
458 lineModel.set({quantity: 2});
459 assert.isUndefined(JSON.stringify(lineModel.validate(lineModel.attributes)));
461 it("Billed should only allow positive values", function () {
462 lineModel.set({billed: -1});
463 assert.isObject(lineModel.validate(lineModel.attributes));
464 lineModel.set({billed: 0});
465 assert.isObject(lineModel.validate(lineModel.attributes));
466 lineModel.set({billed: 2});
467 assert.isUndefined(JSON.stringify(lineModel.validate(lineModel.attributes)));
471 @memberof InvoiceLine
472 @description When item is unset, all item-related values should be cleared.
474 it("If item is unset, the above values should be cleared.", function (done) {
475 // relies on the fact that the item was set above to something
477 lineModel.set({item: null});
479 setTimeout(function () {
480 assert.equal(lineModel.sellingUnits.length, 0);
481 assert.isNull(lineModel.get("quantityUnit"));
482 assert.isNull(lineModel.get("priceUnit"));
483 assert.isNull(lineModel.get("taxType"));
485 }, 3000); // TODO: use an event. headache because we have to wait for several
489 @memberof InvoiceLine
490 @description User requires the "OverrideTax" privilege to edit the tax type.
492 it.skip("User requires the OverrideTax privilege to edit the tax type", function () {
493 // TODO: write code and put under test
494 //HINT: Default tax type must be enforced by a trigger on the database if no privilege.
497 it("lineNumber must auto-number itself sequentially", function () {
498 var dummyModel = new XM.InvoiceLine();
499 assert.isUndefined(lineModel.get("lineNumber"));
500 invoiceModel.get("lineItems").add(dummyModel);
501 invoiceModel.get("lineItems").add(lineModel);
502 assert.equal(lineModel.get("lineNumber"), 2);
503 invoiceModel.get("lineItems").remove(dummyModel);
504 // TODO: be more thorough
509 @description Currency field should be read only after a line item is added to the invoice
511 it("Currency field should be read-only after a line item is added to the invoice",
513 assert.isTrue(invoiceModel.isReadOnly("currency"));
517 @memberof InvoiceLine
518 @description The user can define a line item as being miscellaneous or not.
519 Miscellaneous means that they can enter a free-form itemNumber, itemDescription,
520 and salesCategory. If the item is not miscellaneous then they must choose
523 it("When isMiscellaneous is false, item is editable and itemNumber, itemDescription " +
524 " and salesCategory are read only", function () {
525 lineModel.set({isMiscellaneous: false});
526 assert.isFalse(lineModel.isReadOnly("item"));
527 assert.isTrue(lineModel.isReadOnly("itemNumber"));
528 assert.isTrue(lineModel.isReadOnly("itemDescription"));
529 assert.isTrue(lineModel.isReadOnly("salesCategory"));
531 it("When isMiscellaneous is true, item is read only and itemNumber, itemDescription " +
532 " and salesCategory are editable.", function () {
533 lineModel.set({isMiscellaneous: true});
534 assert.isTrue(lineModel.isReadOnly("item"));
535 assert.isFalse(lineModel.isReadOnly("itemNumber"));
536 assert.isFalse(lineModel.isReadOnly("itemDescription"));
537 assert.isFalse(lineModel.isReadOnly("salesCategory"));
539 it("If isMiscellaneous === false, then validation makes sure an item is set.", function () {
540 lineModel.set({isMiscellaneous: false, item: null});
541 assert.isObject(lineModel.validate(lineModel.attributes));
542 lineModel.set({item: bpaint});
543 assert.isUndefined(JSON.stringify(lineModel.validate(lineModel.attributes)));
545 it("If isMiscellaneous === true then validation makes sure the itemNumber, " +
546 "itemDescription and salesCategory are set", function () {
547 lineModel.set({isMiscellaneous: true, itemDescription: null});
548 assert.isObject(lineModel.validate(lineModel.attributes));
551 itemDescription: "Paint",
552 salesCategory: new XM.SalesCategory()
554 assert.isUndefined(JSON.stringify(lineModel.validate(lineModel.attributes)));
556 it.skip("XM.InvoiceLine should have a calculatePrice function that retrieves a price from " +
557 "the customer.itemPrice dispatch function based on the billed value.", function () {
558 // TODO: put under test (code is written)
562 describe("XM.InvoiceListItem", function () {
563 // TODO:posting and voiding work, anecdotally. Put it under test.
564 it.skip("XM.InvoiceListItem includes a post function that dispatches a " +
565 "XM.Invoice.post function to the server", function () {
566 var model = new XM.InvoiceListItem();
567 assert.isFunction(model.doPost);
569 model.set({number: "999"});
571 success: function () {
572 console.log("success", arguments);
576 console.log("error", arguments);
581 // this should really be under better test
582 it.skip("XM.InvoiceListItem includes a void function that dispatches a " +
583 "XM.Invoice.void function to the server", function () {
584 var model = new XM.InvoiceListItem();
585 assert.isFunction(model.doVoid);
588 describe("XM.Invoice", function () {
589 before(function (done) {
592 common.fetchModel(ttoys, XM.BillingCustomer, {number: "TTOYS"}, function (err, model) {
598 common.fetchModel(vcol, XM.BillingCustomer, {number: "VCOL"}, function (err, model) {
604 common.fetchModel(nctax, XM.TaxZone, {code: "NC TAX"}, function (err, model) {
610 common.fetchModel(nctaxCode, XM.TaxCode, {code: "NC TAX-A"}, function (err, model) {
616 common.initializeModel(invoiceTaxModel, XM.InvoiceTax, function (err, model) {
617 invoiceTaxModel = model;
622 common.initializeModel(allocationModel, XM.InvoiceAllocation, function (err, model) {
623 allocationModel = model;
631 // Note: the other required fields in taxhist should be populated with the following:
635 // docdate: invoice date
636 // taxtype: 3. Yes, 3.
641 @description Invoice tax adjustments
642 @property {String} uuid ()
643 @property {TaxCode} taxCode
644 @property {Money} amount
646 it("A nested only model called XM.InvoiceTax extending XM.Model should exist", function () {
647 assert.isFunction(XM.InvoiceTax);
648 var invoiceTaxModel = new XM.InvoiceTax(),
649 attrs = ["uuid", "taxCode", "amount"];
651 assert.isTrue(invoiceTaxModel instanceof XM.Model);
652 assert.equal(invoiceTaxModel.idAttribute, "uuid");
653 assert.equal(_.difference(attrs, invoiceTaxModel.getAttributeNames()).length, 0);
658 @description The invoice numbering policy can be determined by the user.
660 it("XM.Invoice should check the setting for InvcNumberGeneration to determine " +
661 "numbering policy", function () {
663 XT.session.settings.set({InvcNumberGeneration: "M"});
664 model = new XM.Invoice();
665 assert.equal(model.numberPolicy, "M");
666 XT.session.settings.set({InvcNumberGeneration: "A"});
667 model = new XM.Invoice();
668 assert.equal(model.numberPolicy, "A");
671 @member InvoiceAllocation
673 @description Invoice-level allocation information
674 @property {String} uuid ()
675 @property {String} invoice [XXX String or Number?]
676 @property {Money} amount
677 @property {Currency} currency
679 it("A nested only model called XM.InvoiceAllocation extending XM.Model " +
680 "should exist", function () {
681 assert.isFunction(XM.InvoiceAllocation);
682 var invoiceAllocationModel = new XM.InvoiceAllocation(),
683 attrs = ["uuid", "invoice", "amount", "currency"];
685 assert.isTrue(invoiceAllocationModel instanceof XM.Model);
686 assert.equal(invoiceAllocationModel.idAttribute, "uuid");
687 assert.equal(_.difference(attrs, invoiceAllocationModel.getAttributeNames()).length, 0);
689 it("XM.InvoiceAllocation should only be updateable by users with the ApplyARMemos " +
690 "privilege.", function () {
691 XT.session.privileges.attributes.ApplyARMemos = false;
692 assert.isFalse(XM.InvoiceAllocation.canCreate());
693 assert.isTrue(XM.InvoiceAllocation.canRead());
694 assert.isFalse(XM.InvoiceAllocation.canUpdate());
695 assert.isFalse(XM.InvoiceAllocation.canDelete());
696 XT.session.privileges.attributes.ApplyARMemos = true;
697 assert.isTrue(XM.InvoiceAllocation.canCreate());
698 assert.isTrue(XM.InvoiceAllocation.canRead());
699 assert.isTrue(XM.InvoiceAllocation.canUpdate());
700 assert.isTrue(XM.InvoiceAllocation.canDelete());
703 @member InvoiceListItem
705 @description List-view summary information for an invoice
706 @property {String} number
707 @property {Boolean} isPrinted [XXX changed from printed]
708 @property {BillingCustomer} customer
709 @property {Date} invoiceDate
710 @property {Money} total
711 @property {Boolean} isPosted
712 @property {Boolean} isVoid
713 @property {String} orderNumber Added by sales extension
715 it("A model called XM.InvoiceListItem extending XM.Info should exist", function () {
716 assert.isFunction(XM.InvoiceListItem);
717 var invoiceListItemModel = new XM.InvoiceListItem(),
718 attrs = ["number", "isPrinted", "customer", "invoiceDate", "total", "isPosted",
719 "isVoid", "orderNumber"];
721 assert.isTrue(invoiceListItemModel instanceof XM.Info);
722 assert.equal(invoiceListItemModel.idAttribute, "number");
723 assert.equal(_.difference(attrs, invoiceListItemModel.getAttributeNames()).length, 0);
725 it("Only users that have ViewMiscInvoices or MaintainMiscInvoices may read " +
726 "XV.InvoiceListItem", function () {
727 XT.session.privileges.attributes.ViewMiscInvoices = false;
728 XT.session.privileges.attributes.MaintainMiscInvoices = false;
729 XT.session.privileges.attributes.ViewPersonalCRMAccounts = false;
730 assert.isFalse(XM.InvoiceListItem.canRead());
732 XT.session.privileges.attributes.ViewMiscInvoices = true;
733 XT.session.privileges.attributes.MaintainMiscInvoices = false;
734 assert.isTrue(XM.InvoiceListItem.canRead());
736 XT.session.privileges.attributes.ViewMiscInvoices = false;
737 XT.session.privileges.attributes.MaintainMiscInvoices = true;
738 assert.isTrue(XM.InvoiceListItem.canRead());
740 XT.session.privileges.attributes.ViewMiscInvoices = true;
741 XT.session.privileges.attributes.ViewPersonalCRMAccounts = true;
743 it("XM.InvoiceListItem is not editable", function () {
744 assert.isFalse(XM.InvoiceListItem.canCreate());
745 assert.isFalse(XM.InvoiceListItem.canUpdate());
746 assert.isFalse(XM.InvoiceListItem.canDelete());
749 @member InvoiceRelation
751 @description Summary information for an invoice
752 @property {String} number
753 @property {CustomerRelation} customer
754 @property {Date} invoiceDate
755 @property {Boolean} isPosted
756 @property {Boolean} isVoid
758 it("A model called XM.InvoiceRelation extending XM.Info should exist with " +
759 "attributes number (the idAttribute) " +
760 "customer, invoiceDate, isPosted, and isVoid", function () {
761 assert.isFunction(XM.InvoiceRelation);
762 var invoiceRelationModel = new XM.InvoiceRelation(),
763 attrs = ["number", "customer", "invoiceDate", "isPosted", "isVoid"];
765 assert.isTrue(invoiceRelationModel instanceof XM.Info);
766 assert.equal(invoiceRelationModel.idAttribute, "number");
767 assert.equal(_.difference(attrs, invoiceRelationModel.getAttributeNames()).length, 0);
770 it("All users with the billing extension may read XV.InvoiceRelation.", function () {
771 assert.isTrue(XM.InvoiceRelation.canRead());
773 it("XM.InvoiceRelation is not editable.", function () {
774 assert.isFalse(XM.InvoiceRelation.canCreate());
775 assert.isFalse(XM.InvoiceRelation.canUpdate());
776 assert.isFalse(XM.InvoiceRelation.canDelete());
781 @description When the customer changes, the billto information should be populated from
782 the customer, along with the salesRep, commission, terms, taxZone, and currency.
783 The billto fields will be read-only if the customer does not allow free-form billto.
785 it("When the customer changes on XM.Invoice, the following customer data should be " +
786 "populated from the customer: billtoName (= customer.name), billtoAddress1, " +
787 "billtoAddress2, billtoAddress3, billtoCity, billtoState, billtoPostalCode, " +
788 "billtoCountry should be populated by customer.billingContact.address." +
789 "salesRep, commission, terms, taxZone, currency, billtoPhone " +
790 "(= customer.billingContact.phone)", function () {
791 assert.isUndefined(invoiceModel.get("billtoName"));
792 invoiceModel.set({customer: ttoys});
793 assert.equal(invoiceModel.get("billtoName"), "Tremendous Toys Incorporated");
794 assert.equal(invoiceModel.get("billtoAddress2"), "101 Toys Place");
795 assert.equal(invoiceModel.get("billtoPhone"), "703-931-4269");
796 assert.isString(invoiceModel.getValue("salesRep.number"),
797 ttoys.getValue("salesRep.number"));
798 assert.equal(invoiceModel.getValue("commission"), 0.075);
799 assert.equal(invoiceModel.getValue("terms.code"), "2-10N30");
800 assert.equal(invoiceModel.getValue("taxZone.code"), "VA TAX");
801 assert.equal(invoiceModel.getValue("currency.abbreviation"), "USD");
803 it("The following fields will be set to read only if the customer does not allow " +
804 "free form billto: billtoName, billtoAddress1, billtoAddress2, billtoAddress3, " +
805 "billtoCity, billtoState, billtoPostalCode, billtoCountry, billtoPhone", function () {
806 assert.isFalse(invoiceModel.isReadOnly("billtoName"), "TTOYS Name");
807 assert.isFalse(invoiceModel.isReadOnly("billtoAddress3"), "TTOYS Address3");
808 assert.isFalse(invoiceModel.isReadOnly("billtoPhone"), "TTOYS Phone");
809 invoiceModel.set({customer: vcol});
810 assert.isTrue(invoiceModel.isReadOnly("billtoName"), "VCOL Name");
811 assert.isTrue(invoiceModel.isReadOnly("billtoAddress3"), "VCOL Address3");
812 assert.isTrue(invoiceModel.isReadOnly("billtoPhone"), "VCOL Phone");
814 it("If the customer attribute is empty, the above fields should be unset.", function () {
815 assert.isString(invoiceModel.get("billtoName"));
816 invoiceModel.set({customer: null});
817 assert.isUndefined(invoiceModel.get("billtoName"));
818 assert.isUndefined(invoiceModel.get("billtoAddress2"));
819 assert.isUndefined(invoiceModel.get("billtoPhone"));
820 assert.isNull(invoiceModel.get("salesRep"));
821 assert.isNull(invoiceModel.get("terms"));
822 assert.isNull(invoiceModel.get("taxZone"));
823 assert.isNull(invoiceModel.get("currency"));
827 @memberof InvoiceLine
828 @description The price will be recalculated when the units change.
830 it("If the quantityUnit or priceUnit are changed, \"calculatePrice\" should be " +
831 "run.", function (done) {
832 invoiceModel.set({customer: ttoys});
833 assert.isUndefined(lineModel.get("price"));
834 lineModel.set({item: btruck});
835 lineModel.set({billed: 10});
836 setTimeout(function () {
837 assert.equal(lineModel.get("price"), 9.8910);
843 @memberof InvoiceLine
844 @description If price or billing change, extendedPrice should be recalculated.
846 it("If price or billing change, extendedPrice should be recalculated.", function () {
847 assert.equal(lineModel.get("extendedPrice"), 98.91);
851 @memberof InvoiceLine
852 @description When billed is changed extendedPrice should be recalculated.
854 it("When billed is changed extendedPrice should be recalculated", function (done) {
855 lineModel.set({billed: 20});
856 setTimeout(function () {
857 assert.equal(lineModel.get("extendedPrice"), 197.82);
864 @description When currency or invoice date is changed outstanding credit should be
867 it.("When currency or invoice date is changed outstanding credit should be recalculated",
871 var outstandingCreditChanged = function () {
872 if (invoiceModel.get("outstandingCredit")) {
873 // second time, with valid currency
874 invoiceModel.off("change:outstandingCredit", outstandingCreditChanged);
875 assert.equal(invoiceModel.get("outstandingCredit"), 25250303.25);
878 // first time, with invalid currency
879 invoiceModel.set({currency: usd});
883 invoiceModel.on("change:outstandingCredit", outstandingCreditChanged);
884 invoiceModel.set({currency: null});
889 @description AllocatedCredit should be recalculated when XM.InvoiceAllocation records
890 are added or removed.
892 it("AllocatedCredit should be recalculated when XM.InvoiceAllocation records " +
893 "are added or removed", function () {
894 assert.isUndefined(invoiceModel.get("allocatedCredit"));
895 allocationModel.set({currency: usd, amount: 200});
896 invoiceModel.get("allocations").add(allocationModel);
897 assert.equal(invoiceModel.get("allocatedCredit"), 200);
902 @description When invoice date is changed allocated credit should be recalculated.
904 it("When the invoice date is changed allocated credit should be recalculated", function () {
905 allocationModel.set({currency: usd, amount: 300});
906 assert.equal(invoiceModel.get("allocatedCredit"), 200);
907 // XXX This is a wacky way to test this.
908 // XXX Shouldn't the change to the allocated credit itself trigger a change
909 //to allocatedCredit?
910 invoiceModel.set({invoiceDate: new Date("1/1/2010")});
911 assert.equal(invoiceModel.get("allocatedCredit"), 300);
916 @description When subtotal, totalTax or miscCharge are changed, the total
917 should be recalculated.
919 it("When subtotal, totalTax or miscCharge are changed, the total should be recalculated",
921 assert.equal(invoiceModel.get("total"), 207.71);
922 invoiceModel.set({miscCharge: 40});
923 assert.equal(invoiceModel.get("total"), 247.71);
928 @description TotalTax should be recalculated when taxZone changes or
929 taxAdjustments are added or removed.
931 it("TotalTax should be recalculated when taxZone changes.", function (done) {
932 var totalChanged = function () {
933 invoiceModel.off("change:total", totalChanged);
934 assert.equal(invoiceModel.get("taxTotal"), 10.88);
935 assert.equal(invoiceModel.get("total"), 248.70);
939 assert.equal(invoiceModel.get("taxTotal"), 9.89);
940 invoiceModel.on("change:total", totalChanged);
941 invoiceModel.set({taxZone: nctax});
943 it("TotalTax should be recalculated when taxAdjustments are added or removed.",
945 var totalChanged = function () {
946 invoiceModel.off("change:total", totalChanged);
947 assert.equal(invoiceModel.get("taxTotal"), 20.88);
948 assert.equal(invoiceModel.get("total"), 258.70);
952 invoiceTaxModel.set({taxCode: nctaxCode, amount: 10.00});
953 invoiceModel.on("change:total", totalChanged);
954 invoiceModel.get("taxAdjustments").add(invoiceTaxModel);
956 it("The document date of the tax adjustment should be the invoice date.",
958 assert.equal(invoiceModel.get("invoiceDate"), invoiceTaxModel.get("documentDate"));
963 @description When an invoice is loaded where "isPosted" is true, then the following
964 attributes will be made read only:
965 lineItems, number, invoiceDate, terms, salesrep, commission, taxZone, saleType
967 it("When an invoice is loaded where isPosted is true, then the following " +
968 "attributes will be made read only: lineItems, number, invoiceDate, terms, " +
969 "salesrep, commission, taxZone, saleType", function (done) {
970 var postedInvoice = new XM.Invoice(),
971 statusChanged = function () {
972 if (postedInvoice.isReady()) {
973 postedInvoice.off("statusChange", statusChanged);
974 assert.isTrue(postedInvoice.isReadOnly("lineItems"));
975 assert.isTrue(postedInvoice.isReadOnly("number"));
976 assert.isTrue(postedInvoice.isReadOnly("invoiceDate"));
977 assert.isTrue(postedInvoice.isReadOnly("terms"));
978 assert.isTrue(postedInvoice.isReadOnly("salesRep"));
979 assert.isTrue(postedInvoice.isReadOnly("commission"));
980 assert.isTrue(postedInvoice.isReadOnly("taxZone"));
981 assert.isTrue(postedInvoice.isReadOnly("saleType"));
986 postedInvoice.on("statusChange", statusChanged);
987 postedInvoice.fetch({number: "60004"});
992 @description Balance should be recalculated when total, allocatedCredit, or
993 outstandingCredit are changed.
995 it("Balance should be recalculated when total, allocatedCredit, or outstandingCredit " +
996 "are changed", function () {
997 assert.equal(invoiceModel.get("balance"), 0);
1002 @description When allocatedCredit or lineItems exist, currency should become read only.
1004 it("When allocatedCredit or lineItems exist, currency should become read only.", function () {
1005 assert.isTrue(invoiceModel.isReadOnly("currency"));
1010 @description To save, the invoice total must not be less than zero and there must be
1011 at least one line item.
1013 it("Save validation: The total must not be less than zero", function () {
1014 invoiceModel.set({customer: ttoys, number: "98765"});
1015 assert.isUndefined(JSON.stringify(invoiceModel.validate(invoiceModel.attributes)));
1016 invoiceModel.set({total: -1});
1017 assert.isObject(invoiceModel.validate(invoiceModel.attributes));
1018 invoiceModel.set({total: 1});
1019 assert.isUndefined(JSON.stringify(invoiceModel.validate(invoiceModel.attributes)));
1021 it("Save validation: There must be at least one line item.", function () {
1022 var lineItems = invoiceModel.get("lineItems");
1023 assert.isUndefined(JSON.stringify(invoiceModel.validate(invoiceModel.attributes)));
1024 lineItems.remove(lineItems.at(0));
1025 assert.isObject(invoiceModel.validate(invoiceModel.attributes));
1028 it("XM.Invoice includes a function calculateAuthorizedCredit", function (done) {
1029 // TODO test more thoroughly
1031 > Makes a call to the server requesting the total authorized credit for a given
1032 - sales order number
1033 - in the invoice currency
1034 - using the invoice date for exchange rate conversion.
1035 > Authorized credit should only include authoriztions inside the "CCValidDays" window,
1036 or 7 days if no CCValidDays is set, relative to the current date.
1037 > The result should be set on the authorizedCredit attribute
1038 > On response, recalculate the balance (HINT#: Do not attempt to use bindings for this!)
1040 assert.isFunction(invoiceModel.calculateAuthorizedCredit);
1041 invoiceModel.calculateAuthorizedCredit();
1042 setTimeout(function () {
1043 assert.equal(invoiceModel.get("authorizedCredit"), 0);
1051 @description Invoice includes a function "calculateTax" that
1052 Gathers line item, freight and adjustments
1053 Groups by and sums and rounds to XT.MONEY_SCALE for each tax code
1054 Sums the sum of each tax code and sets totalTax to the result
1056 it.skip("has a calculateTax function that works correctly", function () {
1057 // TODO: put under test
1061 it.skip("When a customer with non-base currency is selected the following values " +
1062 "should be displayed in the foreign currency along with the values in base currency " +
1063 " - Unit price, Extended price, Allocated Credit, Authorized Credit, Margin, " +
1064 "Subtotal, Misc. Charge, Freight, Total, Balance", function () {
1066 // TODO: put under test (requires postbooks demo to have currency conversion)
1071 describe("Invoice List View", function () {
1075 @description Users can perform the following actions from the list: Delete unposted
1076 invoices where the user has the MaintainMiscInvoices privilege, Post unposted
1077 invoices where the user has the "PostMiscInvoices" privilege, Void posted invoices
1078 where the user has the "VoidPostedInvoices" privilege, Print invoice forms where
1079 the user has the "PrintInvoices" privilege.
1081 it("Delete unposted invoices where the user has the MaintainMiscInvoices privilege",
1083 var model = new XM.InvoiceListItem();
1084 model.couldDestroy(function (response) {
1085 assert.isTrue(response);
1089 it("Cannot delete invoices that are already posted", function (done) {
1090 var model = new XM.InvoiceListItem();
1091 model.set({isPosted: true});
1092 XT.session.privileges.attributes.MaintainMiscInvoices = true;
1093 model.couldDestroy(function (response) {
1094 assert.isFalse(response);
1098 it("Post unposted invoices where the user has the PostMiscInvoices privilege",
1100 var model = new XM.InvoiceListItem();
1101 model.canPost(function (response) {
1102 assert.isTrue(response);
1106 it("Cannot post invoices that are already posted", function (done) {
1107 var model = new XM.InvoiceListItem();
1108 model.set({isPosted: true});
1109 XT.session.privileges.attributes.PostMiscInvoices = true;
1110 model.canPost(function (response) {
1111 assert.isFalse(response);
1115 it("Void posted invoices where the user has the VoidPostedInvoices privilege",
1117 var model = new XM.InvoiceListItem();
1118 model.set({isPosted: true});
1119 XT.session.privileges.attributes.VoidPostedInvoices = true;
1120 model.canVoid(function (response) {
1121 assert.isTrue(response);
1125 it("Cannot void invoices that are not already posted", function (done) {
1126 var model = new XM.InvoiceListItem();
1127 model.set({isPosted: false});
1128 XT.session.privileges.attributes.VoidPostedInvoices = true;
1129 model.canVoid(function (response) {
1130 assert.isFalse(response);
1137 @description The invoice list should support multiple selections
1139 it("The invoice list should support multiple selections", function () {
1140 var list = new XV.InvoiceList();
1141 assert.isTrue(list.getMultiSelect());
1142 // XXX it looks like trying to delete multiple items at once only deletes the first
1144 it("The invoice list has a parameter widget", function () {
1146 * The invoice list should use a parameter widget that has the following options:
1150 - Unposted - checked by default
1151 - Posted - unchecked by default
1152 - Voided - unchecked by default
1156 - Type Pattern (text)
1162 var list = new XV.InvoiceList();
1163 assert.isString(list.getParameterWidget());
1168 @description The InvoiceList should be printable
1170 it("XV.InvoiceList should be printable", function () {
1171 var list = new XV.InvoiceList(),
1172 actions = list.actions;
1173 assert.include(_.pluck(actions, 'name'), 'print');
1174 assert.include(_.pluck(actions, 'name'), 'email');
1178 describe("Invoice workspace", function () {
1179 it("Has a customer relation model that's mapped correctly", function () {
1180 // TODO: generalize this into a relation widget test that's run against
1181 // every relation widget in the app.
1182 var workspace = new XV.InvoiceWorkspace();
1183 var widgetAttr = workspace.$.customerWidget.attr;
1184 var attrModel = _.find(XT.session.schemas.XM.attributes.Invoice.relations,
1185 function (relation) {
1186 return relation.key === widgetAttr;
1188 var widgetModel = XT.getObjectByName(workspace.$.customerWidget.getCollection())
1189 .prototype.model.prototype.recordType;
1190 assert.equal(attrModel, widgetModel);
1195 @description The InvoiceWorkspace should be printable
1197 it("XV.InvoiceWorkspace should be printable", function () {
1198 var workspace = new XV.InvoiceWorkspace(),
1199 actions = workspace.actions;
1200 assert.include(_.pluck(actions, 'name'), 'print');
1201 assert.include(_.pluck(actions, 'name'), 'email');
1206 @description Supports grid-entry of line items on desktop browsers.
1208 it("Should include line items views where a grid box is used for non-touch devices " +
1209 "and a list relation editor for touch devices.", function () {
1212 enyo.platform.touch = true;
1213 workspace = new XV.InvoiceWorkspace();
1214 assert.equal(workspace.$.lineItemBox.kind, "XV.InvoiceLineItemBox");
1215 enyo.platform.touch = false;
1216 workspace = new XV.InvoiceWorkspace();
1217 assert.equal(workspace.$.lineItemBox.kind, "XV.InvoiceLineItemGridBox");
1222 @description The bill to addresses available when searching addresses should filter
1223 on the addresses associated with the customer's account record by default.
1225 it.skip("The bill to addresses available when searching addresses should filter " +
1226 "on the addresses associated with the customer's account record by default.",
1228 // TODO: put under test
1234 @description The customer search list should search only on active customers.
1236 it.skip("The customer search list should search only on active customers", function () {
1237 // TODO: put under test
1243 @description A child workspace view should exist called XV.InvoiceLineWorkspace
1244 should include: all the attributes on XM.InvoiceLine, item cost and item list
1245 price values, and a read only panel that displays a group box of lists of taxes.
1247 it.skip("The invoiceLine child workspace", function () {
1248 // TODO: put under test
1252 describe("Sales Extension", function () {
1256 @description If the sales extension is installed you can link invoices to sales orders
1258 it("XM.InvoiceSalesOrder", function () {
1259 assert.isFunction(XM.InvoiceSalesOrder);
1260 assert.isTrue(XM.InvoiceSalesOrder.prototype.isDocumentAssignment);
1265 @description Invoice will include authorizedCredit, the sum of credit card authorizations
1266 in the order currency where:
1267 - The current_timestamp - authorization date is less than CCValidDays || 7
1268 - The payment status the cc payment (ccpay) record is authorized ("A")
1269 - The cc payment record is for an order number = the order number specified on
1271 When currency or invoice date is changed authorized credit should be recalculated.
1273 it("authorizedCredit", function () {
1274 // TODO: better testing
1275 assert.equal(invoiceModel.get("authorizedCredit"), 0);
1280 @description sales extension order date defaults to today
1282 it("Sales extension order date default today", function () {
1283 assert.equal(invoiceModel.get("orderDate").getDate(), new Date().getDate());
1286 describe("Project extension", function () {
1290 @description If the project extension is installed you can link invoices to projects
1292 it("XM.InvoiceProject", function () {
1293 assert.isFunction(XM.InvoiceProject);
1294 assert.isTrue(XM.InvoiceProject.prototype.isDocumentAssignment);
1299 @description The project attribute will be read-only for posted invoices
1301 it.skip("project is read-only for posted invoices", function () {
1302 // TODO: put under test
1308 @description The project widget will be added to the invoice workspace if the
1309 UseProjects setting is true.
1311 it.skip("Add the project widget to the invoice workspace if the UseProjects setting is true.",
1313 // TODO: put under test
1319 exports.spec = spec;
1320 exports.additionalTests = additionalTests;
1324 ***** CHANGES MADE BY MANUFACTURING EXTENSION ******
1326 * A nested only model should be created according to convention for many-to-many document
1328 > XM.InvoiceWorkOrder
1330 * Modify XM.Invoice to include:
1331 > InvoiceWorkOrder "workOrders"
1333 **** OTHER NOTES ****
1335 The following will not be implemented on this pass
1336 > Recurring invoices
1337 > Ledger functionality
1338 > Site level privelege checking