Class: Nacha::Record::AdvFileHeader

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

Instance Attribute Summary collapse

Attributes inherited from Base

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

Method Summary

Methods included from FileHeaderRecordType

#child_record_types, included, #next_record_types

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

#blocking_factor ⇒ String

Returns The number of records in a block, which is always ‘10’.

Returns:

  • (String) —

    The number of records in a block, which is always ‘10’.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/nacha/record/adv_file_header.rb', line 35

class AdvFileHeader < Nacha::Record::Base
  include FileHeaderRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C1', position: 1..1
  nacha_field :priority_code, inclusion: 'R', contents: 'Numeric', position: 2..3
  nacha_field :immediate_destination, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 4..13
  nacha_field :immediate_origin, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 14..23
  nacha_field :file_creation_date, inclusion: 'M', contents: 'YYMMDD', position: 24..29
  nacha_field :file_creation_time, inclusion: 'M', contents: 'HHMM', position: 30..33
  nacha_field :file_id_modifier, inclusion: 'M', contents: 'A-Z0-9', position: 34..34
  nacha_field :record_size, inclusion: 'M', contents: 'C094', position: 35..37
  nacha_field :blocking_factor, inclusion: 'M', contents: 'C10', position: 38..39
  nacha_field :format_code, inclusion: 'M', contents: 'C1', position: 40..40
  nacha_field :immediate_destination_name, inclusion: 'M',
    contents: 'Alphameric', position: 41..63
  nacha_field :immediate_origin_name, inclusion: 'M',
    contents: 'Alphameric', position: 64..86
  nacha_field :reference_code, inclusion: 'M', contents: 'CADV FILE', position: 87..94
end

#file_creation_date ⇒ String

Returns The date the file was created by the sending institution, in YYMMDD format.

Returns:

  • (String) —

    The date the file was created by the sending institution, in YYMMDD format.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/nacha/record/adv_file_header.rb', line 35

class AdvFileHeader < Nacha::Record::Base
  include FileHeaderRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C1', position: 1..1
  nacha_field :priority_code, inclusion: 'R', contents: 'Numeric', position: 2..3
  nacha_field :immediate_destination, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 4..13
  nacha_field :immediate_origin, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 14..23
  nacha_field :file_creation_date, inclusion: 'M', contents: 'YYMMDD', position: 24..29
  nacha_field :file_creation_time, inclusion: 'M', contents: 'HHMM', position: 30..33
  nacha_field :file_id_modifier, inclusion: 'M', contents: 'A-Z0-9', position: 34..34
  nacha_field :record_size, inclusion: 'M', contents: 'C094', position: 35..37
  nacha_field :blocking_factor, inclusion: 'M', contents: 'C10', position: 38..39
  nacha_field :format_code, inclusion: 'M', contents: 'C1', position: 40..40
  nacha_field :immediate_destination_name, inclusion: 'M',
    contents: 'Alphameric', position: 41..63
  nacha_field :immediate_origin_name, inclusion: 'M',
    contents: 'Alphameric', position: 64..86
  nacha_field :reference_code, inclusion: 'M', contents: 'CADV FILE', position: 87..94
end

#file_creation_time ⇒ String

Returns The time the file was created by the sending institution, in HHMM format.

Returns:

  • (String) —

    The time the file was created by the sending institution, in HHMM format.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/nacha/record/adv_file_header.rb', line 35

