nacha 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a66687bb4245eac899ef5e7df5668eab390a7313622ef95a00369b4e8566e18
-  data.tar.gz: 3e6aad6ce4fb40875cc6d712c95e0d140ab7808cbd3874407254b3668213e07c
+  metadata.gz: ac015c80a2af7bf4ccb82d5d4f61b6989fc97339d245b63f0738504b80098c34
+  data.tar.gz: 6e22d6adb5488eb75bce08eba680ff85b94335a287de3ef5dcbf03084c3f04f6
 SHA512:
-  metadata.gz: e8721ff7bb46a2f981f4e667dbdcf6dd5f78869f7f8fa71ae5029fa54b1eff30804a47ffc384c5736a469bb4da4d33a93ccc8374a8fe6fe441ec79323ada65db
-  data.tar.gz: e74d56a05bd2f2b5b6cba9d59df4ebc40654a49dfef873c02b1c27faa2a4609da53131fc2ad9328b291d81f609055466d2f99a6cc51a34458fc3163d9b64804c
+  metadata.gz: a7d60688348901c5182650fd7651c5fc5346eb1b9da3271c6d9a77710646ff74108f2517a6430a8f271930eb592d8a41b52d86e04169cc443da32f54ce6a6e9b
+  data.tar.gz: 628125365a043294bf71d4523c2db3ecb7ad290b1645f2abd8e0ab35339e14e739fd99d89d80a7853c9c0ae165c6fde3864d0ee95b01995d429a56eab54af8d4

data/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.17] - 2025-07-25
+
+- lots of yard documentation for all the Ach record types.  Generating
+  documentation so that the AI coders will have something to go by
+
 ## [0.1.16] - 2025-07-22
 
 - `Nacha::Record::BatchHeader` would blissfully attempt to add a

data/lib/nacha/numeric.rb

@@ -41,7 +41,7 @@ class Nacha::Numeric
     @op_value.respond_to?(method_name)
   end
 
-  # @op_value is the value for operations.   @value may still be a string
+  # The value for operations is @op_value.   @value may still be a string
   # from the input data.   If an operation is attempted, then @op_value
   # should be checked to see if the operation is valid for it, not
   # necessarily the potentially string @value

data/lib/nacha/record/ack_entry_detail.rb

@@ -6,6 +6,26 @@ require 'nacha/record/detail_record_type'
 
 module Nacha
   module Record
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an ACK Entry Detail record with a constant value of '6'.
+    # @!attribute [rw] transaction_code
+    #   @return [Nacha::Numeric] Identifies the transaction as an acknowledgment for a received credit entry.
+    # @!attribute [rw] receiving_dfi_identification
+    #   @return [Nacha::AbaNumber] The routing number of the financial institution that is to receive the acknowledgement.
+    # @!attribute [rw] dfi_account_number
+    #   @return [String] The DFI account number of the receiver from the original entry detail record.
+    # @!attribute [rw] amount
+    #   @return [Nacha::Numeric] The amount of the entry being acknowledged, which is always zero for ACK entries.
+    # @!attribute [rw] originl_entry_trace_number
+    #   @return [Nacha::Numeric] The trace number from the original Entry Detail Record to which this acknowledgment applies.
+    # @!attribute [rw] receiving_company_name
+    #   @return [String] The name of the receiver from the original entry detail record.
+    # @!attribute [rw] discretionary_data
+    #   @return [String] Optional data field which can be used by the ODFI or Originator for their own purposes.
+    # @!attribute [rw] addenda_record_indicator
+    #   @return [Nacha::Numeric] A code indicating whether an addenda record follows, '1' for yes and '0' for no.
+    # @!attribute [rw] trace_number
+    #   @return [Nacha::Numeric] A unique number assigned by the ODFI to this specific acknowledgement entry.
     class AckEntryDetail < Nacha::Record::Base
       include DetailRecordType
 

data/lib/nacha/record/adv_batch_control.rb

