advFileControl.go

// Licensed to The Moov Authors under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. The Moov Authors licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

package ach

import (
	"unicode/utf8"
)

// ADVFileControl record contains entry counts, dollar totals and hash
// totals accumulated from each batchADV control record in the file.
type ADVFileControl struct {
	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
	ID string `json:"id"`

	// BatchCount total number of batches (i.e., '5' records) in the file
	BatchCount int `json:"batchCount"`

	// BlockCount total number of records in the file (include all headers and trailer) divided
	// by 10 (This number must be evenly divisible by 10. If not, additional records consisting of all 9's are added to the file after the initial '9' record to fill out the block 10.)
	BlockCount int `json:"blockCount,omitempty"`

	// EntryAddendaCount total detail and addenda records in the file
	EntryAddendaCount int `json:"entryAddendaCount"`

	// EntryHash calculated in the same manner as the batch has total but includes total from entire file
	EntryHash int `json:"entryHash"`

	// TotalDebitEntryDollarAmountInFile contains accumulated Batch debit totals within the file.
	TotalDebitEntryDollarAmountInFile int `json:"totalDebit"`

	// TotalCreditEntryDollarAmountInFile contains accumulated Batch credit totals within the file.
	TotalCreditEntryDollarAmountInFile int `json:"totalCredit"`

	// Line number at which the record appears in the file
	LineNumber int `json:"lineNumber,omitempty"`

	// validator is composed for data validation
	validator
	// converters is composed for ACH to golang Converters
	converters
}

// Parse takes the input record string and parses the FileControl values
// Parse provides no guarantee about all fields being filled in. Callers should make a Validate call to confirm
// successful parsing and data validity.
func (fc *ADVFileControl) Parse(record string) {
	if utf8.RuneCountInString(record) < 71 {
		return
	}
	runes := []rune(record)

	// 1-1 Always "9"
	// 2-7 The total number of Batch Header Record in the file. For example: "000003
	fc.BatchCount = fc.parseNumField(string(runes[1:7]))
	// 8-13 e total number of blocks on the file, including the File Header and File Control records. One block is 10 lines, so it's effectively the number of lines in the file divided by 10.
	fc.BlockCount = fc.parseNumField(string(runes[7:13]))
	// 14-21 Total number of Entry Detail Record in the file
	fc.EntryAddendaCount = fc.parseNumField(string(runes[13:21]))
	// 22-31 Total of all positions 4-11 on each Entry Detail Record in the file. This is essentially the sum of all the RDFI routing numbers in the file.
	// If the sum exceeds 10 digits (because you have lots of Entry Detail Records), lop off the most significant digits of the sum until there are only 10
	fc.EntryHash = fc.parseNumField(string(runes[21:31]))
	// 32-51 Number of cents of debit entries within the file
	fc.TotalDebitEntryDollarAmountInFile = fc.parseNumField(string(runes[31:51]))
	// 52-71 Number of cents of credit entries within the file
	fc.TotalCreditEntryDollarAmountInFile = fc.parseNumField(string(runes[51:71]))
	// 72-94 Reserved Always blank (just fill with spaces)
}

// NewADVFileControl returns a new ADVFileControl with default values for none exported fields
func NewADVFileControl() ADVFileControl {
	return ADVFileControl{}
}

// String writes the ADVFileControl struct to a 94 character string.
func (fc *ADVFileControl) String() string {
	buf := getBuffer()
	defer saveBuffer(buf)

	buf.WriteString(fileControlPos)
	buf.WriteString(fc.BatchCountField())
	buf.WriteString(fc.BlockCountField())
	buf.WriteString(fc.EntryAddendaCountField())
	buf.WriteString(fc.EntryHashField())
	buf.WriteString(fc.TotalDebitEntryDollarAmountInFileField())
	buf.WriteString(fc.TotalCreditEntryDollarAmountInFileField())
	buf.WriteString("                       ")

	return buf.String()
}

// Validate performs NACHA format rule checks on the record and returns an error if not Validated
// The first error encountered is returned and stops that parsing.
func (fc *ADVFileControl) Validate() error {
	if err := fc.fieldInclusion(); err != nil {
		return err
	}
	return nil
}

// fieldInclusion validate mandatory fields are not default values. If fields are
// invalid the ACH transfer will be returned.
func (fc *ADVFileControl) fieldInclusion() error {
	if fc.BatchCount == 0 {
		return fieldError("BatchCount", ErrConstructor, fc.BatchCountField())
	}
	if fc.BlockCount == 0 {
		return fieldError("BlockCount", ErrConstructor, fc.BlockCountField())
	}
	if fc.EntryAddendaCount == 0 {
		return fieldError("EntryAddendaCount", ErrConstructor, fc.EntryAddendaCountField())
	}
	if fc.EntryHash == 0 {
		return fieldError("EntryHash", ErrConstructor, fc.EntryHashField())
	}
	return nil
}

// BatchCountField gets a string of the batch count zero padded
func (fc *ADVFileControl) BatchCountField() string {
	return fc.numericField(fc.BatchCount, 6)
}

// BlockCountField gets a string of the block count zero padded
func (fc *ADVFileControl) BlockCountField() string {
	return fc.numericField(fc.BlockCount, 6)
}

// EntryAddendaCountField gets a string of entry addenda batch count zero padded
func (fc *ADVFileControl) EntryAddendaCountField() string {
	return fc.numericField(fc.EntryAddendaCount, 8)
}

// EntryHashField gets a string of entry hash zero padded
func (fc *ADVFileControl) EntryHashField() string {
	return fc.numericField(fc.EntryHash, 10)
}

// TotalDebitEntryDollarAmountInFileField get a zero padded Total debit Entry Amount
func (fc *ADVFileControl) TotalDebitEntryDollarAmountInFileField() string {
	return fc.numericField(fc.TotalDebitEntryDollarAmountInFile, 20)
}

// TotalCreditEntryDollarAmountInFileField get a zero padded Total credit Entry Amount
func (fc *ADVFileControl) TotalCreditEntryDollarAmountInFileField() string {
	return fc.numericField(fc.TotalCreditEntryDollarAmountInFile, 20)
}