lithic 0.21.0 → 0.23.0

data/lib/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rb

@@ -0,0 +1,279 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      module InstallmentPlans
+        # @see Lithic::Resources::FinancialAccounts::InstallmentPlans::Statements#retrieve
+        class InstallmentPlanStatement < Lithic::Internal::Type::BaseModel
+          # @!attribute token
+          #   Globally unique identifier for this snapshot, which is the token of the
+          #   statement it is attached to. A plan is snapshotted at most once per statement,
+          #   so the statement identifies the snapshot within the plan. Pass it as a
+          #   pagination cursor
+          #
+          #   @return [String]
+          required :token, String
+
+          # @!attribute fee_amount
+          #   Enrollment fee charged when the plan was created in cents
+          #
+          #   @return [Integer]
+          required :fee_amount, Integer
+
+          # @!attribute installment_plan_token
+          #   Globally unique identifier for the installment plan this snapshot is of
+          #
+          #   @return [String]
+          required :installment_plan_token, String
+
+          # @!attribute installment_plan_total
+          #   Total owed on the plan in cents, the principal amount plus the enrollment fee
+          #
+          #   @return [Integer]
+          required :installment_plan_total, Integer
+
+          # @!attribute installments
+          #   Installments that make up the plan, oldest first
+          #
+          #   @return [Array<Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment>]
+          required :installments,
+                   -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment] }
+
+          # @!attribute installments_outstanding
+          #   Number of installments that still carried a balance as of this statement
+          #
+          #   @return [Integer]
+          required :installments_outstanding, Integer
+
+          # @!attribute installments_paid
+          #   Number of installments that had been paid off as of this statement
+          #
+          #   @return [Integer]
+          required :installments_paid, Integer
+
+          # @!attribute num_installments
+          #   Number of installments the plan is broken into
+          #
+          #   @return [Integer]
+          required :num_installments, Integer
+
+          # @!attribute principal_amount
+          #   Balance the plan was opened on in cents, excluding the enrollment fee
+          #
+          #   @return [Integer]
+          required :principal_amount, Integer
+
+          # @!attribute source_type
+          #
+          #   @return [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType]
+          required :source_type,
+                   enum: -> { Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType }
+
+          # @!attribute start_date
+          #   Date the plan was created
+          #
+          #   @return [Date]
+          required :start_date, Date
+
+          # @!attribute state
+          #   State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan
+          #   tapes are being rebuilt, during which its payment totals are being recomputed
+          #   and should not be treated as final
+          #
+          #   @return [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State]
+          required :state, enum: -> { Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State }
+
+          # @!attribute total_paid
+          #   Amount paid towards the plan as of this statement in cents
+          #
+          #   @return [Integer]
+          required :total_paid, Integer
+
+          # @!method initialize(token:, fee_amount:, installment_plan_token:, installment_plan_total:, installments:, installments_outstanding:, installments_paid:, num_installments:, principal_amount:, source_type:, start_date:, state:, total_paid:)
+          #   Some parameter documentations has been truncated, see
+          #   {Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement}
+          #   for more details.
+          #
+          #   An immutable snapshot of an installment plan as of the statement it is attached
+          #   to. Lithic cuts one per open plan when a statement is generated and never
+          #   reissues it
+          #
+          #   @param token [String] Globally unique identifier for this snapshot, which is the token of the statemen
+          #
+          #   @param fee_amount [Integer] Enrollment fee charged when the plan was created in cents
+          #
+          #   @param installment_plan_token [String] Globally unique identifier for the installment plan this snapshot is of
+          #
+          #   @param installment_plan_total [Integer] Total owed on the plan in cents, the principal amount plus the enrollment fee
+          #
+          #   @param installments [Array<Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment>] Installments that make up the plan, oldest first
+          #
+          #   @param installments_outstanding [Integer] Number of installments that still carried a balance as of this statement
+          #
+          #   @param installments_paid [Integer] Number of installments that had been paid off as of this statement
+          #
+          #   @param num_installments [Integer] Number of installments the plan is broken into
+          #
+          #   @param principal_amount [Integer] Balance the plan was opened on in cents, excluding the enrollment fee
+          #
+          #   @param source_type [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType]
+          #
+          #   @param start_date [Date] Date the plan was created
+          #
+          #   @param state [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State] State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan tape
+          #
+          #   @param total_paid [Integer] Amount paid towards the plan as of this statement in cents
+
+          class Installment < Lithic::Internal::Type::BaseModel
+            # @!attribute amount_due
+            #   Amount the installment was opened for in cents
+            #
+            #   @return [Integer]
+            required :amount_due, Integer
+
+            # @!attribute amount_due_details
+            #
+            #   @return [Lithic::Models::FinancialAccounts::CategoryBalances]
+            required :amount_due_details, -> { Lithic::FinancialAccounts::CategoryBalances }
+
+            # @!attribute amount_outstanding
+            #   Amount still owed on the installment in cents
+            #
+            #   @return [Integer]
+            required :amount_outstanding, Integer
+
+            # @!attribute amount_outstanding_details
+            #
+            #   @return [Lithic::Models::FinancialAccounts::CategoryBalances]
+            required :amount_outstanding_details, -> { Lithic::FinancialAccounts::CategoryBalances }
+
+            # @!attribute amount_paid
+            #   Amount paid towards the installment in cents
+            #
+            #   @return [Integer]
+            required :amount_paid, Integer
+
+            # @!attribute amount_paid_details
+            #
+            #   @return [Lithic::Models::FinancialAccounts::CategoryBalances]
+            required :amount_paid_details, -> { Lithic::FinancialAccounts::CategoryBalances }
+
+            # @!attribute date_assessed
+            #   Date the installment was actually assessed onto the account, or null if it had
+            #   not been assessed as of this statement
+            #
+            #   @return [Date, nil]
+            required :date_assessed, Date, nil?: true
+
+            # @!attribute due_date
+            #   Date the installment is scheduled to be assessed onto the account
+            #
+            #   @return [Date]
+            required :due_date, Date
+
+            # @!attribute installment_num
+            #   Position of this installment within the plan, starting at 0
+            #
+            #   @return [Integer]
+            required :installment_num, Integer
+
+            # @!attribute payment_due_date
+            #   Date the installment must be paid by before it is considered past due
+            #
+            #   @return [Date]
+            required :payment_due_date, Date
+
+            # @!attribute payments
+            #   Payments applied to this installment, oldest first
+            #
+            #   @return [Array<Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment>]
+            required :payments,
+                     -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment] }
+
+            # @!method initialize(amount_due:, amount_due_details:, amount_outstanding:, amount_outstanding_details:, amount_paid:, amount_paid_details:, date_assessed:, due_date:, installment_num:, payment_due_date:, payments:)
+            #   Some parameter documentations has been truncated, see
+            #   {Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment}
+            #   for more details.
+            #
+            #   One installment of a plan as of the statement. Amounts are totalled across
+            #   transaction categories rather than broken out by them, which the installment
+            #   plan endpoint does
+            #
+            #   @param amount_due [Integer] Amount the installment was opened for in cents
+            #
+            #   @param amount_due_details [Lithic::Models::FinancialAccounts::CategoryBalances]
+            #
+            #   @param amount_outstanding [Integer] Amount still owed on the installment in cents
+            #
+            #   @param amount_outstanding_details [Lithic::Models::FinancialAccounts::CategoryBalances]
+            #
+            #   @param amount_paid [Integer] Amount paid towards the installment in cents
+            #
+            #   @param amount_paid_details [Lithic::Models::FinancialAccounts::CategoryBalances]
+            #
+            #   @param date_assessed [Date, nil] Date the installment was actually assessed onto the account, or null if it had n
+            #
+            #   @param due_date [Date] Date the installment is scheduled to be assessed onto the account
+            #
+            #   @param installment_num [Integer] Position of this installment within the plan, starting at 0
+            #
+            #   @param payment_due_date [Date] Date the installment must be paid by before it is considered past due
+            #
+            #   @param payments [Array<Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment>] Payments applied to this installment, oldest first
+
+            class Payment < Lithic::Internal::Type::BaseModel
+              # @!attribute amount
+              #   Amount applied to the installment in cents
+              #
+              #   @return [Integer]
+              required :amount, Integer
+
+              # @!attribute date
+              #   Date the payment was applied to the installment
+              #
+              #   @return [Date]
+              required :date, Date
+
+              # @!method initialize(amount:, date:)
+              #   @param amount [Integer] Amount applied to the installment in cents
+              #
+              #   @param date [Date] Date the payment was applied to the installment
+            end
+          end
+
+          # @see Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement#source_type
+          module SourceType
+            extend Lithic::Internal::Type::Enum
+
+            UNPAID_BALANCE = :UNPAID_BALANCE
+            TRANSACTION = :TRANSACTION
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan
+          # tapes are being rebuilt, during which its payment totals are being recomputed
+          # and should not be treated as final
+          #
+          # @see Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement#state
+          module State
+            extend Lithic::Internal::Type::Enum
+
+            PENDING = :PENDING
+            ACTIVE = :ACTIVE
+            REBUILD_IN_PROGRESS = :REBUILD_IN_PROGRESS
+            FULLY_PAID = :FULLY_PAID
+            CANCELLED = :CANCELLED
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+
+      InstallmentPlanStatement = InstallmentPlans::InstallmentPlanStatement
+    end
+  end
+end

