Class: Increase::Models::BookkeepingEntrySet

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

Overview

See Also:

Defined Under Namespace

Modules: Type Classes: Entry

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: ) ⇒ Object

Parameters:

  • id (String) (defaults to: ) —

    The entry identifier.

  • account_id (String) (defaults to: ) —

    The bookkeeping account impacted by the entry.

  • amount (Integer) (defaults to: ) —

    The amount of the entry in minor units.




# File 'lib/increase/models/bookkeeping_entry_set.rb', line 94

Instance Attribute Details

#created_at ⇒ Time

When the entry set was created.

Returns:

  • (Time) 


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

required :created_at, Time

#date ⇒ Time

The timestamp of the entry set.

Returns:

  • (Time) 


23
 
# File 'lib/increase/models/bookkeeping_entry_set.rb', line 23

required :date, Time

#entries ⇒ Array<Increase::Models::BookkeepingEntrySet::Entry>

The entries.

Returns:



29
 
# File 'lib/increase/models/bookkeeping_entry_set.rb', line 29

required :entries, -> { Increase::Internal::Type::ArrayOf[Increase::BookkeepingEntrySet::Entry] }

#id ⇒ String

The entry set identifier.

Returns:

  • (String) 


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

required :id, String

#idempotency_key ⇒ String?

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


37
 
# File 'lib/increase/models/bookkeeping_entry_set.rb', line 37

required :idempotency_key, String, nil?: true

#transaction_id ⇒ String?

The transaction identifier, if any.

Returns:

  • (String, nil) 


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

required :transaction_id, String, nil?: true

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

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

Returns:



50
 
# File 'lib/increase/models/bookkeeping_entry_set.rb', line 50

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