class AdvFileHeader < Nacha::Record::Base
  include FileHeaderRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C1', position: 1..1
  nacha_field :priority_code, inclusion: 'R', contents: 'Numeric', position: 2..3
  nacha_field :immediate_destination, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 4..13
  nacha_field :immediate_origin, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 14..23
  nacha_field :file_creation_date, inclusion: 'M', contents: 'YYMMDD', position: 24..29
  nacha_field :file_creation_time, inclusion: 'M', contents: 'HHMM', position: 30..33
  nacha_field :file_id_modifier, inclusion: 'M', contents: 'A-Z0-9', position: 34..34
  nacha_field :record_size, inclusion: 'M', contents: 'C094', position: 35..37
  nacha_field :blocking_factor, inclusion: 'M', contents: 'C10', position: 38..39
  nacha_field :format_code, inclusion: 'M', contents: 'C1', position: 40..40
  nacha_field :immediate_destination_name, inclusion: 'M',
    contents: 'Alphameric', position: 41..63
  nacha_field :immediate_origin_name, inclusion: 'M',
    contents: 'Alphameric', position: 64..86
  nacha_field :reference_code, inclusion: 'M', contents: 'CADV FILE', position: 87..94
end

#file_id_modifier ⇒ String

Returns A code to distinguish between multiple files created on the same date with the same origin and destination.

Returns:

  • (String) —

    A code to distinguish between multiple files created on the same date with the same origin and destination.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/nacha/record/adv_file_header.rb', line 35

class AdvFileHeader < Nacha::Record::Base
  include FileHeaderRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C1', position: 1..1
  nacha_field :priority_code, inclusion: 'R', contents: 'Numeric', position: 2..3
  nacha_field :immediate_destination, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 4..13
  nacha_field :immediate_origin, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 14..23
  nacha_field :file_creation_date, inclusion: 'M', contents: 'YYMMDD', position: 24..29
  nacha_field :file_creation_time, inclusion: 'M', contents: 'HHMM', position: 30..33
  nacha_field :file_id_modifier, inclusion: 'M', contents: 'A-Z0-9', position: 34..34
  nacha_field :record_size, inclusion: 'M', contents: 'C094', position: 35..37
  nacha_field :blocking_factor, inclusion: 'M', contents: 'C10', position: 38..39
  nacha_field :format_code, inclusion: 'M', contents: 'C1', position: 40..40
  nacha_field :immediate_destination_name, inclusion: 'M',
    contents: 'Alphameric', position: 41..63
  nacha_field :immediate_origin_name, inclusion: 'M',
    contents: 'Alphameric', position: 64..86
  nacha_field :reference_code, inclusion: 'M', contents: 'CADV FILE', position: 87..94
end

#format_code ⇒ String

Returns A code indicating the file format version, which is ‘1’ for current Nacha standards.

Returns:

  • (String) —

    A code indicating the file format version, which is ‘1’ for current Nacha standards.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/nacha/record/adv_file_header.rb', line 35

class AdvFileHeader < Nacha::Record::Base
  include FileHeaderRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C1', position: 1..1
  nacha_field :priority_code, inclusion: 'R', contents: 'Numeric', position: 2..3
  nacha_field :immediate_destination, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 4..13
  nacha_field :immediate_origin, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 14..23
  nacha_field :file_creation_date, inclusion: 'M', contents: 'YYMMDD', position: 24..29
  nacha_field :file_creation_time, inclusion: 'M', contents: 'HHMM', position: 30..33
  nacha_field :file_id_modifier, inclusion: 'M', contents: 'A-Z0-9', position: 34..34
  nacha_field :record_size, inclusion: 'M', contents: 'C094', position: 35..37
  nacha_field :blocking_factor, inclusion: 'M', contents: 'C10', position: 38..39
  nacha_field :format_code, inclusion: 'M', contents: 'C1', position: 40..40
  nacha_field :immediate_destination_name, inclusion: 'M',
    contents: 'Alphameric', position: 41..63
  nacha_field :immediate_origin_name, inclusion: 'M',
    contents: 'Alphameric', position: 64..86
  nacha_field :reference_code, inclusion: 'M', contents: 'CADV FILE', position: 87..94
end

#immediate_destination ⇒ Nacha::AbaNumber

Returns The routing number of the ACH Operator or receiving point to which the file is sent.

Returns:

  • (Nacha::AbaNumber) —

    The routing number of the ACH Operator or receiving point to which the file is sent.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/nacha/record/adv_file_header.rb', line 35

