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

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

Defined Under Namespace

Modules: BeneficialOwnershipExemptionReason Classes: Address, BeneficialOwner, LegalIdentifier

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(city:, country:, line1:, line2: nil, state: nil, zip: nil) ⇒ Object

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

The entity’s physical address. Mail receiving locations like PO Boxes and PMB’s are disallowed.

Parameters:

  • city (String) —

    The city, district, town, or village of the address.

  • country (String) —

    The two-letter ISO 3166-1 alpha-2 code for the country of the address.

  • line1 (String) —

    The first line of the address. This is usually the street number and street.

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

    The second line of the address. This might be the floor or room number.

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

    The two-letter United States Postal Service (USPS) abbreviation for the US state

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

    The ZIP or postal code of the address. Required in certain countries.




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

Instance Attribute Details

#address ⇒ Increase::Models::EntityCreateParams::Corporation::Address

The entity’s physical address. Mail receiving locations like PO Boxes and PMB’s are disallowed.

Returns:



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

required :address, -> { Increase::EntityCreateParams::Corporation::Address }

#beneficial_owners ⇒ Array<Increase::Models::EntityCreateParams::Corporation::BeneficialOwner>

The identifying details of one control person (‘control`), like the CEO, CFO, or other executive, plus each person who owns 25% or more of the business (`ownership`). At least one control person is required, and frequently, the `control` person is also `ownership`. In some cases, there are no individuals who own 25% or more of the business. In that case, you should submit a single `control` person.

Returns:



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

required :beneficial_owners,
-> { Increase::Internal::Type::ArrayOf[Increase::EntityCreateParams::Corporation::BeneficialOwner] }

#beneficial_ownership_exemption_reason ⇒ Symbol, ...

If the entity is exempt from the requirement to submit beneficial owners, provide the justification. If a reason is provided, you do not need to submit a list of beneficial owners.

Returns:



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

optional :beneficial_ownership_exemption_reason,
enum: -> { Increase::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason }

#email ⇒ String?

An email address for the business. Not every program requires an email for submitted Entities.

Returns:

  • (String, nil) 


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

optional :email, String

#incorporation_state ⇒ String?

The two-letter United States Postal Service (USPS) abbreviation for the corporation’s state of incorporation.

Returns:

  • (String, nil) 


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

optional :incorporation_state, String

#industry_code ⇒ String?

The North American Industry Classification System (NAICS) code for the corporation’s primary line of business. This is a number, like ‘5132` for `Software Publishers`. A full list of classification codes is available [here](increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).

Returns:

  • (String, nil) 


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

optional :industry_code, String

#legal_identifier ⇒ Increase::Models::EntityCreateParams::Corporation::LegalIdentifier

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

Returns:



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

required :legal_identifier, -> { Increase::EntityCreateParams::Corporation::LegalIdentifier }

#name ⇒ String

The legal name of the corporation.

Returns:

  • (String) 


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

required :name, String

#website ⇒ String?

A website for the business. Not every program requires a website for submitted Entities.

Returns:

  • (String, nil) 


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

optional :website, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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