docs: clarify ID is not part of the Nacha specification

Author: adamdecaf

Diff for: addenda02.go

@@ -26,7 +26,7 @@ import (
 // Code 02 in a machine readable format. It is usually formatted according to ANSI, ASC, X12 Standard.
 // It is used for following StandardEntryClassCode: MTE, POS, and SHR.
 type Addenda02 struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TypeCode Addenda02 type code '02'
 	TypeCode string `json:"typeCode"`

Diff for: addenda05.go

@@ -26,7 +26,7 @@ import (
 // Code 05 in a machine readable format. It is usually formatted according to ANSI, ASC, X12 Standard.
 // It is used for the following StandardEntryClassCode: ACK, ATX, CCD, CIE, CTX, DNE, ENR, WEB, PPD, TRX.
 type Addenda05 struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TypeCode Addenda05 types code '05'
 	TypeCode string `json:"typeCode"`

Diff for: addenda10.go

@@ -30,7 +30,7 @@ import (
 // The Addenda10 Record identifies the Receiver of the transaction and the dollar amount of
 // the payment.
 type Addenda10 struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TypeCode Addenda10 types code '10'
 	TypeCode string `json:"typeCode"`

Diff for: addenda11.go

@@ -30,7 +30,7 @@ import (
 // The Addenda11 record identifies key information related to the Originator of
 // the entry.
 type Addenda11 struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TypeCode Addenda11 types code '11'
 	TypeCode string `json:"typeCode"`

Diff for: addenda12.go

@@ -30,7 +30,7 @@ import (
 // The Addenda12 record identifies key information related to the Originator of
 // the entry.
 type Addenda12 struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TypeCode Addenda12 types code '12'
 	TypeCode string `json:"typeCode"`

Diff for: addenda13.go

@@ -31,7 +31,7 @@ import (
 // For inbound IAT entries, the Fourth Addenda Record must contain information to identify the
 // foreign financial institution that is providing the funding and payment instruction for the IAT entry.
 type Addenda13 struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TypeCode Addenda13 types code '13'
 	TypeCode string `json:"typeCode"`

Diff for: addenda14.go

@@ -29,7 +29,7 @@ import (
 //
 // The Addenda14 identifies the Receiving financial institution holding the Receiver's account.
 type Addenda14 struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TypeCode Addenda14 types code '14'
 	TypeCode string `json:"typeCode"`

Diff for: addenda15.go

@@ -29,7 +29,7 @@ import (
 //
 // The Addenda15 record identifies key information related to the Receiver.
 type Addenda15 struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TypeCode Addenda15 types code '15'
 	TypeCode string `json:"typeCode"`

Diff for: addenda16.go

@@ -29,7 +29,7 @@ import (
 //
 // The Addenda16 record identifies key information related to the Receiver.
 type Addenda16 struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TypeCode Addenda16 types code '16'
 	TypeCode string `json:"typeCode"`

Diff for: addenda17.go

@@ -30,7 +30,7 @@ import (
 // The Addenda17 record identifies payment-related data. A maximum of two of these Addenda Records
 // may be included with each IAT entry.
 type Addenda17 struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TypeCode Addenda17 types code '17'
 	TypeCode string `json:"typeCode"`

Diff for: addenda18.go

@@ -31,7 +31,7 @@ import (
 // processing of the IAT entry. If no Foreign Correspondent Bank is involved,t he record should not be
 // included. A maximum of five of these Addenda Records may be included with each IAT entry.
 type Addenda18 struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TypeCode Addenda18 types code '18'
 	TypeCode string `json:"typeCode"`

Diff for: addenda98.go

@@ -27,7 +27,7 @@ import (
 // Addenda98 is a Addendumer addenda record format for Notification OF Change(98)
 // The field contents for Notification of Change Entries must match the field contents of the original Entries
 type Addenda98 struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TypeCode Addenda types code '98'
 	TypeCode string `json:"typeCode"`

Diff for: addenda98_refused.go

@@ -23,7 +23,7 @@ import (
 )
 
 type Addenda98Refused struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 
 	// TypeCode Addenda types code '98'

Diff for: addenda99.go

@@ -42,7 +42,7 @@ func init() {
 
 // Addenda99 utilized for Notification of Change Entry (COR) and Return types.
 type Addenda99 struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TypeCode Addenda types code '99'
 	TypeCode string `json:"typeCode"`

Diff for: addenda99_contested_return.go

@@ -22,7 +22,7 @@ import (
 )
 
 type Addenda99Contested struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 
 	// TypeCode Addenda types code '99'

Diff for: addenda99_dishonored_return.go

@@ -22,7 +22,7 @@ import (
 )
 
 type Addenda99Dishonored struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 
 	// TypeCode Addenda types code '99'

Diff for: advBatchControl.go

@@ -27,7 +27,7 @@ import (
 // ADVBatchControl contains entry counts, dollar total and has totals for all
 // entries contained in the preceding batch
 type ADVBatchControl struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// This should be the same as BatchHeader ServiceClassCode for ADV: AutomatedAccountingAdvices.
 	ServiceClassCode int `json:"serviceClassCode"`

Diff for: advEntryDetail.go

@@ -28,7 +28,7 @@ import (
 // withdrawal (debit), the transit routing number for the entry recipient's financial
 // institution, the account number (left justify,no zero fill), name, and dollar amount.
 type ADVEntryDetail struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TransactionCode representing Accounting Entries
 	// Credit for ACH debits originated - 81

Diff for: advFileControl.go

@@ -24,7 +24,7 @@ import (
 // ADVFileControl record contains entry counts, dollar totals and hash
 // totals accumulated from each batchADV control record in the file.
 type ADVFileControl struct {
-	// ID is a client defined string used as a reference to this record.
+	// 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

Diff for: batch.go

@@ -28,8 +28,10 @@ import (
 
 // Batch holds the Batch Header and Batch Control and all Entry Records
 type Batch struct {
-	// id is a client defined string used as a reference to this record. accessed via ID/SetID
-	id         string
+	// id is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
+	// This field is managed by SetID() and ID().
+	id string
+
 	Header     *BatchHeader      `json:"batchHeader"`
 	Entries    []*EntryDetail    `json:"entryDetails"`
 	Control    *BatchControl     `json:"batchControl"`

Diff for: batchControl.go

@@ -26,7 +26,7 @@ import (
 // BatchControl contains entry counts, dollar total and has totals for all
 // entries contained in the preceding batch
 type BatchControl struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// ServiceClassCode ACH Mixed Debits and Credits '200'
 	// ACH Credits Only '220'

Diff for: batchHeader.go

@@ -31,7 +31,7 @@ import (
 // settlement date, for all entries contained in this batch. The settlement date
 // field is not entered as it is determined by the ACH operator
 type BatchHeader struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 
 	// ServiceClassCode ACH Mixed Debits and Credits '200'

Diff for: entryDetail.go

@@ -29,7 +29,7 @@ import (
 // withdrawal (debit), the transit routing number for the entry recipient's financial
 // institution, the account number (left justify,no zero fill), name, and dollar amount.
 type EntryDetail struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TransactionCode if the receivers account is checking, savings, general ledger (GL) or loan.
 	TransactionCode int `json:"transactionCode"`

Diff for: file.go

@@ -56,7 +56,9 @@ func (e FileError) Error() string {
 
 // File contains the structures of a parsed ACH File.
 type File struct {
-	ID         string         `json:"id"`
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a file.
+	ID string `json:"id"`
+
 	Header     FileHeader     `json:"fileHeader"`
 	Batches    []Batcher      `json:"batches"`
 	IATBatches []IATBatch     `json:"IATBatches"`

Diff for: fileControl.go

@@ -24,7 +24,7 @@ import (
 // FileControl record contains entry counts, dollar totals and hash
 // totals accumulated from each batch control record in the file.
 type FileControl struct {
-	// ID is a client defined string used as a reference to this record.
+	// 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"`

Diff for: fileHeader.go

@@ -30,8 +30,9 @@ import (
 // contained in the file. The file header also includes creation date and time
 // fields which can be used to uniquely identify a file.
 type FileHeader struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
+
 	// PriorityCode consists of the numerals 01
 	priorityCode string
 

Diff for: iatBatch.go

@@ -32,7 +32,7 @@ import (
 // and physical address of the Receiver, Receiver's account number, Receiver's bank identity and
 // reason for the payment.
 type IATBatch struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID      string            `json:"id"`
 	Header  *IATBatchHeader   `json:"IATBatchHeader"`
 	Entries []*IATEntryDetail `json:"IATEntryDetails"`

Diff for: iatBatchHeader.go

@@ -42,7 +42,7 @@ import (
 // the name and physical address of the Originator, name and physical address of the
 // Receiver, Receiver's account number, Receiver's bank identity and reason for the payment.
 type IATBatchHeader struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 
 	// ServiceClassCode ACH Mixed Debits and Credits '200'

Diff for: iatEntryDetail.go

@@ -29,7 +29,7 @@ import (
 // withdrawal (debit), the transit routing number for the entry recipient's financial
 // institution, the account number (left justify,no zero fill), name, and dollar amount.
 type IATEntryDetail struct {
-	// ID is a client defined string used as a reference to this record.
+	// ID is an identifier only used by the moov-io/ach HTTP server as a way to identify a batch.
 	ID string `json:"id"`
 	// TransactionCode if the receivers account is:
 	// Credit (deposit) to checking account '22'