Class: Recurly::Resources::TaxInfo

Inherits:

Recurly::Resource

• Object
• Recurly::Resource
• Recurly::Resources::TaxInfo

Defined in:

lib/recurly/resources/tax_info.rb

Instance Attribute Summary

• #rate ⇒ Float

  The combined tax rate.

• #region ⇒ String

  Provides the tax region applied on an invoice.

• #tax_details ⇒ Array[TaxDetail]

  Provides additional tax details for Communications taxes when Avalara for Communications is enabled or Canadian Sales Tax when there is tax applied at both the country and province levels.

• #type ⇒ String

  Provides the tax type as “vat” for EU VAT, “usst” for U.S.

Attributes inherited from Recurly::Resource

#attributes

Method Summary

Methods inherited from Recurly::Resource

#==, #get_response, #inspect, #requires_client?, #to_json, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::ResourceCaster

#cast

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#rate ⇒ Float

Returns The combined tax rate. Not present when Avalara for Communications is enabled.

Returns:

• (Float) —

  The combined tax rate. Not present when Avalara for Communications is enabled.

# File 'lib/recurly/resources/tax_info.rb', line 11

define_attribute :rate, Float

#region ⇒ String

Returns Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the 2 letter state code. For EU VAT this will be the 2 letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST. Not present when Avalara for Communications is enabled.

Returns:

• (String) —

  Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the 2 letter state code. For EU VAT this will be the 2 letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST. Not present when Avalara for Communications is enabled.

# File 'lib/recurly/resources/tax_info.rb', line 15

define_attribute :region, String

#tax_details ⇒ Array[TaxDetail]

Returns Provides additional tax details for Communications taxes when Avalara for Communications is enabled or Canadian Sales Tax when there is tax applied at both the country and province levels. This will only be populated for the Invoice response when fetching a single invoice and not for the InvoiceList or LineItemList. Only populated for a single LineItem fetch when Avalara for Communications is enabled.

Returns:

• (Array[TaxDetail]) —

  Provides additional tax details for Communications taxes when Avalara for Communications is enabled or Canadian Sales Tax when there is tax applied at both the country and province levels. This will only be populated for the Invoice response when fetching a single invoice and not for the InvoiceList or LineItemList. Only populated for a single LineItem fetch when Avalara for Communications is enabled.

# File 'lib/recurly/resources/tax_info.rb', line 19

define_attribute :tax_details, Array, { :item_type => :TaxDetail }

#type ⇒ String

Returns Provides the tax type as “vat” for EU VAT, “usst” for U.S. Sales Tax, or the 2 letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries. Not present when Avalara for Communications is enabled.

Returns:

• (String) —

  Provides the tax type as “vat” for EU VAT, “usst” for U.S. Sales Tax, or the 2 letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries. Not present when Avalara for Communications is enabled.

# File 'lib/recurly/resources/tax_info.rb', line 23

define_attribute :type, String