@@ -7,6 +7,24 @@ require 'nacha/record/batch_control_record_type'
 module Nacha
   module Record
     # The AdvBatchControl record is used to control the batch of adv entry detail records.
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an ADV Batch Control record with a constant value of '8'.
+    # @!attribute [rw] service_class_code
+    #   @return [Nacha::Numeric] Indicates the type of entries in the batch, such as automated accounting advices.
+    # @!attribute [rw] entry_addenda_count
+    #   @return [Nacha::Numeric] A count of all ADV Entry Detail records plus all Addenda records in the batch.
+    # @!attribute [rw] entry_hash
+    #   @return [Nacha::Numeric] A hash total of the routing numbers of all ADV Entry Detail records in the batch.
+    # @!attribute [rw] total_debit_entry_dollar_amount
+    #   @return [Nacha::Numeric] The total dollar amount of all debit entries in the batch, which is zero for ADV files.
+    # @!attribute [rw] total_credit_entry_dollar_amount
+    #   @return [Nacha::Numeric] The total dollar amount of all credit entries in the batch.
+    # @!attribute [rw] ach_operator_data
+    #   @return [String] Data that an ACH Operator may use to provide additional information about the batch.
+    # @!attribute [rw] originating_dfi_identification
+    #   @return [String] The 8-digit routing number of the ACH Operator that created the batch.
+    # @!attribute [rw] batch_number
+    #   @return [Nacha::Numeric] A number assigned by the ACH Operator to uniquely identify the batch.
     class AdvBatchControl < Nacha::Record::Base
       include BatchControlRecordType
 

data/lib/nacha/record/adv_entry_detail.rb

@@ -6,6 +6,34 @@ require 'nacha/record/detail_record_type'
 
 module Nacha
   module Record
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an ADV Entry Detail record with a constant value of '6'.
+    # @!attribute [rw] transaction_code
+    #   @return [Nacha::Numeric] Identifies the type of transaction, such as a credit or debit.
+    # @!attribute [rw] receiving_dfi_identification
+    #   @return [Nacha::AbaNumber] The routing number of the financial institution that is to receive the credit or debit entry.
+    # @!attribute [rw] dfi_account_number
+    #   @return [String] The account number at the receiving financial institution to be credited or debited.
+    # @!attribute [rw] amount
+    #   @return [Nacha::Numeric] The total dollar amount of the entry.
+    # @!attribute [rw] advice_routing_number
+    #   @return [Nacha::Numeric] The routing number of the financial institution responsible for the advice of entry.
+    # @!attribute [rw] file_identification
+    #   @return [String] An optional field used by an ACH Operator to uniquely identify the file.
+    # @!attribute [rw] ach_operator_data
+    #   @return [String] Optional data used by an ACH Operator.
+    # @!attribute [rw] individual_name
+    #   @return [String] The name of the Receiver from the original Entry Detail Record.
+    # @!attribute [rw] discretionary_data
+    #   @return [String] Optional data field which can be used by the ODFI or Originator for their own purposes.
+    # @!attribute [rw] addenda_record_indicator
+    #   @return [Nacha::Numeric] A code indicating whether an addenda record follows, '1' for yes and '0' for no.
+    # @!attribute [rw] routing_number_of_ach_operator
+    #   @return [String] The routing number of the ACH Operator that created the ADV entry.
+    # @!attribute [rw] julian_date_created
+    #   @return [Nacha::Numeric] The Julian date on which the ADV entry was created.
+    # @!attribute [rw] sequence_number
+    #   @return [Nacha::Numeric] A number assigned by the ACH Operator to uniquely identify the entry within the file.
     class AdvEntryDetail < Nacha::Record::Base
       include DetailRecordType
 

data/lib/nacha/record/adv_file_control.rb

@@ -6,6 +6,22 @@ require 'nacha/record/file_control_record_type'
 
 module Nacha
   module Record
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an ADV File Control record with a constant value of '9'.
+    # @!attribute [rw] batch_count
+    #   @return [Nacha::Numeric] The total number of batch records in the file.
+    # @!attribute [rw] block_count
+    #   @return [Nacha::Numeric] The total number of blocks in the file, where a block is 10 lines.
+    # @!attribute [rw] entry_addenda_count
+    #   @return [Nacha::Numeric] The total number of entry detail and addenda records in the file.
+    # @!attribute [rw] entry_hash
+    #   @return [Nacha::Numeric] The sum of all Entry Hash fields from the Batch Control records in the file.
+    # @!attribute [rw] total_debit_entry_dollar_amount_in_file
+    #   @return [Nacha::Numeric] The total value of all debit entries in the file, which is zero for ADV files.
+    # @!attribute [rw] total_credit_entry_dollar_amount_in_file
+    #   @return [Nacha::Numeric] The total value of all credit entries in the file.
+    # @!attribute [rw] reserved
+    #   @return [String] A reserved field for future use.
     class AdvFileControl < Nacha::Record::Base
       include FileControlRecordType
 

