NAME
Finance::AMEX::Transaction::EPPRC::Detail::RecordSummaryPricing - Parse AMEX Transaction/Invoice Level Reconciliation (EPPRC) Record of Charge (ROC) Level Pricing Record Rows
VERSION
version 0.001
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 'ROC_PRICING') {
print $record->FEE_CODE . "\n";
}
}
# to parse a single line
my $record = $epraw->parse_line('line from an EPPRC file');
if ($record->type eq 'ROC_PRICING') {
...
}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::Detail::RecordSummaryPricing object.
my $record = Finance::AMEX::Transaction::EPPRC::Detail::RecordSummaryPricing->new(line => $line);type
This will always return the string ROC_PRICING.
print $record->type; # ROC_PRICINGline
Returns the full line that is represented by this object.
print $record->line;AMEX_PAYEE_NUMBER
This field contains the Service Establishment (SE) Number of the merchant that received the payment from American Express.
Note: SE Numbers are assigned by American Express.
AMEX_SE_NUMBER
This field contains the Service Establishment (SE) Number of the merchant being reconciled, which may not necessarily be the same SE receiving payment (see AMEX_PAYEE_NUMBER).
This is the SE Number under which the transactions were submitted, which usually corresponds to the physical location.
SE_UNIT_NUMBER
This field contains the merchant-assigned SE Unit Number (usually an internal, store identifier code) that corresponds to a specific store or location.
If no value is assigned, this field is character space filled.
PAYMENT_YEAR
This field contains the Payment Year that corresponds to the entry in the Julian Date subfield of PAYMENT_NUMBER.
PAYMENT_NUMBER
This field contains the Payment Number, a reference number used by the American Express Payee to reconcile the daily settlement to the daily payment.
PAYMENT_NUMBER_DATE
The Julian date of the payment.
PAYMENT_NUMBER_TYPE
An alpha character assigned by the American Express settlement system.
PAYMENT_NUMBER_NUMBER
The Number of the payment.
RECORD_TYPE
This field contains the constant literal “3”, a Record Type code that indicates that this is a Record of Charge (ROC) Detail Record.
DETAIL_RECORD_TYPE
This field contains the Detail Record Type code that indicates the type of record used in this transaction. For Record of Charge (ROC) Level Pricing Records, this entry is always “13”.
FEE_CODE
This field contains a Fee Code that corresponds to preceding ROC Detail Record. For valid ROC Level Pricing Record Fee Codes, see below.
Sr. No. Fee Code Fee Description
1 CB CHGBCK FEE
2 CC CHARGE
3 CF CREDIT FEE
4 CK CHECK FEE
5 CN NONSWIPED
6 CO CORPORATE
7 CR RET DSC CR
8 CS CROC SBI
9 C1 RDR CAP
10 DB DEBIT CARD
11 DC D/C TERMNL
12 DD DIRECT DEP
13 DF DSPUTE FEE
14 E1 CPC EIPP
15 E2 CPC EIPP2
16 E3 CPC EIPP3
17 FF FLAT FEE
18 GG RET DSC GG
19 G1 HIROC CHG
20 G2 HIROC CHG2
21 G3 HIROC CHG3
22 HC H-NONSWIPE
23 HI HIGH ROC
24 JC JCB CARD
25 MI MICRO MRCH
26 MM MONMIN FEE
27 MN MNTHLY FEE
28 MR MEMBERSHIP
29 NA REGULAR SUBMISSION
30 NC NONCOMPLIA
31 OP REVOLVING
32 O1 HIROC COR
33 O2 HIROC COR2
34 O3 HIROC COR3
35 PA PAPER(SOC)
36 PC PURCH CARD
37 PI APCD PRC
38 PL PAYFLW LNK
39 PP PAYFLW PRO
40 P1 HIROC PUR
41 P2 HIROC PUR2
42 P3 HIROC PUR3
43 QU QUTRLY FEE
44 RD RETAIN DSC
45 RO RDR OPTOUT
46 R1 HIROC REG
47 R2 HIROC REG2
48 R3 HIROC REG3
49 SB SBI
50 SE SETUP FEE
51 SM SM MERCHNT
52 ST STATEMENT
53 SV STORED VAL
54 TR TRANS CNT
55 VA VOICE AUTH
56 VG GATEWAY
57 X1 CORP EIPP
58 X2 CORP EIPP2
59 X3 CORP EIPP3
60 YR YEARLY FEEFEE_DESCRIPTION
This field contains the Fee Description that corresponds to the amount in FEE_CODE.
DISCOUNT_RATE
This field contains the Discount Rate (decimal place value) used to calculate the amount American Express charged a merchant for the services that correspond to the preceding ROC Detail Record.
This value may be a debit or credit rate. The format is a 1-digit “sign”, followed by an 8-digit “rate”.
For a debit (a negative rate), the first position is a minus sign; and a “negative .003 (.3%)” would appear as:
0
123456789
-00000300For a credit (a positive rate), the first position is a plus sign; and a “positive .003 (.3%)” would appear as:
0
123456789
+00000300If unused, position 1 in this field contains a character space; and the remaining positions are zero filled.
DISCOUNT_AMOUNT
This field contains the Discount Amount that American Express charged a merchant for the services that correspond to the preceding ROC Detail Record.
This value may be a debit or credit amount; and the format is a 1-digit “sign”, followed by a 14-digit “dollar amount”.
For a debit (a negative amount), the first position is a minus sign; and a “negative $1005.05” would appear as:
0 1
123456789012345
-00000000100505For a credit (a positive amount), the first position is a plus sign; and a “positive $1005.05” would appear as:
0 1
123456789012345
+00000000100505If unused, position 1 in this field contains a character space; and the remaining positions are zero filled.
FEE_RATE
This field contains the Fee Rate (decimal place value) used to calculate the amount American Express charged a merchant for a fee (described in the FEE_CODE and FEE_DESCRIPTION fields in this record) that corresponds to the preceding ROC Detail Record. For more information, see pages FEE_CODE and FEE_DESCRIPTION.
This value may be a debit or credit rate. The format is a 1-digit “sign”, followed by an 8-digit “rate”.
See examples of negative and positive entries in DISCOUNT_RATE.
If unused, position 1 in this field contains a character space; and the remaining positions are zero filled.
FEE_AMOUNT
This field contains the Fee Amount American Express charged a merchant for a fee (described in the FEE_CODE and FEE_DESCRIPTION fields in this record) that corresponds to the preceding ROC Detail Record. For more information, see FEE_CODE and FEE_DESCRIPTION.
This value may be a debit or credit amount. The format is a 1-digit “sign”, followed by a 14-digit “amount”.
See examples of negative and positive entries in DISCOUNT_AMOUNT.
If unused, position 1 in this field contains a character space; and the remaining positions are zero filled.
MERCHANT_ID
This field contains the external, third party Service Agent Merchant ID number when applicable.
NAME
Finance::AMEX::Transaction::EPPRC::Detail::RecordSummaryPricing - Object methods for AMEX Transaction/Invoice (ROC) level pricing records.
AUTHOR
Tom Heady <theady@ziprecruiter.com>
COPYRIGHT AND LICENSE
This software is copyright (c) 2018 by ZipRecruiter.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.