Class: Nacha::Record::AdvBatchControl

Inherits:
Base
  • Object
show all
Includes:
BatchControlRecordType
Defined in:
lib/nacha/record/adv_batch_control.rb

Overview

The AdvBatchControl record is used to control the batch of adv entry detail records.

Instance Attribute Summary collapse

Attributes inherited from Base

#children, #fields, #line_number, #name, #original_input_line, #parent, #validations

Method Summary

Methods included from BatchControlRecordType

#child_record_types, included

Methods inherited from Base

#add_error, #create_fields_from_definition, #credit?, #debit?, definition, #definition, #errors, #human_name, #initialize, #inspect, matcher, #method_missing, nacha_field, parse, #record_type, record_type, #respond_to_missing?, #to_ach, #to_h, to_h, #to_html, to_json, #to_json, unpack_str, #valid?, #validate, validations

Methods included from Validations::FieldValidations

included

Constructor Details

This class inherits a constructor from Nacha::Record::Base

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Nacha::Record::Base

Instance Attribute Details

#ach_operator_data ⇒ String

Returns Data that an ACH Operator may use to provide additional information about the batch.

Returns:

  • (String) —

    Data that an ACH Operator may use to provide additional information about the batch.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/nacha/record/adv_batch_control.rb', line 28

class AdvBatchControl < Nacha::Record::Base
  include BatchControlRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C8', position: 1..1
  nacha_field :service_class_code, inclusion: 'M', contents: 'Numeric', position: 2..4
  nacha_field :entry_addenda_count, inclusion: 'M', contents: 'Numeric', position: 5..10
  nacha_field :entry_hash, inclusion: 'M', contents: 'Numeric', position: 11..20
  nacha_field :total_debit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 21..40
  nacha_field :total_credit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 41..60
  nacha_field :ach_operator_data,
    inclusion: 'O', contents: 'Alphameric', position: 61..79
  nacha_field :originating_dfi_identification,
    inclusion: 'M', contents: 'TTTAAAA', position: 80..87
  nacha_field :batch_number, inclusion: 'M', contents: 'Numeric', position: 88..94
end

#batch_number ⇒ Nacha::Numeric

Returns A number assigned by the ACH Operator to uniquely identify the batch.

Returns:

  • (Nacha::Numeric) —

    A number assigned by the ACH Operator to uniquely identify the batch.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/nacha/record/adv_batch_control.rb', line 28

class AdvBatchControl < Nacha::Record::Base
  include BatchControlRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C8', position: 1..1
  nacha_field :service_class_code, inclusion: 'M', contents: 'Numeric', position: 2..4
  nacha_field :entry_addenda_count, inclusion: 'M', contents: 'Numeric', position: 5..10
  nacha_field :entry_hash, inclusion: 'M', contents: 'Numeric', position: 11..20
  nacha_field :total_debit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 21..40
  nacha_field :total_credit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 41..60
  nacha_field :ach_operator_data,
    inclusion: 'O', contents: 'Alphameric', position: 61..79
  nacha_field :originating_dfi_identification,
    inclusion: 'M', contents: 'TTTAAAA', position: 80..87
  nacha_field :batch_number, inclusion: 'M', contents: 'Numeric', position: 88..94
end

#entry_addenda_count ⇒ Nacha::Numeric

Returns A count of all ADV Entry Detail records plus all Addenda records in the batch.

Returns:

  • (Nacha::Numeric) —

    A count of all ADV Entry Detail records plus all Addenda records in the batch.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/nacha/record/adv_batch_control.rb', line 28

class AdvBatchControl < Nacha::Record::Base
  include BatchControlRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C8', position: 1..1
  nacha_field :service_class_code, inclusion: 'M', contents: 'Numeric', position: 2..4
  nacha_field :entry_addenda_count, inclusion: 'M', contents: 'Numeric', position: 5..10
  nacha_field :entry_hash, inclusion: 'M', contents: 'Numeric', position: 11..20
  nacha_field :total_debit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 21..40
  nacha_field :total_credit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 41..60
  nacha_field :ach_operator_data,
    inclusion: 'O', contents: 'Alphameric', position: 61..79
  nacha_field :originating_dfi_identification,
    inclusion: 'M', contents: 'TTTAAAA', position: 80..87
  nacha_field :batch_number, inclusion: 'M', contents: 'Numeric', position: 88..94
end

#entry_hash ⇒ Nacha::Numeric

Returns A hash total of the routing numbers of all ADV Entry Detail records in the batch.

Returns:

  • (Nacha::Numeric) —

    A hash total of the routing numbers of all ADV Entry Detail records in the batch.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/nacha/record/adv_batch_control.rb', line 28

class AdvBatchControl < Nacha::Record::Base
  include BatchControlRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C8', position: 1..1
  nacha_field :service_class_code, inclusion: 'M', contents: 'Numeric', position: 2..4
  nacha_field :entry_addenda_count, inclusion: 'M', contents: 'Numeric', position: 5..10
  nacha_field :entry_hash, inclusion: 'M', contents: 'Numeric', position: 11..20
  nacha_field :total_debit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 21..40
  nacha_field :total_credit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 41..60
  nacha_field :ach_operator_data,
    inclusion: 'O', contents: 'Alphameric', position: 61..79
  nacha_field :originating_dfi_identification,
    inclusion: 'M', contents: 'TTTAAAA', position: 80..87
  nacha_field :batch_number, inclusion: 'M', contents: 'Numeric', position: 88..94
end

#originating_dfi_identification ⇒ String

Returns The 8-digit routing number of the ACH Operator that created the batch.