data/lib/nacha/record/adv_file_header.rb

@@ -6,6 +6,32 @@ require 'nacha/record/file_header_record_type'
 
 module Nacha
   module Record
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an ADV File Header record with a constant value of '1'.
+    # @!attribute [rw] priority_code
+    #   @return [Nacha::Numeric] A code that indicates the processing priority of the file.
+    # @!attribute [rw] immediate_destination
+    #   @return [Nacha::AbaNumber] The routing number of the ACH Operator or receiving point to which the file is sent.
+    # @!attribute [rw] immediate_origin
+    #   @return [Nacha::AbaNumber] The routing number of the ACH Operator that is sending the file.
+    # @!attribute [rw] file_creation_date
+    #   @return [String] The date the file was created by the sending institution, in YYMMDD format.
+    # @!attribute [rw] file_creation_time
+    #   @return [String] The time the file was created by the sending institution, in HHMM format.
+    # @!attribute [rw] file_id_modifier
+    #   @return [String] A code to distinguish between multiple files created on the same date with the same origin and destination.
+    # @!attribute [rw] record_size
+    #   @return [String] The number of characters in each record of the file, which is always '094'.
+    # @!attribute [rw] blocking_factor
+    #   @return [String] The number of records in a block, which is always '10'.
+    # @!attribute [rw] format_code
+    #   @return [String] A code indicating the file format version, which is '1' for current Nacha standards.
+    # @!attribute [rw] immediate_destination_name
+    #   @return [String] The name of the ACH Operator or receiving point to which the file is being sent.
+    # @!attribute [rw] immediate_origin_name
+    #   @return [String] The name of the ACH Operator that is sending the file.
+    # @!attribute [rw] reference_code
+    #   @return [String] A reference code for the file, which is 'ADV FILE' for Automated Accounting Advices.
     class AdvFileHeader < Nacha::Record::Base
       include FileHeaderRecordType
 

data/lib/nacha/record/arc_entry_detail.rb

@@ -6,6 +6,26 @@ require 'nacha/record/detail_record_type'
 
 module Nacha
   module Record
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an ARC Entry Detail record with a constant value of '6'.
+    # @!attribute [rw] transaction_code
+    #   @return [Nacha::Numeric] Specifies the type of account and the nature of the transaction (e.g., debit to a checking account).
+    # @!attribute [rw] receiving_dfi_identification
+    #   @return [Nacha::AbaNumber] The routing number of the financial institution receiving the entry.
+    # @!attribute [rw] dfi_account_number
+    #   @return [String] The account number to be debited at the receiving financial institution.
+    # @!attribute [rw] amount
+    #   @return [Nacha::Numeric] The total dollar amount of the entry.
+    # @!attribute [rw] check_serial_number
+    #   @return [String] The serial number of the source check being converted to an ACH entry.
+    # @!attribute [rw] individual_name
+    #   @return [String] The name of the individual to whom the check was issued.
+    # @!attribute [rw] discretionary_data
+    #   @return [String] An optional field that can be used by the Originator for their own purposes.
+    # @!attribute [rw] addenda_record_indicator
+    #   @return [Nacha::Numeric] Indicates whether an addenda record is present ('1') or not ('0').
+    # @!attribute [rw] trace_number
+    #   @return [Nacha::Numeric] A unique number assigned by the ODFI to trace the entry.
     class ArcEntryDetail < Nacha::Record::Base
       include DetailRecordType
 

data/lib/nacha/record/base.rb

@@ -8,14 +8,29 @@ require 'nacha/record/validations/field_validations'
 module Nacha
   module Record
     # Base class for all Nacha records.
+    # @!attribute [r] children
+    #   @return [Array<Nacha::Record::Base>] An array of child records associated with this record.
+    # @!attribute [r] original_input_line
+    #   @return [String, nil] The original string from the ACH file that this record was parsed from.
+    # @!attribute [r] fields
+    #   @return [Hash{Symbol => Nacha::Field}] A hash of field objects that belong to this record, keyed by field name.
+    # @!attribute [rw] parent
+    #   @return [Nacha::Record::Base, nil] The parent record of this record in the ACH file hierarchy.
+    # @!attribute [rw] line_number
+    #   @return [Integer, nil] The line number of this record within the ACH file.
     class Base
       include Validations::FieldValidations
 
       attr_reader :children, :name, :validations, :original_input_line, :fields