class AdvFileHeader < Nacha::Record::Base
  include FileHeaderRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C1', position: 1..1
  nacha_field :priority_code, inclusion: 'R', contents: 'Numeric', position: 2..3
  nacha_field :immediate_destination, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 4..13
  nacha_field :immediate_origin, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 14..23
  nacha_field :file_creation_date, inclusion: 'M', contents: 'YYMMDD', position: 24..29
  nacha_field :file_creation_time, inclusion: 'M', contents: 'HHMM', position: 30..33
  nacha_field :file_id_modifier, inclusion: 'M', contents: 'A-Z0-9', position: 34..34
  nacha_field :record_size, inclusion: 'M', contents: 'C094', position: 35..37
  nacha_field :blocking_factor, inclusion: 'M', contents: 'C10', position: 38..39
  nacha_field :format_code, inclusion: 'M', contents: 'C1', position: 40..40
  nacha_field :immediate_destination_name, inclusion: 'M',
    contents: 'Alphameric', position: 41..63
  nacha_field :immediate_origin_name, inclusion: 'M',
    contents: 'Alphameric', position: 64..86
  nacha_field :reference_code, inclusion: 'M', contents: 'CADV FILE', position: 87..94
end

#immediate_destination_name ⇒ String

Returns The name of the ACH Operator or receiving point to which the file is being sent.

Returns:

  • (String) —

    The name of the ACH Operator or receiving point to which the file is being sent.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/nacha/record/adv_file_header.rb', line 35

class AdvFileHeader < Nacha::Record::Base
  include FileHeaderRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C1', position: 1..1
  nacha_field :priority_code, inclusion: 'R', contents: 'Numeric', position: 2..3
  nacha_field :immediate_destination, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 4..13
  nacha_field :immediate_origin, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 14..23
  nacha_field :file_creation_date, inclusion: 'M', contents: 'YYMMDD', position: 24..29
  nacha_field :file_creation_time, inclusion: 'M', contents: 'HHMM', position: 30..33
  nacha_field :file_id_modifier, inclusion: 'M', contents: 'A-Z0-9', position: 34..34
  nacha_field :record_size, inclusion: 'M', contents: 'C094', position: 35..37
  nacha_field :blocking_factor, inclusion: 'M', contents: 'C10', position: 38..39
  nacha_field :format_code, inclusion: 'M', contents: 'C1', position: 40..40
  nacha_field :immediate_destination_name, inclusion: 'M',
    contents: 'Alphameric', position: 41..63
  nacha_field :immediate_origin_name, inclusion: 'M',
    contents: 'Alphameric', position: 64..86
  nacha_field :reference_code, inclusion: 'M', contents: 'CADV FILE', position: 87..94
end

#immediate_origin ⇒ Nacha::AbaNumber

Returns The routing number of the ACH Operator that is sending the file.

Returns:

  • (Nacha::AbaNumber) —

    The routing number of the ACH Operator that is sending the file.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/nacha/record/adv_file_header.rb', line 35

class AdvFileHeader < Nacha::Record::Base
  include FileHeaderRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C1', position: 1..1
  nacha_field :priority_code, inclusion: 'R', contents: 'Numeric', position: 2..3
  nacha_field :immediate_destination, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 4..13
  nacha_field :immediate_origin, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 14..23
  nacha_field :file_creation_date, inclusion: 'M', contents: 'YYMMDD', position: 24..29
  nacha_field :file_creation_time, inclusion: 'M', contents: 'HHMM', position: 30..33
  nacha_field :file_id_modifier, inclusion: 'M', contents: 'A-Z0-9', position: 34..34
  nacha_field :record_size, inclusion: 'M', contents: 'C094', position: 35..37
  nacha_field :blocking_factor, inclusion: 'M', contents: 'C10', position: 38..39
  nacha_field :format_code, inclusion: 'M', contents: 'C1', position: 40..40
  nacha_field :immediate_destination_name, inclusion: 'M',
    contents: 'Alphameric', position: 41..63
  nacha_field :immediate_origin_name, inclusion: 'M',
    contents: 'Alphameric', position: 64..86
  nacha_field :reference_code, inclusion: 'M', contents: 'CADV FILE', position: 87..94
