From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

 / 
Finance-AMEX-Transaction-0.005
River stage zero No dependents
/ Finance::AMEX::Transaction::EPPRC::Header

NAME

Finance::AMEX::Transaction::EPPRC::Header - Parse AMEX Transaction/Invoice Level Reconciliation (EPPRC) Header Rows

VERSION

version 0.005

SYNOPSIS


            

              
              
use Finance::AMEX::Transaction;
my $epraw = Finance::AMEX::Transaction->new(file_type => 'EPPRC');
open my $fh, '<', '/path to EPPRC file' or die "cannot open EPPRC file: $!";
while (my $record = $epraw->getline($fh)) {
 if ($record->type eq 'HEADER') {
   print $record->DF_HDR_DATE . "\n";
 }
}
# to parse a single line
my $record = $epraw->parse_line('line from an EPPRC  file');
if ($record->type eq 'HEADER') {
  ...
}

DESCRIPTION

You would not normally be calling this module directly, it is one of the possible return objects from a call to Finance::AMEX::Transaction's getline method.

METHODS

new

Returns a new Finance::AMEX::Transaction::EPPRC::Header object.


            

              
              
my $record = Finance::AMEX::Transaction::EPPRC::Header->new(line => $line);

type

This will always return the string HEADER.


            

              
              
print $record->type; # HEADER

line

Returns the full line that is represented by this object.


            

              
              
print $record->line;

field_map

Returns a hashref where the name is the record name and the value is an arrayref of the start position and length of that field.


            

              
              
# print the start position of the DF_HDR_DATE field
print $record->field_map->{DF_HDR_DATE}->[0]; # 6

DF_HDR_RECORD_TYPE

This field contains the constant literal “DFHDR”, a Record Type code that indicates that this is a Data File Header Record.

DF_HDR_DATE

This field contains the File Creation Date. The format is: MMDDYYYY

MM = Month
DD = Day
YYYY = Year

DF_HDR_TIME

This field contains the File Creation Time (24-hour format), when the file was created.

The format is: HHMM

HH = Hours
MM = Minutes

DF_HDR_FILE_ID

This field may contain an American Express, system-generated, File ID number that uniquely identifies this data file.

If unused, this field is zero filled.

DF_HDR_FILE_NAME

This field may contain a File Name (as entered in the American Express data distribution database) that corresponds to DF_HDR_FILE_ID. Alternately, it may be populated with the first line of settlement name/address data.

NAME

Finance::AMEX::Transaction::EPPRC::Header - Object methods for AMEX Reconciliation file header records.

AUTHOR

Tom Heady <cpan@punch.net>

COPYRIGHT AND LICENSE

This software is copyright (c) 2022 by ZipRecruiter/Tom Heady.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.