Class: Recurly::Resources::Item
- Inherits:
-
Recurly::Resource
- Object
- Recurly::Resource
- Recurly::Resources::Item
- Defined in:
- lib/recurly/resources/item.rb
Instance Attribute Summary collapse
-
#accounting_code ⇒ String
Accounting code for invoice line items.
-
#avalara_service_type ⇒ Integer
Used by Avalara for Communications taxes.
-
#avalara_transaction_type ⇒ Integer
Used by Avalara for Communications taxes.
-
#code ⇒ String
Unique code to identify the item.
-
#created_at ⇒ DateTime
Created at.
-
#currencies ⇒ Array[Pricing]
Item Pricing.
-
#custom_fields ⇒ Array[CustomField]
The custom fields will only be altered when they are included in a request.
-
#deleted_at ⇒ DateTime
Deleted at.
-
#description ⇒ String
Optional, description.
-
#external_sku ⇒ String
Optional, stock keeping unit to link the item to other inventory systems.
-
#id ⇒ String
Item ID.
-
#name ⇒ String
This name describes your item and will appear on the invoice when it’s purchased on a one time basis.
-
#object ⇒ String
Object type.
-
#revenue_schedule_type ⇒ String
Revenue schedule type.
-
#state ⇒ String
The current state of the item.
-
#tax_code ⇒ String
Used by Avalara, Vertex, and Recurly’s EU VAT tax feature.
-
#tax_exempt ⇒ Boolean
‘true` exempts tax on the item, `false` applies tax on the item.
-
#updated_at ⇒ DateTime
Last updated at.
Attributes inherited from Recurly::Resource
Method Summary
Methods inherited from Recurly::Resource
#==, #get_response, #inspect, #requires_client?, #to_json, #to_s
Methods included from Schema::SchemaFactory
Methods included from Schema::ResourceCaster
Methods included from Schema::SchemaValidator
#get_did_you_mean, #validate!, #validate_attribute!
Instance Attribute Details
#accounting_code ⇒ String
Returns Accounting code for invoice line items.
11 |
# File 'lib/recurly/resources/item.rb', line 11 define_attribute :accounting_code, String |
#avalara_service_type ⇒ Integer
Returns Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
15 |
# File 'lib/recurly/resources/item.rb', line 15 define_attribute :avalara_service_type, Integer |
#avalara_transaction_type ⇒ Integer
Returns Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
19 |
# File 'lib/recurly/resources/item.rb', line 19 define_attribute :avalara_transaction_type, Integer |
#code ⇒ String
Returns Unique code to identify the item.
23 |
# File 'lib/recurly/resources/item.rb', line 23 define_attribute :code, String |
#created_at ⇒ DateTime
Returns Created at.
27 |
# File 'lib/recurly/resources/item.rb', line 27 define_attribute :created_at, DateTime |
#currencies ⇒ Array[Pricing]
Returns Item Pricing.
31 |
# File 'lib/recurly/resources/item.rb', line 31 define_attribute :currencies, Array, { :item_type => :Pricing } |
#custom_fields ⇒ Array[CustomField]
Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
35 |
# File 'lib/recurly/resources/item.rb', line 35 define_attribute :custom_fields, Array, { :item_type => :CustomField } |
#deleted_at ⇒ DateTime
Returns Deleted at.
39 |
# File 'lib/recurly/resources/item.rb', line 39 define_attribute :deleted_at, DateTime |
#description ⇒ String
Returns Optional, description.
43 |
# File 'lib/recurly/resources/item.rb', line 43 define_attribute :description, String |
#external_sku ⇒ String
Returns Optional, stock keeping unit to link the item to other inventory systems.
47 |
# File 'lib/recurly/resources/item.rb', line 47 define_attribute :external_sku, String |
#id ⇒ String
Returns Item ID.
51 |
# File 'lib/recurly/resources/item.rb', line 51 define_attribute :id, String |
#name ⇒ String
Returns This name describes your item and will appear on the invoice when it’s purchased on a one time basis.
55 |
# File 'lib/recurly/resources/item.rb', line 55 define_attribute :name, String |
#object ⇒ String
Returns Object type.
59 |
# File 'lib/recurly/resources/item.rb', line 59 define_attribute :object, String |
#revenue_schedule_type ⇒ String
Returns Revenue schedule type.
63 |
# File 'lib/recurly/resources/item.rb', line 63 define_attribute :revenue_schedule_type, String |
#state ⇒ String
Returns The current state of the item.
67 |
# File 'lib/recurly/resources/item.rb', line 67 define_attribute :state, String |
#tax_code ⇒ String
Returns Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use ‘unknown`, `physical`, or `digital`.
71 |
# File 'lib/recurly/resources/item.rb', line 71 define_attribute :tax_code, String |
#tax_exempt ⇒ Boolean
Returns ‘true` exempts tax on the item, `false` applies tax on the item.
75 |
# File 'lib/recurly/resources/item.rb', line 75 define_attribute :tax_exempt, :Boolean |
#updated_at ⇒ DateTime
Returns Last updated at.
79 |
# File 'lib/recurly/resources/item.rb', line 79 define_attribute :updated_at, DateTime |