Class: Increase::Models::EntityCreateParams::Corporation::LegalIdentifier

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Increase::Models::EntityCreateParams::Corporation::LegalIdentifier

Defined in:

lib/increase/models/entity_create_params.rb,
sig/increase/models/entity_create_params.rbs

Overview

See Also:

• Increase::Models::EntityCreateParams::Corporation#legal_identifier

Defined Under Namespace

Modules: Category

Instance Attribute Summary

• #category ⇒ Symbol, ...

  The category of the legal identifier.

• #value ⇒ String

  The legal identifier itself.

Instance Method Summary

• #initialize(value:, category: nil) ⇒ Object constructor

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

• #to_hash ⇒ {

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(value:, category: nil) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::EntityCreateParams::Corporation::LegalIdentifier for more details.

The legal identifier of the corporation. This is usually the Employer Identification Number (EIN). This replaces the deprecated tax_identifier field.

Parameters:

• value (String) —

  The legal identifier itself. For US Employer Identification Numbers, submit nine

• category (Symbol, Increase::Models::EntityCreateParams::Corporation::LegalIdentifier::Category) (defaults to: nil) —

  The category of the legal identifier. If not provided, the default is `us_employ

# File 'lib/increase/models/entity_create_params.rb', line 694

Instance Attribute Details

#category ⇒ Symbol, ...

The category of the legal identifier. If not provided, the default is us_employer_identification_number.

Returns:

• (Symbol, Increase::Models::EntityCreateParams::Corporation::LegalIdentifier::Category, nil)

# File 'lib/increase/models/entity_create_params.rb', line 692

optional :category, enum: -> { Increase::EntityCreateParams::Corporation::LegalIdentifier::Category }

#value ⇒ String

The legal identifier itself. For US Employer Identification Numbers, submit nine digits with no dashes or other separators. When testing in sandbox, use one of our sandbox test values.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/increase/models/entity_create_params.rb', line 685

required :value, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/increase/models/entity_create_params.rbs', line 578

def to_hash: -> {