data/lib/lithic/models/financial_accounts/installment_plans/statement_list_params.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      module InstallmentPlans
+        # @see Lithic::Resources::FinancialAccounts::InstallmentPlans::Statements#list
+        class StatementListParams < Lithic::Internal::Type::BaseModel
+          extend Lithic::Internal::Type::RequestParameters::Converter
+          include Lithic::Internal::Type::RequestParameters
+
+          # @!attribute financial_account_token
+          #   Globally unique identifier for financial account.
+          #
+          #   @return [String]
+          required :financial_account_token, String
+
+          # @!attribute installment_plan_token
+          #   Globally unique identifier for installment plan.
+          #
+          #   @return [String]
+          required :installment_plan_token, String
+
+          # @!attribute begin_
+          #   Date string in RFC 3339 format. Only entries created after the specified date
+          #   will be included.
+          #
+          #   @return [Date, nil]
+          optional :begin_, Date
+
+          # @!attribute end_
+          #   Date string in RFC 3339 format. Only entries created before the specified date
+          #   will be included.
+          #
+          #   @return [Date, nil]
+          optional :end_, Date
+
+          # @!attribute ending_before
+          #   A cursor representing an item's token before which a page of results should end.
+          #   Used to retrieve the previous page of results before this item.
+          #
+          #   @return [String, nil]
+          optional :ending_before, String
+
+          # @!attribute page_size
+          #   Page size (for pagination).
+          #
+          #   @return [Integer, nil]
+          optional :page_size, Integer
+
+          # @!attribute starting_after
+          #   A cursor representing an item's token after which a page of results should
+          #   begin. Used to retrieve the next page of results after this item.
+          #
+          #   @return [String, nil]
+          optional :starting_after, String
+
+          # @!attribute state
+          #   Only snapshots in which the plan was in this state will be included.
+          #
+          #   @return [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::StatementListParams::State, nil]
+          optional :state,
+                   enum: -> { Lithic::FinancialAccounts::InstallmentPlans::StatementListParams::State },
+                   nil?: true
+
+          # @!method initialize(financial_account_token:, installment_plan_token:, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, state: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Lithic::Models::FinancialAccounts::InstallmentPlans::StatementListParams} for
+          #   more details.
+          #
+          #   @param financial_account_token [String] Globally unique identifier for financial account.
+          #
+          #   @param installment_plan_token [String] Globally unique identifier for installment plan.
+          #
+          #   @param begin_ [Date] Date string in RFC 3339 format. Only entries created after the specified date wi
+          #
+          #   @param end_ [Date] Date string in RFC 3339 format. Only entries created before the specified date w
+          #
+          #   @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+          #
+          #   @param page_size [Integer] Page size (for pagination).
+          #
+          #   @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+          #
+          #   @param state [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::StatementListParams::State, nil] Only snapshots in which the plan was in this state will be included.
+          #
+          #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+
+          # Only snapshots in which the plan was in this state will be included.
+          module State
+            extend Lithic::Internal::Type::Enum
+
+            PENDING = :PENDING
+            ACTIVE = :ACTIVE
+            REBUILD_IN_PROGRESS = :REBUILD_IN_PROGRESS
+            FULLY_PAID = :FULLY_PAID
+            CANCELLED = :CANCELLED
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/financial_accounts/installment_plans/statement_retrieve_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      module InstallmentPlans
+        # @see Lithic::Resources::FinancialAccounts::InstallmentPlans::Statements#retrieve
+        class StatementRetrieveParams < Lithic::Internal::Type::BaseModel
+          extend Lithic::Internal::Type::RequestParameters::Converter
+          include Lithic::Internal::Type::RequestParameters
+
+          # @!attribute financial_account_token
+          #   Globally unique identifier for financial account.
+          #
+          #   @return [String]
+          required :financial_account_token, String
+
+          # @!attribute installment_plan_token
+          #   Globally unique identifier for installment plan.
+          #
+          #   @return [String]
+          required :installment_plan_token, String
+
+          # @!attribute statement_token
+          #   Globally unique identifier for statement.
+          #
+          #   @return [String]
+          required :statement_token, String
+
+          # @!method initialize(financial_account_token:, installment_plan_token:, statement_token:, request_options: {})
+          #   @param financial_account_token [String] Globally unique identifier for financial account.
+          #
+          #   @param installment_plan_token [String] Globally unique identifier for installment plan.
+          #
+          #   @param statement_token [String] Globally unique identifier for statement.
+          #
+          #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/financial_accounts/interest_tier_schedule.rb