end

#immediate_origin_name ⇒ String

Returns The name of the ACH Operator that is sending the file.

Returns:

  • (String) —

    The name of the ACH Operator that is sending the file.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/nacha/record/adv_file_header.rb', line 35

class AdvFileHeader < Nacha::Record::Base
  include FileHeaderRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C1', position: 1..1
  nacha_field :priority_code, inclusion: 'R', contents: 'Numeric', position: 2..3
  nacha_field :immediate_destination, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 4..13
  nacha_field :immediate_origin, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 14..23
  nacha_field :file_creation_date, inclusion: 'M', contents: 'YYMMDD', position: 24..29
  nacha_field :file_creation_time, inclusion: 'M', contents: 'HHMM', position: 30..33
  nacha_field :file_id_modifier, inclusion: 'M', contents: 'A-Z0-9', position: 34..34
  nacha_field :record_size, inclusion: 'M', contents: 'C094', position: 35..37
  nacha_field :blocking_factor, inclusion: 'M', contents: 'C10', position: 38..39
  nacha_field :format_code, inclusion: 'M', contents: 'C1', position: 40..40
  nacha_field :immediate_destination_name, inclusion: 'M',
    contents: 'Alphameric', position: 41..63
  nacha_field :immediate_origin_name, inclusion: 'M',
    contents: 'Alphameric', position: 64..86
  nacha_field :reference_code, inclusion: 'M', contents: 'CADV FILE', position: 87..94
end

#priority_code ⇒ Nacha::Numeric

Returns A code that indicates the processing priority of the file.

Returns:

  • (Nacha::Numeric) —

    A code that indicates the processing priority of the file.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/nacha/record/adv_file_header.rb', line 35

class AdvFileHeader < Nacha::Record::Base
  include FileHeaderRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C1', position: 1..1
  nacha_field :priority_code, inclusion: 'R', contents: 'Numeric', position: 2..3
  nacha_field :immediate_destination, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 4..13
  nacha_field :immediate_origin, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 14..23
  nacha_field :file_creation_date, inclusion: 'M', contents: 'YYMMDD', position: 24..29
  nacha_field :file_creation_time, inclusion: 'M', contents: 'HHMM', position: 30..33
  nacha_field :file_id_modifier, inclusion: 'M', contents: 'A-Z0-9', position: 34..34
  nacha_field :record_size, inclusion: 'M', contents: 'C094', position: 35..37
  nacha_field :blocking_factor, inclusion: 'M', contents: 'C10', position: 38..39
  nacha_field :format_code, inclusion: 'M', contents: 'C1', position: 40..40
  nacha_field :immediate_destination_name, inclusion: 'M',
    contents: 'Alphameric', position: 41..63
  nacha_field :immediate_origin_name, inclusion: 'M',
    contents: 'Alphameric', position: 64..86
  nacha_field :reference_code, inclusion: 'M', contents: 'CADV FILE', position: 87..94
end

#record_size ⇒ String

Returns The number of characters in each record of the file, which is always ‘094’.

Returns:

  • (String) —

    The number of characters in each record of the file, which is always ‘094’.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/nacha/record/adv_file_header.rb', line 35

