@fcgs/filerr-nach/lib/batch/index.js

nACH is a highly customizable Node.js module exposing a high & low-level API for generating ACH files for use within the ACH network

// Batch
var moment = require('moment');
var _ = require('lodash');
var async = require('async');
var utils = require('./../utils');
var validate = require('./../validate');

var highLevelHeaderOverrides = ['serviceClassCode', 'companyDiscretionaryData', 'companyIdentification', 'standardEntryClassCode'];
var highLevelControlOverrides = ['addendaCount', 'entryHash', 'totalDebit', 'totalCredit'];

function Batch(options, autoValidate) {
  this._entries = [];

  // Allow the batch header/control defaults to be overriden if provided
  this.header = options.header ? _.merge(options.header, require('./header'), _.defaults) : _.cloneDeep(require('./header'));
  this.control = options.control ? _.merge(options.header, require('./control'), _.defaults) : _.cloneDeep(require('./control'));

  // Configure high-level overrides (these override the low-level settings if provided)
  utils.overrideLowLevel(highLevelHeaderOverrides, options, this);
  utils.overrideLowLevel(highLevelControlOverrides, options, this);

  if (autoValidate !== false) {
    // Validate the routing number (ABA) before slicing
    validate.validateRoutingNumber(utils.computeCheckDigit(options.originatingDFI));
  }

  if (options.companyName) {
    this.header.companyName.value = options.companyName.slice(0, this.header.companyName.width);
  }

  if (options.companyEntryDescription) {
    this.header.companyEntryDescription.value = options.companyEntryDescription.slice(0, this.header.companyEntryDescription.width);
  }

  if (options.companyDescriptiveDate) {
    this.header.companyDescriptiveDate.value = options.companyDescriptiveDate.slice(0, this.header.companyDescriptiveDate.width);
  }

  if (options.effectiveEntryDate) {
    if (typeof options.effectiveEntryDate == 'string') {
      options.effectiveEntryDate = moment(options.effectiveEntryDate, 'YYMMDD').toDate();
    }
    this.header.effectiveEntryDate.value = utils.formatDate(options.effectiveEntryDate);
  }

  if (options.originatingDFI) {
    this.header.originatingDFI.value = utils.computeCheckDigit(options.originatingDFI).slice(0, this.header.originatingDFI.width);
  }

  // Set control values which use the same header values
  this.control.serviceClassCode.value = this.header.serviceClassCode.value;
  this.control.companyIdentification.value = this.header.companyIdentification.value;
  this.control.originatingDFI.value = this.header.originatingDFI.value;

  if (autoValidate !== false) {
    // Perform validation on all the passed values
    this._validate();
  }

  return this;
};

Batch.prototype._validate = function() {

  // Validate required fields have been passed
  validate.validateRequiredFields(this.header);

  // Validate the batch's ACH service class code
  validate.validateACHServiceClassCode(this.header.serviceClassCode.value);

  // Validate field lengths
  validate.validateLengths(this.header);

  // Validate datatypes
  validate.validateDataTypes(this.header);

  // Validate required fields have been passed
  validate.validateRequiredFields(this.control);

  // Validate field lengths
  validate.validateLengths(this.control);

  // Validate datatypes
  validate.validateDataTypes(this.control);
};

Batch.prototype.addEntry = function(entry) {
  var self = this;

  // Increment the addendaCount of the batch
  this.control.addendaCount.value += entry.getRecordCount();

  // Add the new entry to the entries array
  this._entries.push(entry);

  // Update the batch values like total debit and credit $ amounts
  var entryHash = 0;
  var totalDebit = 0;
  var totalCredit = 0;

  // (22, 23, 24, 27, 28, 29, 32, 33, 34, 37, 38 & 39)
  var creditCodes = ['22', '23', '24', '32', '33', '34'];
  var debitCodes = ['27', '28', '29', '37', '38', '39'];

  async.each(this._entries, function(entry, done) {
    entryHash += Number(entry.fields.receivingDFI.value);

    if (_.includes(creditCodes, entry.fields.transactionCode.value)) {
      totalCredit += entry.fields.amount.value;
      done();
    } else if (_.includes(debitCodes, entry.fields.transactionCode.value)) {
      totalDebit += entry.fields.amount.value;
      done();
    } else {
      console.log('Transaction codes did not match or are not supported yet (unsupported status codes include: 23, 24, 28, 29, 33, 34, 38, 39)');
    }
  }, function(err) {
    self.control.totalCredit.value = totalCredit;
    self.control.totalDebit.value = totalDebit;

    // Add up the positions 4-11 and compute the total. Slice the 10 rightmost digits.
    self.control.entryHash.value = entryHash.toString().slice(-10);
  });
};

Batch.prototype.getEntries = function() {
  return this._entries;
}

Batch.prototype.generateHeader = function(cb) {
  utils.generateString(this.header, function(string) {
    cb(string);
  });
};

Batch.prototype.generateControl = function(cb) {
  utils.generateString(this.control, function(string) {
    cb(string);
  });
};

Batch.prototype.generateEntries = function(cb) {
  var result = '';

  async.each(this._entries, function(entry, done) {
    entry.generateString(function(string) {
      result += string + utils.newLineChar();
      done();
    });
  }, function(err) {
    cb(result);
  });
};

Batch.prototype.generateString = function(cb) {
  var self = this;

  self.generateHeader(function(headerString) {
    self.generateEntries(function(entryString) {
      self.generateControl(function(controlString) {
        cb(headerString + utils.newLineChar() + entryString + controlString);
      });
    });
  });
};

Batch.prototype.get = function(field) {

  // If the header has the field, return the value
  if (this.header[field]) {
    return this.header[field]['value'];
  }

  // If the control has the field, return the value
  if (this.control[field]) {
    return this.control[field]['value'];
  }
};

Batch.prototype.set = function(field, value) {

  // If the header has the field, set the value
  if (this.header[field]) {
    this.header[field]['value'] = value;
  }

  // If the control has the field, set the value
  if (this.control[field]) {
    this.control[field]['value'] = value;
  }
};

module.exports = Batch;