@@ -21,20 +21,20 @@ module Lithic
         #   Custom rates per category for penalties
         #
         #   @return [Object, nil]
-        optional :penalty_rates, Lithic::Internal::Type::Unknown
+        optional :penalty_rates, Lithic::Internal::Type::Unknown, nil?: true
 
         # @!attribute tier_name
         #   Name of a tier contained in the credit product. Mutually exclusive with
         #   tier_rates
         #
         #   @return [String, nil]
-        optional :tier_name, String
+        optional :tier_name, String, nil?: true
 
         # @!attribute tier_rates
         #   Custom rates per category. Mutually exclusive with tier_name
         #
         #   @return [Object, nil]
-        optional :tier_rates, Lithic::Internal::Type::Unknown
+        optional :tier_rates, Lithic::Internal::Type::Unknown, nil?: true
 
         # @!method initialize(credit_product_token:, effective_date:, penalty_rates: nil, tier_name: nil, tier_rates: nil)
         #   Some parameter documentations has been truncated, see
@@ -47,11 +47,11 @@ module Lithic
         #
         #   @param effective_date [Date] Date the tier should be effective in YYYY-MM-DD format
         #
-        #   @param penalty_rates [Object] Custom rates per category for penalties
+        #   @param penalty_rates [Object, nil] Custom rates per category for penalties
         #
