Class: Increase::Models::BookkeepingBalanceLookup

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/bookkeeping_balance_lookup.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(balance: , bookkeeping_account_id: , type: ) ⇒ Object

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

Represents a request to lookup the balance of an Bookkeeping Account at a given point in time.

Parameters:

  • balance (Integer) (defaults to: ) —

    The Bookkeeping Account’s current balance, representing the sum of all Bookkeepi

  • bookkeeping_account_id (String) (defaults to: ) —

    The identifier for the account for which the balance was queried.

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

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




# File 'lib/increase/models/bookkeeping_balance_lookup.rb', line 27

Instance Attribute Details

#balance ⇒ Integer

The Bookkeeping Account’s current balance, representing the sum of all Bookkeeping Entries on the Bookkeeping Account.

Returns:

  • (Integer) 


12
 
# File 'lib/increase/models/bookkeeping_balance_lookup.rb', line 12

required :balance, Integer

#bookkeeping_account_id ⇒ String

The identifier for the account for which the balance was queried.

Returns:

  • (String) 


18
 
# File 'lib/increase/models/bookkeeping_balance_lookup.rb', line 18

required :bookkeeping_account_id, String

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

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

Returns:



25
 
# File 'lib/increase/models/bookkeeping_balance_lookup.rb', line 25

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