Class: Increase::Models::BookkeepingAccount

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

Overview

See Also:

Defined Under Namespace

Modules: ComplianceCategory, Type

Instance Attribute Summary collapse

Class Method 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: , compliance_category: , entity_id: , idempotency_key: , name: , type: ) ⇒ Object

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

Accounts are T-accounts. They can store accounting entries. 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 account identifier.

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

    The API Account associated with this bookkeeping account.

  • compliance_category (Symbol, Increase::Models::BookkeepingAccount::ComplianceCategory, nil) (defaults to: ) —

    The compliance category of the account.

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

    The Entity associated with this bookkeeping account.

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

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

  • name (String) (defaults to: ) —

    The name you choose for the account.

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

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




# File 'lib/increase/models/bookkeeping_account.rb', line 52

Instance Attribute Details

#account_id ⇒ String?

The API Account associated with this bookkeeping account.

Returns:

  • (String, nil) 


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

required :account_id, String, nil?: true

#compliance_category ⇒ Symbol, ...

The compliance category of the account.

Returns:



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

required :compliance_category, enum: -> { Increase::BookkeepingAccount::ComplianceCategory }, nil?: true

#entity_id ⇒ String?

The Entity associated with this bookkeeping account.

Returns:

  • (String, nil) 


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

required :entity_id, String, nil?: true

#id ⇒ String

The account identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/bookkeeping_account.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_account.rb', line 37

required :idempotency_key, String, nil?: true

#name ⇒ String

The name you choose for the account.

Returns:

  • (String) 


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

required :name, String

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

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

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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