<LOANRECURRINGTRANSACTION> - Sub Element of <LOAN>

Attribute Type Size REQ Default Comments
Operation String   NO ADD Valid Values:
ADD = Add a new recurring transaction (default)
DELETE = Delete a recurring transaction. Setting the Description tag to ALL will force a delete of all recurring transactions.
UPDATE = Only used for updating the EventExpireDate or EventMaxRepeat. Can only be used in conjunction with RowID, EventExpireDate, and EventMaxRepeat.5.29 - 5.36
UPDATE = Update a recurring transaction. All interdependent attributes can be updated. RowID is required.5.37+
Description String ≤50 Yes    
EventType Numeric 1 Yes   Valid Values:
0 = Scheduled
1 = Periodic
2 = Billing
3 = Daily Accrual
4 = On Post Payment
5 = On Pre Payment4.10.8+
EventStartDate Date   Yes   MM/dd/yyyy or as configured by the DATEFMT user defined parameter.
Must be ≥ Origination Date of Loan
StartDateDayValue Numeric 1 No   Valid Values:
0, 28, 29, 30, 31
Dependencies:
Valid only if EventType = 1 and EventPeriod = MO and EventStartDate is the last day of the Month and Month has less than 31 Days.
EventExpireDate Date   No   MM/dd/yyyy or as configured by the DATEFMT user defined parameter.
Dependencies:
Applies only if EventType = 1 (periodic).5.28-
Applies only if EventType = 1 (periodic), 2 (billing), 3 (accrual), 4 (on payment), or 5 (on pre payment).5.29+
EventPeriod String 2 No   Valid Values:
NA = Not Applicable (DEFAULT)
DA = Days
WE = Weekly
BW = Bi-Weekly
SM = Semi-Monthly
S4 = Semi-Monthly (14–day)
28 = 28–day
MO = Monthly
BM = Bi-Monthly
QU = Quarterly
SA = Semi-Annually
AN = Annually
MA = Maturity
Dependencies:
Applies only if EventType = 1
EventNumberOfPeriods Numeric 5 No   Dependencies:
Applies only if EventType = 1
EventMaxRepeat Numeric 9 No   Dependencies:
Applies only if EventType = 1 (periodic), 2 (billing), 4 (on payment), or 5 (on pre payment)
EventStatementCutoff Numeric 9 No   Valid Values:
Must be ≤ 0 and ≥ -31
EventTransactionDueDate5.20+
Date   No   MM/dd/yyyy or as configured by the DATEFMT user defined parameter.
When EventTransactionDueDate and EventStatementCutoff are provided, EventStartDate will be calculated.
When EventStartDate and EventStatementCutoff are provided, EventTransactionDueDate will be calculated.
TransactionType Numeric 9 Yes   Valid Values:
0 = Transaction Code
1 = Principal Due
2 = Interest Due
3 = Payment
4 = Servicing Fee
6 = Proportional Distribution5.22+
Dependencies:
If EventType = 3, this value must be set to 0.
TransactionCode Numeric 9 Y/N   Valid Values:
Any valid transaction code
Dependencies:
If EventType = 3, this value must be set to 0.
Applies only if TransactionType = 0
LateFeeSchedule Numeric 9 Y/N   Dependencies:
Applies only if TransactionType = 1 or 2
AmountType Numeric 9 No   Valid Values:
0 = Fixed Amount (DEFAULT)
1 = Percentage of Origination Amount
2 = Percentage of Current Principal
3 = Percentage of Current Interest
4 = Percentage of Credit Line
5 = Percentage of Unused Credit Line
6 = Percentage of Used Credit Line
7 = Percentage of Draw Limit
8 = Percentage of Unused Draw Limit
9 = Percentage of Used Draw Limit
10 = Percentage of Current Principal & Current Interest
11 = Percentage of Current Fees
12 = Percentage of Current Late Charges
13 = Percentage of Current UDB1
14 = Percentage of Current UDB2
15 = Percentage of Current UDB3
16 = Percentage of Current UDB4
17 = Percentage of Current UDB5
18 = Percentage of Current UDB6
19 = Percentage of Current UDB7
20 = Percentage of Current UDB8
21 = Percentage of Current UDB9
22 = Percentage of Current UDB10
23 = Percentage of Deferred Interest
24 = Percentage of Current Suspense
25 = Percentage of Current Suspense less Current Fees
26 = Percentage of Unbilled Interest
27 = Percentage of Last Calendar Month’s ADB
28 = Percentage of Total Payment Amount
29 = Percentage of Total Interest Payment Amount
30 = Percentage of Total Principal Payment Amount
31 = Percentage of Total Current Due
32 = Percentage of Total Past Due
33 = Percentage of Total Due
34 = Percentage of OLB 1
35 = Percentage of OLB 2
36 = Percentage of OLB 3
37 = Annual Percentage of Amortization Principal Balance
38 = Percentage of Impound Balance
39 = Annual Percentage of Impound Balance
40 = Use Lookup Table
41 = Percentage of Total Payment’s Base4.10.8+
42 = Percentage of Unbilled Fee Accrual4.10.7+
43 = Percentage of Total Past Due Principal5.7+
44 = Annual Percentage of Total Past Due Principal5.7+
45 = Percentage of Total Principal & Interest Overpayment5.13+
46 = Percentage of Billed Payment Amount5.21+
Percentage Numeric 8,5 No   Dependencies:
Applies only if AmountType ≠ 0
Amount Numeric 16,2 No   Dependencies:
Applies only if AmountType = 0
AmountMin Numeric 16,2 No    
AmountMax Numeric 16,2 No    
PaymentMethodNo5.31+
Numeric 9 No 0 Applies only if TransactionType = 0 (Transaction Code) or TransactionType = 3 (Payment). Does not work for EventType = 3 (Accrual).
PaymentMethodReference5.33+
String ≤50 No NULL Applies only if TransactionType = 0 (Transaction Code) or TransactionType = 3 (Payment). Does not work for EventType = 3 (Accrual).
PaymentMethodReference5.31 – 5.32
String ≤25 No NULL Applies only if TransactionType = 0 (Transaction Code) or TransactionType = 3 (Payment). Does not work for EventType = 3 (Accrual).
GLDebitAccount String   No    
GLCreditAccount String   No    
StatisticsCategory Numeric 2 No  
26 = Interest Earned5.7+
BalanceField Numeric 2 No  
14 = Interest5.7+
Notes String   No    
ServicingFeeType Numeric 1 No   Required if TransactionType = 4
0 = None
2 = Net from cash total outstanding
3 = Bill Lender
VendorID
VendorPayee
VendorAccountNumber 		Numeric
String
String		 10 No   Required if TransactionType = 4
OptionFlags Numeric 9 No   Valid Values:
0 = None
1 = Execute post accrual - 1 and 16 are mutually exclusive
2 = Reduce transaction amount to remaining credit line
4 = Calculate using total credit line
16 = Execute beginning of day - 1 and 16 are mutually exclusive
32 = Execute during payoff – applies only if EventType = 54.10.8+

