Deposit tickets

bundle.go

@@ -44,6 +44,8 @@ type Bundle struct {
 	ID string `json:"id"`
 	// BundleHeader is a Bundle Header Record
 	BundleHeader *BundleHeader `json:"bundleHeader,omitempty"`
+	// Credits may be included as part of a bundle, and are often used to represent deposit tickets
+	Credits []*Credit `json:"credits,omitempty"`
 	// Checks are Check Items: Check Detail Records, Check Detail Addendum Records, and Image Views
 	Checks []*CheckDetail `json:"checks,omitempty"`
 	// Returns are Return Items: Return Detail Records, Return Detail Addendum Records, and Image Views
@@ -65,6 +67,9 @@ func (b *Bundle) setRecordType() {
 		return
 	}
 	b.BundleHeader.setRecordType()
+	for i := range b.Credits {
+		b.Credits[i].setRecordType()
+	}
 	for i := range b.Checks {
 		b.Checks[i].setRecordType()
 	}
@@ -92,8 +97,8 @@ func (b *Bundle) Validate() error {
 	return nil
 }
 
-// build creates a valid Bundle by building  BundleControl. An error is returned if
-// the bundle being built has invalid records.
+// build creates a valid Bundle by building BundleControl. An error is returned if the bundle being
+// built has invalid records.
 func (b *Bundle) build() error {
 	// Requires a valid BundleHeader
 	if err := b.BundleHeader.Validate(); err != nil {
@@ -107,9 +112,21 @@ func (b *Bundle) build() error {
 	bundleTotalAmount := 0
 	micrValidTotalAmount := 0
 	bundleImagesCount := 0
-	// The current Implementation doe snot support CreditItems as part of a bundle so BundleControl.CreditIndicator = 0
+	// The current Implementation does not support CreditItems as part of a bundle so BundleControl.CreditIndicator = 0
 	creditIndicator := 0
 
+	// Credit items
+	for _, cr := range b.Credits {
+		if err := b.ValidateCredit(cr); err != nil {
+			return err
+		}
+
+		// A credit record within a Bundle is typically used to present a
+		// deposit ticket, and its amount is not included in the bundle total
+		itemCount++
+		bundleImagesCount += len(cr.ImageViewDetail)
+	}
+
 	// Forward Items
 	for _, cd := range b.Checks {
 
@@ -118,13 +135,13 @@ func (b *Bundle) build() error {
 			return err
 		}
 
-		itemCount = itemCount + 1
-		bundleTotalAmount = bundleTotalAmount + cd.ItemAmount
+		itemCount++
+		bundleTotalAmount += cd.ItemAmount
 		if cd.MICRValidIndicator == 1 {
-			micrValidTotalAmount = micrValidTotalAmount + cd.ItemAmount
+			micrValidTotalAmount += cd.ItemAmount
 		}
 
-		bundleImagesCount = bundleImagesCount + len(cd.ImageViewDetail)
+		bundleImagesCount += len(cd.ImageViewDetail)
 	}
 
 	// Return Items
@@ -134,9 +151,9 @@ func (b *Bundle) build() error {
 		if err := b.ValidateReturnItems(rd); err != nil {
 			return err
 		}
-		itemCount = itemCount + 1
-		bundleTotalAmount = bundleTotalAmount + rd.ItemAmount
-		bundleImagesCount = bundleImagesCount + len(rd.ImageViewDetail)
+		itemCount++
+		bundleTotalAmount += rd.ItemAmount
+		bundleImagesCount += len(rd.ImageViewDetail)
 	}
 
 	// build a BundleControl record
@@ -196,6 +213,20 @@ func (b *Bundle) GetReturns() []*ReturnDetail {
 	return b.Returns
 }
 
+func (b *Bundle) ValidateCredit(cr *Credit) error {
+	for _, ivDetail := range cr.ImageViewDetail {
+		if err := ivDetail.Validate(); err != nil {
+			return err
+		}
+	}
+	for _, ivData := range cr.ImageViewData {
+		if err := ivData.Validate(); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
 // ValidateForwardItems calls Validate function for check items
 func (b *Bundle) ValidateForwardItems(cd *CheckDetail) error {
 	// Validate items

credit.go

@@ -47,6 +47,10 @@ type Credit struct {
 	DebitCreditIndicator string `json:"debitCreditIndicator,omitempty"`
 	// reserved is a field reserved for future use.  Reserved should be blank.
 	reserved string
+
+	ImageViewDetail []ImageViewDetail `json:"imageViewDetail"`
+	ImageViewData   []ImageViewData   `json:"imageViewData"`
+
 	// validator is composed for image cash letter data validation
 	validator
 	// converters is composed for image cash letter to golang Converters
@@ -264,3 +268,11 @@ func (cr *Credit) DebitCreditIndicatorField() string {
 func (cr *Credit) reservedField() string {
 	return cr.alphaField(cr.reserved, 3)
 }
+
+func (cr *Credit) AddImageViewData(ivData ImageViewData) {
+	cr.ImageViewData = append(cr.ImageViewData, ivData)
+}
+
+func (cr *Credit) AddImageViewDetail(ivDetail ImageViewDetail) {
+	cr.ImageViewDetail = append(cr.ImageViewDetail, ivDetail)
+}

file.go

@@ -88,7 +88,7 @@ var (
 	msgFileCashLetterID         = "%s is not unique"
 	msgRecordType               = "received expecting %d"
 	msgFileCreditItem           = "Credit item outside of cash letter"
-	msgFileCredit               = "Credit outside of cash letter"
+	msgFileCredit               = "Credit outside of cash letter or bundle"
 )
 
 // FileError is an error describing issues validating a file

fileControl.go

@@ -52,6 +52,13 @@ func NewFileControl() FileControl {
 	return fc
 }
 
+func (fc *FileControl) IsZero() bool {
+	if fc == nil {
+		return true
+	}
+	return *fc == (FileControl{}) || *fc == NewFileControl()
+}
+
 func (fc *FileControl) setRecordType() {
 	if fc == nil {
 		return

fileHeader.go

@@ -102,6 +102,13 @@ func NewFileHeader() FileHeader {
 	return fh
 }
 
+func (fh *FileHeader) IsZero() bool {
+	if fh == nil {
+		return true
+	}
+	return *fh == (FileHeader{}) || *fh == NewFileHeader()
+}
+
 func (fh *FileHeader) setRecordType() {
 	if fh == nil {
 		return

imageViewDetail_test.go

@@ -57,7 +57,6 @@ func TestMockImageViewDetail(t *testing.T) {
 	require.Equal(t, "", ivDetail.reserved)
 	require.Equal(t, "0", ivDetail.OverrideIndicator)
 	require.Equal(t, "", ivDetail.reservedTwo)
-
 }
 
 // TestParseIVDetail validates parsing an ImageViewDetail