Class: Vatsense::Models::RateCalculatePriceParams

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

Overview

See Also:

Defined Under Namespace

Modules: TaxType

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(price:, tax_type:, country_code: nil, eu: nil, ip_address: nil, province_code: nil, type: nil, request_options: {}) ⇒ Object

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

Parameters:

  • price (String) —

    The price to calculate on. Must be a string with exactly 2 decimal places (e.g.

  • tax_type (Symbol, Vatsense::Models::RateCalculatePriceParams::TaxType) —

    Whether the provided price is inclusive or exclusive of VAT.

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

    A 2-character ISO 3166-1 alpha-2 country code (e.g. “GB”, “FR”).

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

    Filter results by EU membership. Use 1 for EU countries only, 0 for non-EU only.

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

    An IPv4 or IPv6 address. If provided, the country will be determined from the IP

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

    A 2-character province code (e.g. “NU”, “NT”). If providing a province

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

    The product type to find the applicable rate for. See the /rates/types

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



# File 'lib/vatsense/models/rate_calculate_price_params.rb', line 56

Instance Attribute Details

#country_code ⇒ String?

A 2-character ISO 3166-1 alpha-2 country code (e.g. “GB”, “FR”).

Returns:

  • (String, nil) 


27
 
# File 'lib/vatsense/models/rate_calculate_price_params.rb', line 27

optional :country_code, String

#eu ⇒ Boolean?

Filter results by EU membership. Use 1 for EU countries only, 0 for non-EU only.

Returns:

  • (Boolean, nil) 


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

optional :eu, Vatsense::Internal::Type::Boolean

#ip_address ⇒ String?

An IPv4 or IPv6 address. If provided, the country will be determined from the IP address.

Returns:

  • (String, nil) 


40
 
# File 'lib/vatsense/models/rate_calculate_price_params.rb', line 40

optional :ip_address, String

#price ⇒ String

The price to calculate on. Must be a string with exactly 2 decimal places (e.g. “30.00”, “59.95”).

Returns:

  • (String) 


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

required :price, String

#province_code ⇒ String?

A 2-character province code (e.g. “NU”, “NT”). If providing a province code, you must also provide the relevant country_code.

Returns:

  • (String, nil) 


47
 
# File 'lib/vatsense/models/rate_calculate_price_params.rb', line 47

optional :province_code, String

#tax_type ⇒ Symbol, Vatsense::Models::RateCalculatePriceParams::TaxType

Whether the provided price is inclusive or exclusive of VAT.

Returns:



21
 
# File 'lib/vatsense/models/rate_calculate_price_params.rb', line 21

required :tax_type, enum: -> { Vatsense::RateCalculatePriceParams::TaxType }

#type ⇒ String?

The product type to find the applicable rate for. See the /rates/types endpoint for a full list of valid values.

Returns:

  • (String, nil) 


54
 
# File 'lib/vatsense/models/rate_calculate_price_params.rb', line 54

optional :type, String