Class: Increase::Models::AccountStatement

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/account_statement.rb

Overview

See Also:

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Method Summary collapse

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(id: , account_id: , created_at: , ending_balance: , file_id: , starting_balance: , statement_period_end: , statement_period_start: , type: ) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::AccountStatement for more details.

Account Statements are generated monthly for every active Account. You can access the statement’s data via the API or retrieve a PDF with its details via its associated File.

Parameters:

  • id (String) (defaults to: ) —

    The Account Statement identifier.

  • account_id (String) (defaults to: ) —

    The identifier for the Account this Account Statement belongs to.

  • created_at (Time) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the Account

  • ending_balance (Integer) (defaults to: ) —

    The Account’s balance at the start of its statement period.

  • file_id (String) (defaults to: ) —

    The identifier of the File containing a PDF of the statement.

  • starting_balance (Integer) (defaults to: ) —

    The Account’s balance at the start of its statement period.

  • statement_period_end (Time) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time representing the end

  • statement_period_start (Time) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time representing the sta

  • type (Symbol, Increase::Models::AccountStatement::Type) (defaults to: ) —

    A constant representing the object’s type. For this resource it will always be ‘




# File 'lib/increase/models/account_statement.rb', line 65

Instance Attribute Details

#account_id ⇒ String

The identifier for the Account this Account Statement belongs to.

Returns:

  • (String) 


17
 
# File 'lib/increase/models/account_statement.rb', line 17

required :account_id, String

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the Account Statement was created.

Returns:

  • (Time) 


24
 
# File 'lib/increase/models/account_statement.rb', line 24

required :created_at, Time

#ending_balance ⇒ Integer

The Account’s balance at the start of its statement period.

Returns:

  • (Integer) 


30
 
# File 'lib/increase/models/account_statement.rb', line 30

required :ending_balance, Integer

#file_id ⇒ String

The identifier of the File containing a PDF of the statement.

Returns:

  • (String) 


36
 
# File 'lib/increase/models/account_statement.rb', line 36

required :file_id, String

#id ⇒ String

The Account Statement identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/account_statement.rb', line 11

required :id, String

#starting_balance ⇒ Integer

The Account’s balance at the start of its statement period.

Returns:

  • (Integer) 


42
 
# File 'lib/increase/models/account_statement.rb', line 42

required :starting_balance, Integer

#statement_period_end ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time representing the end of the period the Account Statement covers.

Returns:

  • (Time) 


49
 
# File 'lib/increase/models/account_statement.rb', line 49

required :statement_period_end, Time

#statement_period_start ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time representing the start of the period the Account Statement covers.

Returns:

  • (Time) 


56
 
# File 'lib/increase/models/account_statement.rb', line 56

required :statement_period_start, Time

#type ⇒ Symbol, Increase::Models::AccountStatement::Type

A constant representing the object’s type. For this resource it will always be ‘account_statement`.

Returns:



63
 
# File 'lib/increase/models/account_statement.rb', line 63

required :type, enum: -> { Increase::AccountStatement::Type }