Class: Increase::Models::BookkeepingAccountCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/increase/models/bookkeeping_account_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: ComplianceCategory

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(name: , account_id: nil, compliance_category: nil, entity_id: nil, request_options: {}) ⇒ Object

Parameters:

  • name (String) (defaults to: ) —

    The name you choose for the account.

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

    The account, if ‘compliance_category` is `commingled_cash`.

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

    The account compliance category.

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

    The entity, if ‘compliance_category` is `customer_balance`.

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/increase/models/bookkeeping_account_create_params.rb', line 34

Instance Attribute Details

#account_id ⇒ String?

The account, if ‘compliance_category` is `commingled_cash`.

Returns:

  • (String, nil) 


20
 
# File 'lib/increase/models/bookkeeping_account_create_params.rb', line 20

optional :account_id, String

#compliance_category ⇒ Symbol, ...

The account compliance category.

Returns:



26
 
# File 'lib/increase/models/bookkeeping_account_create_params.rb', line 26

optional :compliance_category, enum: -> { Increase::BookkeepingAccountCreateParams::ComplianceCategory }

#entity_id ⇒ String?

The entity, if ‘compliance_category` is `customer_balance`.

Returns:

  • (String, nil) 


32
 
# File 'lib/increase/models/bookkeeping_account_create_params.rb', line 32

optional :entity_id, String

#name ⇒ String

The name you choose for the account.

Returns:

  • (String) 


14
 
# File 'lib/increase/models/bookkeeping_account_create_params.rb', line 14

required :name, String