-        #   @param tier_name [String] Name of a tier contained in the credit product. Mutually exclusive with tier_rat
+        #   @param tier_name [String, nil] Name of a tier contained in the credit product. Mutually exclusive with tier_rat
         #
-        #   @param tier_rates [Object] Custom rates per category. Mutually exclusive with tier_name
+        #   @param tier_rates [Object, nil] Custom rates per category. Mutually exclusive with tier_name
       end
     end
   end

data/lib/lithic/models/financial_accounts/interest_tier_schedule_update_params.rb

@@ -22,20 +22,20 @@ module Lithic
         #   Custom rates per category for penalties
         #
         #   @return [Object, nil]
-        optional :penalty_rates, Lithic::Internal::Type::Unknown
+        optional :penalty_rates, Lithic::Internal::Type::Unknown, nil?: true
 
         # @!attribute tier_name
         #   Name of a tier contained in the credit product. Mutually exclusive with
         #   tier_rates
         #
         #   @return [String, nil]
-        optional :tier_name, String
+        optional :tier_name, String, nil?: true
 
         # @!attribute tier_rates
         #   Custom rates per category. Mutually exclusive with tier_name
         #
         #   @return [Object, nil]
-        optional :tier_rates, Lithic::Internal::Type::Unknown
+        optional :tier_rates, Lithic::Internal::Type::Unknown, nil?: true
 
         # @!method initialize(financial_account_token:, effective_date:, penalty_rates: nil, tier_name: nil, tier_rates: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
@@ -46,11 +46,11 @@ module Lithic
         #
         #   @param effective_date [Date]
         #
-        #   @param penalty_rates [Object] Custom rates per category for penalties
+        #   @param penalty_rates [Object, nil] Custom rates per category for penalties
         #
