Class: Vatsense::Models::ValidateCheckParams

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

Overview

See Also:

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(eori_number: nil, requester_vat_number: nil, vat_number: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Vatsense::Models::ValidateCheckParams for more details.

Parameters:

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

    The EORI number to validate. Must include the leading 2-character

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

    Your own VAT number. If supplied, the response will include a unique

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

    The VAT number to validate. Must include the leading 2-character

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



# File 'lib/vatsense/models/validate_check_params.rb', line 35

Instance Attribute Details

#eori_number ⇒ String?

The EORI number to validate. Must include the leading 2-character country code (e.g. “GB123456789123”). UK and EU only.

Returns:

  • (String, nil) 


15
 
# File 'lib/vatsense/models/validate_check_params.rb', line 15

optional :eori_number, String

#requester_vat_number ⇒ String?

Your own VAT number. If supplied, the response will include a unique consultation number issued by the relevant authority (VIES or HMRC). Must include the leading 2-character country code.

Note: GB requester numbers only work for GB validations; EU requester numbers only work for EU validations. Cross-region is not supported.

Returns:

  • (String, nil) 


26
 
# File 'lib/vatsense/models/validate_check_params.rb', line 26

optional :requester_vat_number, String

#vat_number ⇒ String?

The VAT number to validate. Must include the leading 2-character country code (e.g. “GB288305674”, “FR12345678901”).

Returns:

  • (String, nil) 


33
 
# File 'lib/vatsense/models/validate_check_params.rb', line 33

optional :vat_number, String