Note: The option flags are defined as bits. To enable more than one option, add the values together.
Example: to enable “Reduce transaction amount to remaining credit line” and “Calculate using total credit line”, use 6 as the value.
LookupTableID
LookupTableName 		Numeric
String		 9     This option only applies when AmountType = 40
ProportionalDistributionNumerator5.22+
String 5 No   Required if TransactionType = 6
P = Principal
I = Interest
F = Fees
L = Late Charges
U1 = UDB1
U2 = UDB2
U3 = UDB3
U4 = UDB4
U5 = UDB5
U6 = UDB6
U7 = UDB7
U8 = UDB8
U9 = UDB9
U10 = UDB10
DI = Deferred Interest
IM = Impound
Only one selection is allowed.
ProportionalDistributionDenominator5.22+
String 50 No   Required if TransactionType = 6
P = Principal
I = Interest
F = Fees
L = Late Charges
U1 = UDB1
U2 = UDB2
U3 = UDB3
U4 = UDB4
U5 = UDB5
U6 = UDB6
U7 = UDB7
U8 = UDB8
U9 = UDB9
U10 = UDB10
DI = Deferred Interest
IM = Impound
Multiple selection is allowed, separated by a semicolon.
Example: ProportionalDistributionDenominator = "P;U1"
RowID5.29+
Numeric   No   Valid and required only when Operation = UPDATE.
MoveRow5.37+
Numeric   No   Moves the specified row up or down in the recurring transactions list.
1 = Move up one row.
-1 = Move down one row.

Example

To move RowID 11 up two rows, repeat the <LOANRECURRINGTRANSACTION> line:
<LOANRECURRINGTRANSACTION Operation="UPDATE" RowID="11" MoveRow="1" />
<LOANRECURRINGTRANSACTION Operation="UPDATE" RowID="11" MoveRow="1" />
SortOrderNo5.37.2+
Numeric   No   Sets the sort order of the specified recurring transaction by storing the specified value in loanacct_recurring_trans.rec_trans_no .

Example

To add recurring transactions in specified sort order:
<LOANRECURRINGTRANSACTION Operation="ADD" EventType="1" SortOrderNo="2" EventStartDate="11/20/2023" TransactionCode="100" Amount="101" />
<LOANRECURRINGTRANSACTION Operation="ADD" EventType="2" SortOrderNo="1" EventStartDate="11/21/2023" TransactionCode="50" Amount="102" />
<LOANRECURRINGTRANSACTION Operation="ADD" EventType="2" EventStartDate="11/21/2023" TransactionCode="50" Amount="103" />

To sort existing recurring transactions:
<LOANRECURRINGTRANSACTION RowID="12" Operation="UPDATE" EventType="1" SortOrderNo="3" Description="descr 1" EventStartDate="11/20/2023" TransactionCode="100" Amount="101" />
<LOANRECURRINGTRANSACTION RowID="13" Operation="UPDATE" EventType="2" SortOrderNo="2" Description="descr 2" EventStartDate="11/21/2023" TransactionCode="50" Amount="102" />
<LOANRECURRINGTRANSACTION RowID="14" Operation="UPDATE" EventType="2" SortOrderNo="1" Description="descr 3" EventStartDate="11/21/2023" TransactionCode="50" Amount="103" />