-        #   @param tier_name [String] Name of a tier contained in the credit product. Mutually exclusive with tier_rat
+        #   @param tier_name [String, nil] Name of a tier contained in the credit product. Mutually exclusive with tier_rat
         #
-        #   @param tier_rates [Object] Custom rates per category. Mutually exclusive with tier_name
+        #   @param tier_rates [Object, nil] Custom rates per category. Mutually exclusive with tier_name
         #
         #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/lithic/models/financial_accounts/loan_tape.rb

@@ -93,6 +93,14 @@ module Lithic
         #   @return [Lithic::Models::FinancialAccounts::LoanTape::PaymentAllocation]
         required :payment_allocation, -> { Lithic::FinancialAccounts::LoanTape::PaymentAllocation }
 
+        # @!attribute payment_only_allocation
+        #   Allocation of payments only, excluding credits
+        #
+        #   @return [Lithic::Models::FinancialAccounts::LoanTape::PaymentOnlyAllocation, nil]
+        required :payment_only_allocation,
+                 -> { Lithic::FinancialAccounts::LoanTape::PaymentOnlyAllocation },
+                 nil?: true
+
         # @!attribute period_totals
         #
         #   @return [Lithic::Models::StatementTotals]
@@ -138,7 +146,7 @@ module Lithic
         #   @return [String, nil]
         optional :tier, String, nil?: true
 
-        # @!method initialize(token:, account_standing:, available_credit:, balances:, created:, credit_limit:, credit_product_token:, date:, day_totals:, ending_balance:, excess_credits:, financial_account_token:, interest_details:, minimum_payment_balance:, payment_allocation:, period_totals:, previous_statement_balance:, starting_balance:, updated:, version:, ytd_totals:, day_of_period: nil, tier: nil)
+        # @!method initialize(token:, account_standing:, available_credit:, balances:, created:, credit_limit:, credit_product_token:, date:, day_totals:, ending_balance:, excess_credits:, financial_account_token:, interest_details:, minimum_payment_balance:, payment_allocation:, payment_only_allocation:, period_totals:, previous_statement_balance:, starting_balance:, updated:, version:, ytd_totals:, day_of_period: nil, tier: nil)
         #   Some parameter documentations has been truncated, see
         #   {Lithic::Models::FinancialAccounts::LoanTape} for more details.
         #
@@ -172,6 +180,8 @@ module Lithic
         #
         #   @param payment_allocation [Lithic::Models::FinancialAccounts::LoanTape::PaymentAllocation]
         #
+        #   @param payment_only_allocation [Lithic::Models::FinancialAccounts::LoanTape::PaymentOnlyAllocation, nil] Allocation of payments only, excluding credits
+        #
         #   @param period_totals [Lithic::Models::StatementTotals]
         #
         #   @param previous_statement_balance [Lithic::Models::FinancialAccounts::LoanTape::PreviousStatementBalance]
@@ -356,7 +366,13 @@ module Lithic
           #   @return [Lithic::Models::FinancialAccounts::CategoryBalances]
           required :past_statements_due, -> { Lithic::FinancialAccounts::CategoryBalances }
 
-          # @!method initialize(due:, next_statement_due:, past_due:, past_statements_due:)
+          # @!attribute installments
+          #   Amounts converted into installment plans
+          #
+          #   @return [Lithic::Models::FinancialAccounts::CategoryBalances, nil]
+          optional :installments, -> { Lithic::FinancialAccounts::CategoryBalances }, nil?: true
+
+          # @!method initialize(due:, next_statement_due:, past_due:, past_statements_due:, installments: nil)
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::FinancialAccounts::LoanTape::Balances} for more details.
           #
@@ -367,6 +383,8 @@ module Lithic
           #   @param past_due [Lithic::Models::FinancialAccounts::CategoryBalances] Amount not paid off on previous due dates
           #
           #   @param past_statements_due [Lithic::Models::FinancialAccounts::CategoryBalances] Amount due for the past billing cycles.
+          #
+          #   @param installments [Lithic::Models::FinancialAccounts::CategoryBalances, nil] Amounts converted into installment plans
         end
 
         # @see Lithic::Models::FinancialAccounts::LoanTape#interest_details
@@ -494,6 +512,57 @@ module Lithic
           #   @param principal_details [Lithic::Models::CategoryDetails, nil]
         end
 
