Class: Increase::Models::BookkeepingEntry

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/bookkeeping_entry.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: , amount: , created_at: , entry_set_id: , type: ) ⇒ Object

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

Entries are T-account entries recording debits and credits. Your compliance setup might require annotating money movements using this API. Learn more in our [guide to Bookkeeping](increase.com/documentation/bookkeeping#bookkeeping).

Parameters:

  • id (String) (defaults to: ) —

    The entry identifier.

  • account_id (String) (defaults to: ) —

    The identifier for the Account the Entry belongs to.

  • amount (Integer) (defaults to: ) —

    The Entry amount in the minor unit of its currency. For dollars, for example, th

  • created_at (Time) (defaults to: ) —

    When the entry set was created.

  • entry_set_id (String) (defaults to: ) —

    The identifier for the Account the Entry belongs to.

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

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




# File 'lib/increase/models/bookkeeping_entry.rb', line 45

Instance Attribute Details

#account_id ⇒ String

The identifier for the Account the Entry belongs to.

Returns:

  • (String) 


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

required :account_id, String

#amount ⇒ Integer

The Entry amount in the minor unit of its currency. For dollars, for example, this is cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#created_at ⇒ Time

When the entry set was created.

Returns:

  • (Time) 


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

required :created_at, Time

#entry_set_id ⇒ String

The identifier for the Account the Entry belongs to.

Returns:

  • (String) 


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

required :entry_set_id, String

#id ⇒ String

The entry identifier.

Returns:

  • (String) 


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

required :id, String

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

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

Returns:



43
 
# File 'lib/increase/models/bookkeeping_entry.rb', line 43

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