+
       # :reek:Attribute
+
       attr_accessor :parent, :line_number
 
       # :reek:ManualDispatch
+
+      # Initializes a new record object.
+      # @param opts [Hash] A hash of options to set as attributes on the new record.
       def initialize(opts = {})
         @children = []
         @parent = nil
@@ -35,6 +50,16 @@ module Nacha
 
       class << self
         # :reek:LongParameterList, :reek:ManualDispatch
+        # Defines a field for the record type.
+        #
+        # This class method is used in subclasses to declare each field within the NACHA record.
+        # It stores the definition and sets up validations.
+        #
+        # @param name [Symbol] The name of the field.
+        # @param inclusion [String] The inclusion rule for the field ('M' for mandatory, 'R' for required, 'O' for optional).
+        # @param contents [String] The expected content type of the field (e.g., 'Numeric', 'Alphameric', 'C...').
+        # @param position [Range] The character position range of the field in the record string.
+        # @return [void]
         def nacha_field(name, inclusion:, contents:, position:)
           Nacha.add_ach_record_type(self)
           definition[name] = { inclusion: inclusion,
@@ -47,14 +72,22 @@ module Nacha
           (validations[name] ||= []) << validation_method
         end
 
+        # Returns the field definitions for the record class.
+        # @return [Hash] A hash containing the definitions of all fields for this record type.
         def definition
           @definition ||= {}
         end
 
+        # Returns the validation methods for the record class.
+        # @return [Hash] A hash of validation methods for the fields of this record type.
         def validations
           @validations ||= {}
         end
 
+        # Generates and returns a format string for `String#unpack` to parse a record line.
+        #
+        # The format string is built based on the field definitions.
+        # @return [String] The unpack format string.
         def unpack_str
           @unpack_str ||= definition.values
                             .sort { |a, b| a[:position].first <=> b[:position].first }
@@ -66,6 +99,9 @@ module Nacha
         # :reek:TooManyStatements
         # rubocop:disable Layout/BlockAlignment,
         # rubocop:disable Style/StringConcatenation:
+
+        # Generates a Regexp to match against a line to determine if it is of this record type.
+        # @return [Regexp] The regular expression for matching record lines.
         def matcher
           @matcher ||= begin
             output_started = false
@@ -99,6 +135,12 @@ module Nacha
         # rubocop:enable Layout/BlockAlignment,
         # rubocop:enable Style/StringConcatenation:
 
+        # Parses an ACH string and creates a new record instance.
+        #
+        # It unpacks the string based on field definitions, populates the fields,
+        # and runs validations.
+        # @param ach_str [String] The 94-character string representing a NACHA record.
+        # @return [Nacha::Record::Base] A new instance of the record class populated with data from the string.
         def parse(ach_str)
           rec = new(original_input_line: ach_str)
           ach_str.unpack(unpack_str).zip(rec.fields.values) do |input_data, field|
@@ -108,12 +150,19 @@ module Nacha
           rec
         end
 
+        # Returns the record type name.
+        #
+        # The name is derived from the class name, converted to a snake_case symbol.
+        # @return [Symbol] The record type as a symbol (e.g., :file_header).
         def record_type
           Nacha.record_name(self)
         end
 
-        # :reek:ManualDispatch, :reek:TooManyStatements
-        def to_h
+        # Returns a hash representation of the record class definition.
+        #
+        # This includes field definitions and child record types.
+        # @return [Hash] A hash representing the structure of the record type.
+        def to_h # :reek:ManualDispatch, :reek:TooManyStatements
           fields = definition.transform_values do |field_def|
             {
               inclusion: field_def[:inclusion],
@@ -129,30 +178,52 @@ module Nacha
           { record_type.to_sym => fields }
         end
 
+        # Returns a JSON string representing the record class definition.
+        # @param _args [Array] Arguments to be passed to `JSON.pretty_generate`.
+        # @return [String] The JSON representation of the record definition.
         def to_json(*_args)
           JSON.pretty_generate(to_h)
         end
       end
 
       # :reek:FeatureEnvy
+
+      # Sets the original input line string for the record.
+      # @param line [String] The original 94-character string from the ACH file.
+      # @return [void]
       def original_input_line=(line)
         @original_input_line = line.dup if line.is_a?(String)
       end
 
+      # Creates field instances from the class's field definitions.
+      #
+      # This method is called during initialization to populate the `@fields` hash.
+      # @return [void]
       def create_fields_from_definition
         definition.each_pair do |field_name, field_def|
           @fields[field_name.to_sym] = Nacha::Field.new(field_def)
         end
       end
 
+      # Returns the record type name for the instance.
+      # @return [Symbol] The record type as a symbol.
+      # @see .record_type
       def record_type
         self.class.record_type
       end
 
+      # Returns a human-readable name for the record type.
+      #
+      # It converts the snake_case `record_type` into a capitalized string with spaces.
+      # @return [String] The human-readable name (e.g., 'File Header').
       def human_name
         @human_name ||= record_type.to_s.split('_').map(&:capitalize).join(' ')
       end
 
+      # Returns a hash representation of the record instance.
+      #
+      # The hash includes metadata and a representation of each field's data and errors.
+      # @return [Hash] A hash representing the record's current state.
       def to_h
         { nacha_record_type: record_type,
           metadata: {
@@ -166,16 +237,28 @@ module Nacha
             end)
       end
 
+      # Returns a JSON string representing the record instance.
+      # @param _args [Array] Arguments to be passed to `JSON.pretty_generate`.
+      # @return [String] The JSON representation of the record's current state.
       def to_json(*_args)
         JSON.pretty_generate(to_h)
       end
 
+      # Generates the 94-character ACH string representation of the record.
+      #
+      # This is done by concatenating the ACH string representation of each field.
+      # @return [String] The 94-character ACH record string.
       def to_ach
         @fields.keys.collect do |key|
           @fields[key].to_ach
         end.join
       end
 
+      # Generates an HTML representation of the record.
+      #
+      # This is useful for displaying ACH data in a web interface.
+      # @param _opts [Hash] Options for HTML generation (currently unused).
+      # @return [String] The HTML representation of the record.
       def to_html(_opts = {})
         record_error_class = nil
 
@@ -191,14 +274,23 @@ module Nacha
           "</div>"
       end
 
+      # Returns a developer-friendly string representation of the record object.
+      # @return [String] A string showing the class name and a hash representation of the object.
       def inspect
         "#<#{self.class.name}> #{to_h}"
       end
 
+      # Returns the field definitions for the record class.
+      # @return [Hash] A hash containing the definitions of all fields for this record type.
+      # @see .definition
       def definition
         self.class.definition
       end
 
+      # Runs all field-level and record-level validations.
+      #
+      # This method populates the `errors` array on the record and its fields.
+      # @return [void]
       def validate
         # Run field-level validations first
         @fields.each_value(&:validate)
@@ -208,7 +300,8 @@ module Nacha
         end
       end
 
-      # look for invalid fields, if none, then return true
+      # Checks if the record is valid by running all validations.
+      # @return [Boolean] `true` if the record has no errors, `false` otherwise.
       def valid?
         validate
         errors.empty?
@@ -294,15 +387,29 @@ module Nacha
         false
       end
 
+      # Returns all validation errors for the record and its fields.
+      # @return [Array<String>] An array of error messages.
       def errors
         (@errors + @fields.values.map(&:errors)).flatten
       end
 
+      # Adds a validation error message to the record's error list.
+      # @param err_string [String] The error message to add.
+      # @return [void]
       def add_error(err_string)
         @errors << err_string
       end
 
       # :reek:TooManyStatements
+
+      # Handles dynamic access to fields as methods.
+      #
+      # This allows getting and setting field data using attribute-style methods
+      # (e.g., `record.amount`, `record.amount = 123.45`).
+      # @param method_name [Symbol] The name of the missing method.
+      # @param args [Array] The arguments passed to the method.
+      # @param block [Proc] A block passed to the method.
+      # @return [Nacha::Field, Object] Returns the `Nacha::Field` object for a getter, or the assigned value for a setter.
       def method_missing(method_name, *args, &block)
         method = method_name.to_s
         field_name = method.gsub(/=$/, '').to_sym
@@ -316,6 +423,10 @@ module Nacha
         end
       end
 
+      # Complements `method_missing` to allow `respond_to?` to work for dynamic field methods.
+      # @param method_name [Symbol] The name of the method to check.
+      # @param _ [Array] Additional arguments (e.g. `include_private`) are ignored.
+      # @return [Boolean] `true` if the method corresponds to a defined field, `false` otherwise.
       def respond_to_missing?(method_name, *)
         field_name = method_name.to_s.gsub(/=$/, '').to_sym
         definition[field_name] || super
@@ -331,6 +442,7 @@ module Nacha
       end
 
       # :reek:TooManyStatements
+
       def run_record_level_validations_for(field)
         klass = self.class
         validations = klass.validations[field]

data/lib/nacha/record/batch_control.rb

@@ -6,6 +6,28 @@ require 'nacha/record/batch_control_record_type'
 
 module Nacha
   module Record
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as a Batch Control record with a constant value of '8'.
+    # @!attribute [rw] service_class_code
+    #   @return [Nacha::Numeric] Specifies the type of entries in the batch (e.g., credits, debits, or mixed).
+    # @!attribute [rw] entry_addenda_count
+    #   @return [Nacha::Numeric] The total count of entry detail and addenda records within the batch.
+    # @!attribute [rw] entry_hash
+    #   @return [Nacha::Numeric] A hash total of the routing numbers of all entry detail records in the batch for validation.
+    # @!attribute [rw] total_debit_entry_dollar_amount
+    #   @return [Nacha::Numeric] The total dollar amount of all debit entries in the batch.
+    # @!attribute [rw] total_credit_entry_dollar_amount
+    #   @return [Nacha::Numeric] The total dollar amount of all credit entries in the batch.
+    # @!attribute [rw] company_identification
+    #   @return [String] The identifier for the company that originated the entries in the batch.
+    # @!attribute [rw] message_authentication_code
+    #   @return [String] A code used to authenticate the batch, if required by the ODFI.
+    # @!attribute [rw] reserved
+    #   @return [String] A reserved field for future use.
+    # @!attribute [rw] originating_dfi_identification
+    #   @return [String] The 8-digit routing number of the financial institution originating the batch.
+    # @!attribute [rw] batch_number
+    #   @return [Nacha::Numeric] A number assigned by the ODFI to uniquely identify the batch.
     class BatchControl < Nacha::Record::Base
       include BatchControlRecordType
 

data/lib/nacha/record/batch_header.rb

@@ -5,6 +5,32 @@ require 'nacha/record/batch_header_record_type'
 
 module Nacha
   module Record
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as a Batch Header record with a constant value of '5'.
+    # @!attribute [rw] service_class_code
+    #   @return [Nacha::Numeric] Defines the type of entries in the batch, such as credits, debits, or mixed.
+    # @!attribute [rw] company_name
+    #   @return [String] The name of the company originating the entries in the batch.
+    # @!attribute [rw] company_discretionary_data
+    #   @return [String] Optional data field for the Originator's use.
+    # @!attribute [rw] company_identification
+    #   @return [String] A unique identifier for the company, typically a tax ID or a DDA number.
+    # @!attribute [rw] standard_entry_class_code
+    #   @return [String] A three-letter code (e.g., PPD, CCD) that identifies the payment type.
+    # @!attribute [rw] company_entry_description
+    #   @return [String] A description of the purpose of the entries in the batch.
+    # @!attribute [rw] company_descriptive_date
+    #   @return [String] A date chosen by the company to describe the entries, such as a payroll date.
+    # @!attribute [rw] effective_entry_date
+    #   @return [String] The date on which the entries are intended to be settled.
+    # @!attribute [rw] settlement_date_julian
+    #   @return [Nacha::Numeric] A Julian date used by the ACH Operator for settlement, not for use by the Originator.
+    # @!attribute [rw] originator_status_code
+    #   @return [String] A code indicating the status of the originator, typically '1' for a financial institution.
+    # @!attribute [rw] originating_dfi_identification
+    #   @return [String] The 8-digit routing number of the financial institution originating the batch.
+    # @!attribute [rw] batch_number
+    #   @return [Nacha::Numeric] A number assigned by the Originator to uniquely identify the batch.
     class BatchHeader < Nacha::Record::Base
       include BatchHeaderRecordType
 

data/lib/nacha/record/boc_entry_detail.rb

@@ -6,6 +6,26 @@ require 'nacha/record/detail_record_type'
 
 module Nacha
   module Record
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as a BOC Entry Detail record with a constant value of '6'.
+    # @!attribute [rw] transaction_code
+    #   @return [Nacha::Numeric] Specifies the type of account and nature of the transaction.
+    # @!attribute [rw] receiving_dfi_identification
+    #   @return [Nacha::AbaNumber] The routing number of the financial institution receiving the entry.
+    # @!attribute [rw] dfi_account_number
+    #   @return [String] The account number to be debited at the receiving financial institution.
+    # @!attribute [rw] amount
+    #   @return [Nacha::Numeric] The amount of the check being converted to an ACH entry.
+    # @!attribute [rw] check_serial_number
+    #   @return [String] The serial number from the source check.
+    # @!attribute [rw] individual_name
+    #   @return [String] The name of the person who wrote the check.
+    # @!attribute [rw] discretionary_data
+    #   @return [String] Optional field for the Originator's use.
+    # @!attribute [rw] addenda_record_indicator
+    #   @return [Nacha::Numeric] Indicates if an addenda record follows.
+    # @!attribute [rw] trace_number
+    #   @return [Nacha::Numeric] A unique number assigned by the ODFI for tracing the entry.
     class BocEntryDetail < Nacha::Record::Base
       include DetailRecordType
 

data/lib/nacha/record/ccd_addenda.rb

@@ -6,6 +6,16 @@ require 'nacha/record/addenda_record_type'
 
 module Nacha
   module Record
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an Addenda record with a constant value of '7'.
+    # @!attribute [rw] addenda_type_code
+    #   @return [String] Specifies the type of addenda, typically '05' for CCD payment information.
+    # @!attribute [rw] payment_related_information
+    #   @return [String] Contains payment-related information, such as an invoice number.
+    # @!attribute [rw] addenda_sequence_number
+    #   @return [Nacha::Numeric] The sequence number of this addenda record within the entry.
+    # @!attribute [rw] entry_detail_sequence_number
+    #   @return [Nacha::Numeric] The sequence number of the Entry Detail record this addenda is associated with.
     class CcdAddenda < Nacha::Record::Base
       include AddendaRecordType
 

data/lib/nacha/record/ccd_entry_detail.rb

@@ -6,6 +6,26 @@ require 'nacha/record/detail_record_type'
 
 module Nacha
   module Record
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as a CCD Entry Detail record with a constant value of '6'.
+    # @!attribute [rw] transaction_code
+    #   @return [Nacha::Numeric] Defines the type of account and transaction (e.g., credit to a checking account).
+    # @!attribute [rw] receiving_dfi_identification
+    #   @return [Nacha::AbaNumber] The routing number of the financial institution that will receive the entry.
+    # @!attribute [rw] dfi_account_number
+    #   @return [String] The account number at the receiving institution to be credited or debited.
+    # @!attribute [rw] amount
+    #   @return [Nacha::Numeric] The transaction amount.
+    # @!attribute [rw] identification_number
+    #   @return [String] An identifier for the receiver of the entry.
+    # @!attribute [rw] receiving_company_name
+    #   @return [String] The name of the company receiving the payment.
+    # @!attribute [rw] discretionary_data
+    #   @return [String] Optional data field for use by the Originator.
+    # @!attribute [rw] addenda_record_indicator
+    #   @return [Nacha::Numeric] A flag indicating if an addenda record is included.
+    # @!attribute [rw] trace_number
+    #   @return [Nacha::Numeric] A unique number assigned by the ODFI to trace the transaction.
     class CcdEntryDetail < Nacha::Record::Base
       include DetailRecordType
 

data/lib/nacha/record/cie_addenda.rb

@@ -6,6 +6,16 @@ require 'nacha/record/addenda_record_type'
 
 module Nacha
   module Record
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an Addenda record with a constant value of '7'.
+    # @!attribute [rw] addenda_type_code
+    #   @return [String] Specifies the type of addenda, which is '05' for CIE payment-related information.
+    # @!attribute [rw] payment_related_information
+    #   @return [String] Contains additional information about the payment, like an invoice number.
+    # @!attribute [rw] addenda_sequence_number
+    #   @return [Nacha::Numeric] The sequence number for this addenda record.
+    # @!attribute [rw] entry_detail_sequence_number
+    #   @return [Nacha::Numeric] The sequence number of the associated Entry Detail record.
     class CieAddenda < Nacha::Record::Base
       include AddendaRecordType