Class: Recurly::Resources::TaxDetail

Inherits:

Recurly::Resource

• Object
• Recurly::Resource
• Recurly::Resources::TaxDetail

Defined in:

lib/recurly/resources/tax_detail.rb

Instance Attribute Summary

• #billable ⇒ Boolean

  Whether or not the line item is taxable.

• #level ⇒ String

  Provides the jurisdiction level for the Communications tax applied.

• #name ⇒ String

  Provides the name of the Communications tax applied.

• #rate ⇒ Float

  Provides the tax rate for the region.

• #region ⇒ String

  Provides the tax region applied on an invoice.

• #tax ⇒ Float

  The total tax applied for this tax type.

• #type ⇒ String

  Provides the tax type for the region or type of Comminications tax when Avalara for Communications is enabled.

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

#billable ⇒ Boolean

Returns Whether or not the line item is taxable. Only populated for a single LineItem fetch when Avalara for Communications is enabled.

Returns:

• (Boolean) —

  Whether or not the line item is taxable. Only populated for a single LineItem fetch when Avalara for Communications is enabled.

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

define_attribute :billable, :Boolean

#level ⇒ String

Returns Provides the jurisdiction level for the Communications tax applied. Example values include city, state and federal. Present only when Avalara for Communications is enabled.

Returns:

• (String) —

  Provides the jurisdiction level for the Communications tax applied. Example values include city, state and federal. Present only when Avalara for Communications is enabled.

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

define_attribute :level, String

#name ⇒ String

Returns Provides the name of the Communications tax applied. Present only when Avalara for Communications is enabled.

Returns:

• (String) —

  Provides the name of the Communications tax applied. Present only when Avalara for Communications is enabled.

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

define_attribute :name, String

#rate ⇒ Float

Returns Provides the tax rate for the region.

Returns:

• (Float) —

  Provides the tax rate for the region.

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

define_attribute :rate, Float

#region ⇒ String

Returns Provides the tax region applied on an invoice. For Canadian Sales Tax, this will be either the 2 letter province code or country code. Not present when Avalara for Communications is enabled.

Returns:

• (String) —

  Provides the tax region applied on an invoice. For Canadian Sales Tax, this will be either the 2 letter province code or country code. Not present when Avalara for Communications is enabled.

# File 'lib/recurly/resources/tax_detail.rb', line 27

define_attribute :region, String

#tax ⇒ Float

Returns The total tax applied for this tax type.

Returns:

• (Float) —

  The total tax applied for this tax type.

# File 'lib/recurly/resources/tax_detail.rb', line 31

define_attribute :tax, Float

#type ⇒ String

Returns Provides the tax type for the region or type of Comminications tax when Avalara for Communications is enabled. For Canadian Sales Tax, this will be GST, HST, QST or PST.

Returns:

• (String) —

  Provides the tax type for the region or type of Comminications tax when Avalara for Communications is enabled. For Canadian Sales Tax, this will be GST, HST, QST or PST.

# File 'lib/recurly/resources/tax_detail.rb', line 35

define_attribute :type, String