class AdvFileHeader < Nacha::Record::Base
  include FileHeaderRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C1', position: 1..1
  nacha_field :priority_code, inclusion: 'R', contents: 'Numeric', position: 2..3
  nacha_field :immediate_destination, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 4..13
  nacha_field :immediate_origin, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 14..23
  nacha_field :file_creation_date, inclusion: 'M', contents: 'YYMMDD', position: 24..29
  nacha_field :file_creation_time, inclusion: 'M', contents: 'HHMM', position: 30..33
  nacha_field :file_id_modifier, inclusion: 'M', contents: 'A-Z0-9', position: 34..34
  nacha_field :record_size, inclusion: 'M', contents: 'C094', position: 35..37
  nacha_field :blocking_factor, inclusion: 'M', contents: 'C10', position: 38..39
  nacha_field :format_code, inclusion: 'M', contents: 'C1', position: 40..40
  nacha_field :immediate_destination_name, inclusion: 'M',
    contents: 'Alphameric', position: 41..63
  nacha_field :immediate_origin_name, inclusion: 'M',
    contents: 'Alphameric', position: 64..86
  nacha_field :reference_code, inclusion: 'M', contents: 'CADV FILE', position: 87..94
end

#record_type_code ⇒ String

Returns Identifies the record as an ADV File Header record with a constant value of ‘1’.

Returns:

  • (String) —

    Identifies the record as an ADV File Header record with a constant value of ‘1’.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/nacha/record/adv_file_header.rb', line 35

class AdvFileHeader < Nacha::Record::Base
  include FileHeaderRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C1', position: 1..1
  nacha_field :priority_code, inclusion: 'R', contents: 'Numeric', position: 2..3
  nacha_field :immediate_destination, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 4..13
  nacha_field :immediate_origin, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 14..23
  nacha_field :file_creation_date, inclusion: 'M', contents: 'YYMMDD', position: 24..29
  nacha_field :file_creation_time, inclusion: 'M', contents: 'HHMM', position: 30..33
  nacha_field :file_id_modifier, inclusion: 'M', contents: 'A-Z0-9', position: 34..34
  nacha_field :record_size, inclusion: 'M', contents: 'C094', position: 35..37
  nacha_field :blocking_factor, inclusion: 'M', contents: 'C10', position: 38..39
  nacha_field :format_code, inclusion: 'M', contents: 'C1', position: 40..40
  nacha_field :immediate_destination_name, inclusion: 'M',
    contents: 'Alphameric', position: 41..63
  nacha_field :immediate_origin_name, inclusion: 'M',
    contents: 'Alphameric', position: 64..86
  nacha_field :reference_code, inclusion: 'M', contents: 'CADV FILE', position: 87..94
end

#reference_code ⇒ String

Returns A reference code for the file, which is ‘ADV FILE’ for Automated Accounting Advices.

Returns:

  • (String) —

    A reference code for the file, which is ‘ADV FILE’ for Automated Accounting Advices.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/nacha/record/adv_file_header.rb', line 35

class AdvFileHeader < Nacha::Record::Base
  include FileHeaderRecordType

  nacha_field :record_type_code, inclusion: 'M', contents: 'C1', position: 1..1
  nacha_field :priority_code, inclusion: 'R', contents: 'Numeric', position: 2..3
  nacha_field :immediate_destination, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 4..13
  nacha_field :immediate_origin, inclusion: 'M',
    contents: 'bTTTTAAAAC', position: 14..23
  nacha_field :file_creation_date, inclusion: 'M', contents: 'YYMMDD', position: 24..29
  nacha_field :file_creation_time, inclusion: 'M', contents: 'HHMM', position: 30..33
  nacha_field :file_id_modifier, inclusion: 'M', contents: 'A-Z0-9', position: 34..34
  nacha_field :record_size, inclusion: 'M', contents: 'C094', position: 35..37
  nacha_field :blocking_factor, inclusion: 'M', contents: 'C10', position: 38..39
  nacha_field :format_code, inclusion: 'M', contents: 'C1', position: 40..40
  nacha_field :immediate_destination_name, inclusion: 'M',
    contents: 'Alphameric', position: 41..63
  nacha_field :immediate_origin_name, inclusion: 'M',
    contents: 'Alphameric', position: 64..86
  nacha_field :reference_code, inclusion: 'M', contents: 'CADV FILE', position: 87..94
end