fix: validate amounts in non-prenote entries

adamdecaf · adamdecaf · commit 8c0ba87b24e9 · 2023-02-13T08:45:48.000-06:00
Fixes: #1168
diff --git a/batch.go b/batch.go
@@ -1011,6 +1011,25 @@ func (batch *Batch) IsADV() bool {
 	return ok
 }
 
+func (batch *Batch) ValidAmountForCodes(entry *EntryDetail) error {
+	if entry != nil && entry.Addenda98 != nil {
+		// NOC entries will have a zero'd amount value
+		return nil
+	}
+	isPrenote := entry.isPrenote(entry.TransactionCode)
+	if isPrenote {
+		if entry.Amount == 0 {
+			return nil
+		}
+		return fieldError("Amount", ErrBatchAmountNonZero, entry.Amount)
+	} else {
+		if entry.Amount == 0 {
+			return fieldError("Amount", ErrBatchAmountZero, entry.Amount)
+		}
+	}
+	return nil
+}
+
 // ValidTranCodeForServiceClassCode validates a TransactionCode is valid for a ServiceClassCode
 func (batch *Batch) ValidTranCodeForServiceClassCode(entry *EntryDetail) error {
 	// ADV should use ADVEntryDetail
diff --git a/batchACK.go b/batchACK.go
@@ -60,6 +60,10 @@ func (batch *BatchACK) Validate() error {
 		default:
 			return batch.Error("TransactionCode", ErrBatchTransactionCode, entry.TransactionCode)
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchARC.go b/batchARC.go
@@ -79,6 +79,10 @@ func (batch *BatchARC) Validate() error {
 		if entry.IdentificationNumber == "" {
 			return batch.Error("CheckSerialNumber", ErrBatchCheckSerialNumber)
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchATX.go b/batchATX.go
@@ -77,6 +77,10 @@ func (batch *BatchATX) Validate() error {
 		if len(entry.Addenda05) != addendaRecords {
 			return batch.Error("AddendaCount", NewErrBatchExpectedAddendaCount(len(entry.Addenda05), addendaRecords))
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchBOC.go b/batchBOC.go
@@ -84,6 +84,10 @@ func (batch *BatchBOC) Validate() error {
 		if entry.IdentificationNumber == "" {
 			return batch.Error("CheckSerialNumber", ErrBatchCheckSerialNumber)
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchCCD.go b/batchCCD.go
@@ -50,6 +50,10 @@ func (batch *BatchCCD) Validate() error {
 		if len(entry.Addenda05) > 1 {
 			return batch.Error("AddendaCount", NewErrBatchAddendaCount(len(entry.Addenda05), 1))
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchCIE.go b/batchCIE.go
@@ -71,6 +71,10 @@ func (batch *BatchCIE) Validate() error {
 		if len(entry.Addenda05) > 1 {
 			return batch.Error("AddendaCount", NewErrBatchAddendaCount(len(entry.Addenda05), 1))
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchCOR.go b/batchCOR.go
@@ -75,6 +75,10 @@ func (batch *BatchCOR) Validate() error {
 			LoanZeroDollarRemittanceCredit:
 			return batch.Error("TransactionCode", ErrBatchTransactionCode, entry.TransactionCode)
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchCTX.go b/batchCTX.go
@@ -77,6 +77,10 @@ func (batch *BatchCTX) Validate() error {
 				return batch.Error("TransactionCode", ErrBatchTransactionCode, entry.TransactionCode)
 			}
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchDNE.go b/batchDNE.go
@@ -69,6 +69,10 @@ func (batch *BatchDNE) Validate() error {
 		if len(entry.Addenda05) != 1 {
 			return batch.Error("AddendaCount", NewErrBatchAddendaCount(len(entry.Addenda05), 1))
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchENR.go b/batchENR.go
@@ -66,9 +66,14 @@ func (batch *BatchENR) Validate() error {
 
 		switch entry.TransactionCode {
 		case CheckingCredit, CheckingDebit, SavingsCredit, SavingsDebit:
+			// nothing
 		default:
 			return batch.Error("TransactionCode", ErrBatchTransactionCode, entry.TransactionCode)
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchMTE.go b/batchMTE.go
@@ -58,6 +58,10 @@ func (batch *BatchMTE) Validate() error {
 		if entry.Amount <= 0 {
 			return batch.Error("Amount", ErrBatchAmountZero, entry.Amount)
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchPOP.go b/batchPOP.go
@@ -79,6 +79,10 @@ func (batch *BatchPOP) Validate() error {
 		if entry.IdentificationNumber == "" {
 			return batch.Error("CheckSerialNumber", ErrBatchCheckSerialNumber)
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchPOS.go b/batchPOS.go
@@ -68,6 +68,10 @@ func (batch *BatchPOS) Validate() error {
 		if err := entry.isCardTransactionType(entry.DiscretionaryData); err != nil {
 			return batch.Error("CardTransactionType", ErrBatchInvalidCardTransactionType, entry.DiscretionaryData)
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchPPD.go b/batchPPD.go
@@ -51,6 +51,10 @@ func (batch *BatchPPD) Validate() error {
 		if len(entry.Addenda05) > 1 {
 			return batch.Error("AddendaCount", NewErrBatchAddendaCount(len(entry.Addenda05), 1))
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchRCK.go b/batchRCK.go
@@ -73,6 +73,10 @@ func (batch *BatchRCK) Validate() error {
 		if entry.IdentificationNumber == "" {
 			return batch.Error("CheckSerialNumber", ErrBatchCheckSerialNumber)
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchSHR.go b/batchSHR.go
@@ -82,6 +82,10 @@ func (batch *BatchSHR) Validate() error {
 		if err := entry.isCreditCardYear(year); err != nil {
 			return fieldError("CardExpirationDate", ErrValidYear, year)
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchTEL.go b/batchTEL.go
@@ -50,6 +50,10 @@ func (batch *BatchTEL) Validate() error {
 		if entry.CreditOrDebit() != "D" {
 			return batch.Error("TransactionCode", ErrBatchDebitOnly, entry.TransactionCode)
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchTRC.go b/batchTRC.go
@@ -67,6 +67,10 @@ func (batch *BatchTRC) Validate() error {
 		if entry.ItemResearchNumber() == "" {
 			return batch.Error("ItemResearchNumber", ErrFieldRequired)
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchTRX.go b/batchTRX.go
@@ -73,6 +73,10 @@ func (batch *BatchTRX) Validate() error {
 		if len(entry.Addenda05) != addendaRecords {
 			return batch.Error("AddendaCount", NewErrBatchExpectedAddendaCount(len(entry.Addenda05), addendaRecords))
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchWeb.go b/batchWeb.go
@@ -49,6 +49,10 @@ func (batch *BatchWEB) Validate() error {
 		if len(entry.Addenda05) > 1 {
 			return batch.Error("AddendaCount", NewErrBatchAddendaCount(len(entry.Addenda05), 1))
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/batchXCK.go b/batchXCK.go
@@ -71,6 +71,10 @@ func (batch *BatchXCK) Validate() error {
 		if entry.ItemResearchNumber() == "" {
 			return batch.Error("ItemResearchNumber", ErrFieldRequired)
 		}
+		// Verify the Amount is valid for SEC code and TransactionCode
+		if err := batch.ValidAmountForCodes(entry); err != nil {
+			return err
+		}
 		// Verify the TransactionCode is valid for a ServiceClassCode
 		if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {
 			return err
diff --git a/test/issues/issue1168_test.go b/test/issues/issue1168_test.go
@@ -0,0 +1,59 @@
+// 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 issues
+
+import (
+	"testing"
+	"time"
+
+	"github.com/moov-io/ach"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestIssue1168(t *testing.T) {
+	// Batch Header
+	bh := ach.NewBatchHeader()
+	bh.ServiceClassCode = 200
+	bh.CompanyName = "COMPANY"
+	bh.CompanyIdentification = "IDENTIFICATION"
+	bh.StandardEntryClassCode = ach.WEB
+	bh.CompanyEntryDescription = "DESCRIPTION"
+	bh.CompanyDescriptiveDate = time.Now().Format("060102")
+	bh.EffectiveEntryDate = time.Now().Add(time.Hour * 24).Format("060102")
+	bh.ODFIIdentification = "1"
+
+	ed := &ach.EntryDetail{
+		TransactionCode:    ach.SavingsCredit,
+		DFIAccountNumber:   "54321",
+		RDFIIdentification: "12345678",
+		CheckDigit:         "0",
+		Amount:             0,
+		IndividualName:     "Jane Doe",
+		TraceNumber:        "445566778899",
+	}
+
+	b1 := ach.NewBatchWEB(bh)
+	b1.AddEntry(ed)
+
+	// Require that Batches cannot have zero amounts
+	require.ErrorContains(t, b1.Create(), ach.ErrBatchAmountZero.Error())
+
+	ed.TransactionCode = ach.SavingsPrenoteCredit
+	require.NoError(t, b1.Create())
+}
diff --git a/validators.go b/validators.go
@@ -389,6 +389,16 @@ func StandardTransactionCode(code int) error {
 	return ErrTransactionCode
 }
 
+func (v *validator) isPrenote(code int) bool {
+	switch code {
+	case CheckingPrenoteCredit, CheckingPrenoteDebit,
+		SavingsPrenoteCredit, SavingsPrenoteDebit,
+		GLPrenoteCredit, GLPrenoteDebit, LoanPrenoteCredit:
+		return true
+	}
+	return false
+}
+
 // isTransactionTypeCode verifies Addenda10 TransactionTypeCode is a valid value
 // ANN = Annuity, BUS = Business/Commercial, DEP = Deposit, LOA = Loan, MIS = Miscellaneous, MOR = Mortgage
 // PEN = Pension, RLS = Rent/Lease, REM = Remittance2, SAL = Salary/Payroll, TAX = Tax, TEL = Telephone-Initiated Transaction

Original file line number	Diff line number	Diff line change
`@@ -77,6 +77,10 @@ func (batch *BatchCTX) Validate() error {`
`77`	`77`	`return batch.Error("TransactionCode", ErrBatchTransactionCode, entry.TransactionCode)`
`78`	`78`	`}`
`79`	`79`	`}`
	`80`	`+ // Verify the Amount is valid for SEC code and TransactionCode`
	`81`	`+ if err := batch.ValidAmountForCodes(entry); err != nil {`
	`82`	`+ return err`
	`83`	`+ }`
`80`	`84`	`// Verify the TransactionCode is valid for a ServiceClassCode`
`81`	`85`	`if err := batch.ValidTranCodeForServiceClassCode(entry); err != nil {`
`82`	`86`	`return err`