+        # @see Lithic::Models::FinancialAccounts::LoanTape#payment_only_allocation
+        class PaymentOnlyAllocation < Lithic::Internal::Type::BaseModel
+          # @!attribute fee_details
+          #
+          #   @return [Lithic::Models::CategoryDetails, nil]
+          required :fee_details, -> { Lithic::CategoryDetails }, nil?: true
+
+          # @!attribute fees
+          #   Amount allocated to fees in cents
+          #
+          #   @return [Integer]
+          required :fees, Integer
+
+          # @!attribute interest
+          #   Amount allocated to interest in cents
+          #
+          #   @return [Integer]
+          required :interest, Integer
+
+          # @!attribute interest_details
+          #
+          #   @return [Lithic::Models::CategoryDetails, nil]
+          required :interest_details, -> { Lithic::CategoryDetails }, nil?: true
+
+          # @!attribute principal
+          #   Amount allocated to principal in cents
+          #
+          #   @return [Integer]
+          required :principal, Integer
+
+          # @!attribute principal_details
+          #
+          #   @return [Lithic::Models::CategoryDetails, nil]
+          required :principal_details, -> { Lithic::CategoryDetails }, nil?: true
+
+          # @!method initialize(fee_details:, fees:, interest:, interest_details:, principal:, principal_details:)
+          #   Allocation of payments only, excluding credits
+          #
+          #   @param fee_details [Lithic::Models::CategoryDetails, nil]
+          #
+          #   @param fees [Integer] Amount allocated to fees in cents
+          #
+          #   @param interest [Integer] Amount allocated to interest in cents
+          #
+          #   @param interest_details [Lithic::Models::CategoryDetails, nil]
+          #
+          #   @param principal [Integer] Amount allocated to principal in cents
+          #
+          #   @param principal_details [Lithic::Models::CategoryDetails, nil]
+        end
+
         # @see Lithic::Models::FinancialAccounts::LoanTape#previous_statement_balance
         class PreviousStatementBalance < Lithic::Internal::Type::BaseModel
           # @!attribute amount

data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb

@@ -151,6 +151,7 @@ module Lithic
               ACH = :ACH
               WIRE = :WIRE
               STABLECOIN = :STABLECOIN
+              INTRA_BANK = :INTRA_BANK
               BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
               FEE = :FEE
               REWARD = :REWARD
@@ -259,6 +260,9 @@ module Lithic
               INTEREST = :INTEREST
               INTEREST_REVERSAL = :INTEREST_REVERSAL
               INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT
+              INTRA_BANK_CANCELED = :INTRA_BANK_CANCELED
+              INTRA_BANK_INITIATED = :INTRA_BANK_INITIATED
+              INTRA_BANK_SETTLED = :INTRA_BANK_SETTLED
               LATE_PAYMENT = :LATE_PAYMENT
               LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL
               LOSS_WRITE_OFF = :LOSS_WRITE_OFF
@@ -287,6 +291,7 @@ module Lithic
               STABLECOIN_SENT = :STABLECOIN_SENT
               STABLECOIN_SETTLED = :STABLECOIN_SETTLED
               STABLECOIN_REJECTED = :STABLECOIN_REJECTED
+              INSTANCE_TO_INSTANCE = :INSTANCE_TO_INSTANCE
 
               # @!method self.values
               #   @return [Array<Symbol>]

data/lib/lithic/models/financial_event.rb

@@ -145,6 +145,9 @@ module Lithic
         INTEREST = :INTEREST
         INTEREST_REVERSAL = :INTEREST_REVERSAL
         INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT
+        INTRA_BANK_CANCELED = :INTRA_BANK_CANCELED
+        INTRA_BANK_INITIATED = :INTRA_BANK_INITIATED
+        INTRA_BANK_SETTLED = :INTRA_BANK_SETTLED
         LATE_PAYMENT = :LATE_PAYMENT
         LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL
         LOSS_WRITE_OFF = :LOSS_WRITE_OFF
@@ -173,6 +176,7 @@ module Lithic
         STABLECOIN_SENT = :STABLECOIN_SENT
         STABLECOIN_SETTLED = :STABLECOIN_SETTLED
         STABLECOIN_REJECTED = :STABLECOIN_REJECTED
+        INSTANCE_TO_INSTANCE = :INSTANCE_TO_INSTANCE
 
         # @!method self.values
         #   @return [Array<Symbol>]