Class: ModernTreasury::Models::CounterpartyCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::CounterpartyCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/counterparty_create_params.rb

Overview

See Also:

• Resources::Counterparties#create

Defined Under Namespace

Modules: LedgerType Classes: Account, Accounting, LegalEntity

Instance Attribute Summary

• #accounting ⇒ ModernTreasury::Models::CounterpartyCreateParams::Accounting^? deprecated Deprecated.
• #accounts ⇒ Array<ModernTreasury::Models::CounterpartyCreateParams::Account>^?

  The accounts for this counterparty.

• #email ⇒ String^?

  The counterparty’s email.

• #external_id ⇒ String^?

  An optional user-defined 180 character unique identifier.

• #ledger_type ⇒ Symbol, ... deprecated Deprecated.
• #legal_entity ⇒ ModernTreasury::Models::CounterpartyCreateParams::LegalEntity^?
• #legal_entity_id ⇒ String^?

  The id of the legal entity.

• #metadata ⇒ Hash{Symbol=>String}^?

  Additional data represented as key-value pairs.

• #name ⇒ String^?

  A human friendly name for this counterparty.

• #send_remittance_advice ⇒ Boolean^?

  Send an email to the counterparty whenever an associated payment order is sent to the bank.

• #taxpayer_identifier ⇒ String^?

  Either a valid SSN or EIN.

• #verification_status ⇒ String^? deprecated Deprecated.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(name: , accounting: nil, accounts: nil, email: nil, external_id: nil, ledger_type: nil, legal_entity: nil, legal_entity_id: nil, metadata: nil, send_remittance_advice: nil, taxpayer_identifier: nil, verification_status: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see CounterpartyCreateParams for more details.

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: , accounting: nil, accounts: nil, email: nil, external_id: nil, ledger_type: nil, legal_entity: nil, legal_entity_id: nil, metadata: nil, send_remittance_advice: nil, taxpayer_identifier: nil, verification_status: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::CounterpartyCreateParams for more details.

Parameters:

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

  A human friendly name for this counterparty.

• accounting (ModernTreasury::Models::CounterpartyCreateParams::Accounting) (defaults to: nil)
• accounts (Array<ModernTreasury::Models::CounterpartyCreateParams::Account>) (defaults to: nil) —

  The accounts for this counterparty.

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

  The counterparty’s email.

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

  An optional user-defined 180 character unique identifier.

• ledger_type (Symbol, ModernTreasury::Models::CounterpartyCreateParams::LedgerType) (defaults to: nil) —

  An optional type to auto-sync the counterparty to your ledger. Either ‘customer`

• legal_entity (ModernTreasury::Models::CounterpartyCreateParams::LegalEntity) (defaults to: nil)
• legal_entity_id (String, nil) (defaults to: nil) —

  The id of the legal entity.

• metadata (Hash{Symbol=>String}) (defaults to: nil) —

  Additional data represented as key-value pairs. Both the key and value must be s

• send_remittance_advice (Boolean) (defaults to: nil) —

  Send an email to the counterparty whenever an associated payment order is sent t

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

  Either a valid SSN or EIN.

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

  The verification status of the counterparty.

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

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 89

Instance Attribute Details

#accounting ⇒ ModernTreasury::Models::CounterpartyCreateParams::Accounting^?

Deprecated.

Returns:

• (ModernTreasury::Models::CounterpartyCreateParams::Accounting, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 20

optional :accounting, -> { ModernTreasury::CounterpartyCreateParams::Accounting }

#accounts ⇒ Array<ModernTreasury::Models::CounterpartyCreateParams::Account>^?

The accounts for this counterparty.

Returns:

• (Array<ModernTreasury::Models::CounterpartyCreateParams::Account>, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 26

optional :accounts,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::CounterpartyCreateParams::Account] }

#email ⇒ String^?

The counterparty’s email.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 33

optional :email, String, nil?: true

#external_id ⇒ String^?

An optional user-defined 180 character unique identifier.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 39

optional :external_id, String, nil?: true

#ledger_type ⇒ Symbol, ...

Deprecated.

An optional type to auto-sync the counterparty to your ledger. Either ‘customer` or `vendor`.

Returns:

• (Symbol, ModernTreasury::Models::CounterpartyCreateParams::LedgerType, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 48

optional :ledger_type, enum: -> { ModernTreasury::CounterpartyCreateParams::LedgerType }

#legal_entity ⇒ ModernTreasury::Models::CounterpartyCreateParams::LegalEntity^?

Returns:

• (ModernTreasury::Models::CounterpartyCreateParams::LegalEntity, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 53

optional :legal_entity, -> { ModernTreasury::CounterpartyCreateParams::LegalEntity }

#legal_entity_id ⇒ String^?

The id of the legal entity.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 59

optional :legal_entity_id, String, nil?: true

#metadata ⇒ Hash{Symbol=>String}^?

Additional data represented as key-value pairs. Both the key and value must be strings.

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 66

optional :metadata, ModernTreasury::Internal::Type::HashOf[String]

#name ⇒ String^?

A human friendly name for this counterparty.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 14

required :name, String, nil?: true

#send_remittance_advice ⇒ Boolean^?

Send an email to the counterparty whenever an associated payment order is sent to the bank.

Returns:

• (Boolean, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 73

optional :send_remittance_advice, ModernTreasury::Internal::Type::Boolean

#taxpayer_identifier ⇒ String^?

Either a valid SSN or EIN.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 79

optional :taxpayer_identifier, String

#verification_status ⇒ String^?

Deprecated.

The verification status of the counterparty.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 87

optional :verification_status, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 144