feat: adjustment invoice

README.md

@@ -136,6 +136,7 @@ let invoice = new Invoice({
   buyer: buyer, // the buyer, required
   items: [ soldItem1, soldItem2 ], // the sold items, required
   prepaymentInvoice: false // prepayment/deposit invoice should be issued, optional, default: false
+  adjustmentInvoiceNumber: 'ORIGINAL-INVOICE-NUMBER', // optional, only required for creating a correcting invoice
 })
 ```
 

lib/Invoice.js

@@ -33,6 +33,7 @@ export class Invoice {
     this._options.paid = options.paid
     this._options.comment = options.comment
     this._options.logoImage = options.logoImage
+    this._options.adjustmentInvoiceNumber = options.adjustmentInvoiceNumber
     this._options.prepaymentInvoice = options.prepaymentInvoice || false
   }
 
@@ -66,6 +67,13 @@ export class Invoice {
     assert(Array.isArray(this._options.items),
       'Valid Items array missing from invoice options')
 
+
+  if (this._options.adjustmentInvoiceNumber !== null && this._options.adjustmentInvoiceNumber !== undefined) {
+    assert(typeof this._options.adjustmentInvoiceNumber === 'string', '"adjustmentInvoiceNumber" should be a string')
+    assert(this._options.adjustmentInvoiceNumber.length > 0, '"adjustmentInvoiceNumber" should be minimum 1 character')
+    this._options.adjustmentInvoice = true
+  }
+
     let o = wrapWithElement('fejlec', [
       [ 'keltDatum', this._options.issueDate ],
       [ 'teljesitesDatum', this._options.fulfillmentDate ],
@@ -78,6 +86,8 @@ export class Invoice {
       [ 'arfolyam', this._options.exchangeRate ],
       [ 'rendelesSzam', this._options.orderNumber ],
       [ 'elolegszamla', this._options.prepaymentInvoice ],
+      [ 'helyesbitoszamla', this._options.adjustmentInvoice ],
+      [ 'helyesbitettSzamlaszam', this._options.adjustmentInvoiceNumber ],
       [ 'dijbekero', this._options.proforma ],
       [ 'logoExtra', this._options.logoImage ],
       [ 'szamlaszamElotag', this._options.invoiceIdPrefix ],

tests/invoice.spec.js

@@ -72,6 +72,60 @@ describe('Invoice', function () {
       it('should have `tetelek` node', function () {
         expect(obj).to.have.property('tetelek')
       })
-    })
-  })
-})
+
+      // START- New test suite for adjustmentInvoiceNumber property
+      describe('adjustmentInvoiceNumber validation', function () {
+        it('should not include adjustmentInvoiceNumber when it is null', function (done) {
+          invoice._options.adjustmentInvoiceNumber = null;
+          parser.parseString('<wrapper>' + invoice._generateXML() + '</wrapper>', function (err, result) {
+            expect(result.wrapper).to.not.have.deep.property('fejlec.helyesbitettSzamlaszam');
+            done();
+          });
+        });
+
+        it('should not include adjustmentInvoiceNumber when it is undefined', function (done) {
+          delete invoice._options.adjustmentInvoiceNumber;
+          parser.parseString('<wrapper>' + invoice._generateXML() + '</wrapper>', function (err, result) {
+            expect(result.wrapper).to.not.have.deep.property('fejlec.helyesbitettSzamlaszam');
+            done();
+          });
+        });
+
+        it('should throw an error when adjustmentInvoiceNumber is an empty string', function () {
+          expect(() => {
+            invoice._options.adjustmentInvoiceNumber = '';
+            invoice._generateXML();
+          }).to.throw();
+        });
+
+        it('should throw an error when adjustmentInvoiceNumber is not a string', function () {
+          const invalidTypes = [new Date(), 123, true];
+          invalidTypes.forEach(type => {
+            expect(() => {
+              invoice._options.adjustmentInvoiceNumber = type;
+              invoice._generateXML();
+            }).to.throw();
+          });
+        });
+
+        it('should not throw an error when adjustmentInvoiceNumber is a non-empty string', function () {
+          expect(() => {
+          invoice._options.adjustmentInvoiceNumber = '12345';
+          invoice._generateXML();
+          }).to.not.throw();
+          });
+
+        it('should include adjustmentInvoiceNumber when it is a non-empty string', function (done) {
+          invoice._options.adjustmentInvoiceNumber = '12345';
+          parser.parseString('<wrapper>' + invoice._generateXML() + '</wrapper>', function (err, result) {
+          expect(result.wrapper.fejlec[0].helyesbitettSzamlaszam[0]).to.equal('12345');
+          done();
+          });
+        });
+
+      });
+      // END - New test suite for adjustmentInvoiceNumber property
+
+    });
+  });
+});