Class: Lithic::Models::FinancialAccounts::Statement

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Lithic::Models::FinancialAccounts::Statement

Defined in:

lib/lithic/models/financial_accounts/statement.rb

Overview

See Also:

• Resources::FinancialAccounts::Statements#retrieve

Direct Known Subclasses

StatementsCreatedWebhookEvent

Defined Under Namespace

Modules: StatementType Classes: AccountStanding, AmountDue, InterestDetails, PayoffDetails

Instance Attribute Summary

• #account_standing ⇒ Lithic::Models::FinancialAccounts::Statement::AccountStanding
• #amount_due ⇒ Lithic::Models::FinancialAccounts::Statement::AmountDue
• #available_credit ⇒ Integer

  Amount of credit available to spend in cents.

• #created ⇒ Time

  Timestamp of when the statement was created.

• #credit_limit ⇒ Integer

  This is the maximum credit balance extended by the lender in cents.

• #credit_product_token ⇒ String

  Globally unique identifier for a credit product.

• #days_in_billing_cycle ⇒ Integer

  Number of days in the billing cycle.

• #ending_balance ⇒ Integer

  Balance at the end of the billing period.

• #financial_account_token ⇒ String

  Globally unique identifier for a financial account.

• #interest_details ⇒ Lithic::Models::FinancialAccounts::Statement::InterestDetails^?
• #next_payment_due_date ⇒ Date^?

  Date when the next payment is due.

• #next_statement_end_date ⇒ Date^?

  Date when the next billing period will end.

• #payment_due_date ⇒ Date^?

  Date when the payment is due.

• #payoff_details ⇒ Lithic::Models::FinancialAccounts::Statement::PayoffDetails^?

  Details on number and size of payments to pay off balance.

• #period_totals ⇒ Lithic::Models::StatementTotals
• #starting_balance ⇒ Integer

  Balance at the start of the billing period.

• #statement_end_date ⇒ Date

  Date when the billing period ended.

• #statement_start_date ⇒ Date

  Date when the billing period began.

• #statement_type ⇒ Symbol, Lithic::Models::FinancialAccounts::Statement::StatementType
• #token ⇒ String

  Globally unique identifier for a statement.

• #updated ⇒ Time

  Timestamp of when the statement was updated.

• #ytd_totals ⇒ Lithic::Models::StatementTotals

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(amount:, past_due:) ⇒ Object constructor

  Some parameter documentations has been truncated, see AmountDue for more details.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(amount:, past_due:) ⇒ Object

Some parameter documentations has been truncated, see AmountDue for more details.

Parameters:

• amount (Integer) —

  Payment due at the end of the billing period in cents. Negative amount indicates

• past_due (Integer) —

  Amount past due for statement in cents

# File 'lib/lithic/models/financial_accounts/statement.rb', line 135

Instance Attribute Details

#account_standing ⇒ Lithic::Models::FinancialAccounts::Statement::AccountStanding

Returns:

• (Lithic::Models::FinancialAccounts::Statement::AccountStanding)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 17

required :account_standing, -> { Lithic::FinancialAccounts::Statement::AccountStanding }

#amount_due ⇒ Lithic::Models::FinancialAccounts::Statement::AmountDue

Returns:

• (Lithic::Models::FinancialAccounts::Statement::AmountDue)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 22

required :amount_due, -> { Lithic::FinancialAccounts::Statement::AmountDue }

#available_credit ⇒ Integer

Amount of credit available to spend in cents

Returns:

• (Integer)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 28

required :available_credit, Integer

#created ⇒ Time

Timestamp of when the statement was created

Returns:

• (Time)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 34

required :created, Time

#credit_limit ⇒ Integer

This is the maximum credit balance extended by the lender in cents

Returns:

• (Integer)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 40

required :credit_limit, Integer

#credit_product_token ⇒ String

Globally unique identifier for a credit product

Returns:

• (String)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 46

required :credit_product_token, String

#days_in_billing_cycle ⇒ Integer

Number of days in the billing cycle

Returns:

• (Integer)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 52

required :days_in_billing_cycle, Integer

#ending_balance ⇒ Integer

Balance at the end of the billing period. For charge cards, this should be the same at the statement amount due in cents

Returns:

• (Integer)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 59

required :ending_balance, Integer

#financial_account_token ⇒ String

Globally unique identifier for a financial account

Returns:

• (String)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 65

required :financial_account_token, String

#interest_details ⇒ Lithic::Models::FinancialAccounts::Statement::InterestDetails^?

Returns:

• (Lithic::Models::FinancialAccounts::Statement::InterestDetails, nil)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 115

optional :interest_details, -> { Lithic::FinancialAccounts::Statement::InterestDetails }, nil?: true

#next_payment_due_date ⇒ Date^?

Date when the next payment is due

Returns:

• (Date, nil)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 121

optional :next_payment_due_date, Date

#next_statement_end_date ⇒ Date^?

Date when the next billing period will end

Returns:

• (Date, nil)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 127

optional :next_statement_end_date, Date

#payment_due_date ⇒ Date^?

Date when the payment is due

Returns:

• (Date, nil)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 71

required :payment_due_date, Date, nil?: true

#payoff_details ⇒ Lithic::Models::FinancialAccounts::Statement::PayoffDetails^?

Details on number and size of payments to pay off balance

Returns:

• (Lithic::Models::FinancialAccounts::Statement::PayoffDetails, nil)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 133

optional :payoff_details, -> { Lithic::FinancialAccounts::Statement::PayoffDetails }, nil?: true

#period_totals ⇒ Lithic::Models::StatementTotals

Returns:

• (Lithic::Models::StatementTotals)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 76

required :period_totals, -> { Lithic::StatementTotals }

#starting_balance ⇒ Integer

Balance at the start of the billing period

Returns:

• (Integer)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 82

required :starting_balance, Integer

#statement_end_date ⇒ Date

Date when the billing period ended

Returns:

• (Date)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 88

required :statement_end_date, Date

#statement_start_date ⇒ Date

Date when the billing period began

Returns:

• (Date)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 94

required :statement_start_date, Date

#statement_type ⇒ Symbol, Lithic::Models::FinancialAccounts::Statement::StatementType

Returns:

• (Symbol, Lithic::Models::FinancialAccounts::Statement::StatementType)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 99

required :statement_type, enum: -> { Lithic::FinancialAccounts::Statement::StatementType }

#token ⇒ String

Globally unique identifier for a statement

Returns:

• (String)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 12

required :token, String

#updated ⇒ Time

Timestamp of when the statement was updated

Returns:

• (Time)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 105

required :updated, Time

#ytd_totals ⇒ Lithic::Models::StatementTotals

Returns:

• (Lithic::Models::StatementTotals)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 110

required :ytd_totals, -> { Lithic::StatementTotals }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/lithic/models/financial_accounts/statement.rb', line 316