Returns:

  • (String) —

    The 8-digit routing number of the ACH Operator that created the batch.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/nacha/record/adv_batch_control.rb', line 28

class AdvBatchControl < Nacha::Record::Base
  include BatchControlRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C8', position: 1..1
  nacha_field :service_class_code, inclusion: 'M', contents: 'Numeric', position: 2..4
  nacha_field :entry_addenda_count, inclusion: 'M', contents: 'Numeric', position: 5..10
  nacha_field :entry_hash, inclusion: 'M', contents: 'Numeric', position: 11..20
  nacha_field :total_debit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 21..40
  nacha_field :total_credit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 41..60
  nacha_field :ach_operator_data,
    inclusion: 'O', contents: 'Alphameric', position: 61..79
  nacha_field :originating_dfi_identification,
    inclusion: 'M', contents: 'TTTAAAA', position: 80..87
  nacha_field :batch_number, inclusion: 'M', contents: 'Numeric', position: 88..94
end

#record_type_code ⇒ String

Returns Identifies the record as an ADV Batch Control record with a constant value of ‘8’.

Returns:

  • (String) —

    Identifies the record as an ADV Batch Control record with a constant value of ‘8’.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/nacha/record/adv_batch_control.rb', line 28

class AdvBatchControl < Nacha::Record::Base
  include BatchControlRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C8', position: 1..1
  nacha_field :service_class_code, inclusion: 'M', contents: 'Numeric', position: 2..4
  nacha_field :entry_addenda_count, inclusion: 'M', contents: 'Numeric', position: 5..10
  nacha_field :entry_hash, inclusion: 'M', contents: 'Numeric', position: 11..20
  nacha_field :total_debit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 21..40
  nacha_field :total_credit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 41..60
  nacha_field :ach_operator_data,
    inclusion: 'O', contents: 'Alphameric', position: 61..79
  nacha_field :originating_dfi_identification,
    inclusion: 'M', contents: 'TTTAAAA', position: 80..87
  nacha_field :batch_number, inclusion: 'M', contents: 'Numeric', position: 88..94
end

#service_class_code ⇒ Nacha::Numeric

Returns Indicates the type of entries in the batch, such as automated accounting advices.

Returns:

  • (Nacha::Numeric) —

    Indicates the type of entries in the batch, such as automated accounting advices.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/nacha/record/adv_batch_control.rb', line 28

class AdvBatchControl < Nacha::Record::Base
  include BatchControlRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C8', position: 1..1
  nacha_field :service_class_code, inclusion: 'M', contents: 'Numeric', position: 2..4
  nacha_field :entry_addenda_count, inclusion: 'M', contents: 'Numeric', position: 5..10
  nacha_field :entry_hash, inclusion: 'M', contents: 'Numeric', position: 11..20
  nacha_field :total_debit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 21..40
  nacha_field :total_credit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 41..60
  nacha_field :ach_operator_data,
    inclusion: 'O', contents: 'Alphameric', position: 61..79
  nacha_field :originating_dfi_identification,
    inclusion: 'M', contents: 'TTTAAAA', position: 80..87
  nacha_field :batch_number, inclusion: 'M', contents: 'Numeric', position: 88..94
end

#total_credit_entry_dollar_amount ⇒ Nacha::Numeric

Returns The total dollar amount of all credit entries in the batch.

Returns:

  • (Nacha::Numeric) —

    The total dollar amount of all credit entries in the batch.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/nacha/record/adv_batch_control.rb', line 28

class AdvBatchControl < Nacha::Record::Base
  include BatchControlRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C8', position: 1..1
  nacha_field :service_class_code, inclusion: 'M', contents: 'Numeric', position: 2..4
  nacha_field :entry_addenda_count, inclusion: 'M', contents: 'Numeric', position: 5..10
  nacha_field :entry_hash, inclusion: 'M', contents: 'Numeric', position: 11..20
  nacha_field :total_debit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 21..40
  nacha_field :total_credit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 41..60
  nacha_field :ach_operator_data,
    inclusion: 'O', contents: 'Alphameric', position: 61..79
  nacha_field :originating_dfi_identification,
    inclusion: 'M', contents: 'TTTAAAA', position: 80..87
  nacha_field :batch_number, inclusion: 'M', contents: 'Numeric', position: 88..94
end

#total_debit_entry_dollar_amount ⇒ Nacha::Numeric

Returns The total dollar amount of all debit entries in the batch, which is zero for ADV files.

Returns:

  • (Nacha::Numeric) —

    The total dollar amount of all debit entries in the batch, which is zero for ADV files.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/nacha/record/adv_batch_control.rb', line 28

class AdvBatchControl < Nacha::Record::Base
  include BatchControlRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C8', position: 1..1
  nacha_field :service_class_code, inclusion: 'M', contents: 'Numeric', position: 2..4
  nacha_field :entry_addenda_count, inclusion: 'M', contents: 'Numeric', position: 5..10
  nacha_field :entry_hash, inclusion: 'M', contents: 'Numeric', position: 11..20
  nacha_field :total_debit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 21..40
  nacha_field :total_credit_entry_dollar_amount,
    inclusion: 'M', contents: '$$$$$$$$$$$$$$$$$$¢¢', position: 41..60
  nacha_field :ach_operator_data,
    inclusion: 'O', contents: 'Alphameric', position: 61..79
  nacha_field :originating_dfi_identification,
    inclusion: 'M', contents: 'TTTAAAA', position: 80..87
  nacha_field :batch_number, inclusion: 'M', contents: 'Numeric', position: 88..94
end