Class: Increase::Models::BookkeepingEntrySet::Entry

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

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: , created_at: , date: , entries: , idempotency_key: , transaction_id: , type: ) ⇒ Object

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

Entry Sets are accounting entries that are transactionally applied. 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 set identifier.

  • created_at (Time) (defaults to: ) —

    When the entry set was created.

  • date (Time) (defaults to: ) —

    The timestamp of the entry set.

  • entries (Array<Increase::Models::BookkeepingEntrySet::Entry>) (defaults to: ) —

    The entries.

  • idempotency_key (String, nil) (defaults to: ) —

    The idempotency key you chose for this object. This value is unique across Incre

  • transaction_id (String, nil) (defaults to: ) —

    The transaction identifier, if any.

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

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/increase/models/bookkeeping_entry_set.rb', line 75

class Entry < Increase::Internal::Type::BaseModel
  # @!attribute id
  #   The entry identifier.
  #
  #   @return [String]
  required :id, String

  # @!attribute account_id
  #   The bookkeeping account impacted by the entry.
  #
  #   @return [String]
  required :account_id, String

  # @!attribute amount
  #   The amount of the entry in minor units.
  #
  #   @return [Integer]
  required :amount, Integer

  # @!method initialize(id:, account_id:, amount:)
  #   @param id [String] The entry identifier.
  #
  #   @param account_id [String] The bookkeeping account impacted by the entry.
  #
  #   @param amount [Integer] The amount of the entry in minor units.
end

Instance Attribute Details

#account_id ⇒ String

The bookkeeping account impacted by the entry.

Returns:

  • (String) 


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

required :account_id, String

#amount ⇒ Integer

The amount of the entry in minor units.

Returns:

  • (Integer) 


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

required :amount, Integer

#id ⇒ String

The entry identifier.

Returns:

  • (String) 


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

required :id, String