feat(api): add interest_details properties to LoanTapes (#604)

lithic-com · Oct 23, 2024 · 365001b · 365001b
1 parent 7968257
commit 365001b
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 3 deletions.
diff --git a/src/lithic/types/financial_accounts/loan_tape.py b/src/lithic/types/financial_accounts/loan_tape.py
@@ -15,6 +15,10 @@
     "BalancesPastDue",
     "BalancesPastStatementsDue",
     "DayTotals",
+    "InterestDetails",
+    "InterestDetailsDailyBalanceAmounts",
+    "InterestDetailsEffectiveApr",
+    "InterestDetailsInterestForPeriod",
     "MinimumPaymentBalance",
     "PaymentAllocation",
     "PeriodTotals",
@@ -125,6 +129,46 @@ class DayTotals(BaseModel):
     """Net card transaction volume less any cash advances in cents"""
 
 
+class InterestDetailsDailyBalanceAmounts(BaseModel):
+    balance_transfers: str
+
+    cash_advances: str
+
+    purchases: str
+
+
+class InterestDetailsEffectiveApr(BaseModel):
+    balance_transfers: str
+
+    cash_advances: str
+
+    purchases: str
+
+
+class InterestDetailsInterestForPeriod(BaseModel):
+    balance_transfers: str
+
+    cash_advances: str
+
+    purchases: str
+
+
+class InterestDetails(BaseModel):
+    actual_interest_charged: Optional[int] = None
+
+    daily_balance_amounts: InterestDetailsDailyBalanceAmounts
+
+    effective_apr: InterestDetailsEffectiveApr
+
+    interest_calculation_method: Literal["DAILY", "AVERAGE_DAILY"]
+
+    interest_for_period: InterestDetailsInterestForPeriod
+
+    prime_rate: Optional[str] = None
+
+    minimum_interest_charged: Optional[int] = None
+
+
 class MinimumPaymentBalance(BaseModel):
     amount: int
 
@@ -240,6 +284,8 @@ class LoanTape(BaseModel):
     financial_account_token: str
     """Globally unique identifier for a financial account"""
 
+    interest_details: Optional[InterestDetails] = None
+
     minimum_payment_balance: MinimumPaymentBalance
 
     payment_allocation: PaymentAllocation

diff --git a/src/lithic/types/financial_accounts/statement.py b/src/lithic/types/financial_accounts/statement.py
@@ -131,7 +131,7 @@ class InterestDetailsInterestForPeriod(BaseModel):
 
 
 class InterestDetails(BaseModel):
-    actual_interest_charged: int
+    actual_interest_charged: Optional[int] = None
 
     daily_balance_amounts: InterestDetailsDailyBalanceAmounts
 
@@ -141,10 +141,10 @@ class InterestDetails(BaseModel):
 
     interest_for_period: InterestDetailsInterestForPeriod
 
-    minimum_interest_charged: Optional[int] = None
-
     prime_rate: Optional[str] = None
 
+    minimum_interest_charged: Optional[int] = None
+
 
 class Statement(BaseModel):
     token: str