Class: Recurly::Requests::ItemUpdate

Inherits:
Recurly::Request show all
Defined in:
lib/recurly/requests/item_update.rb

Instance Attribute Summary collapse

Attributes inherited from Recurly::Request

#attributes

Method Summary

Methods inherited from Recurly::Request

#==, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::RequestCaster

#cast_request

Methods included from Schema::ResourceCaster

#cast

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.

Returns:

  • (String) —

    Accounting code for invoice line items.



11
 
# File 'lib/recurly/requests/item_update.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.

Returns:



15
 
# File 'lib/recurly/requests/item_update.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.

Returns:



19
 
# File 'lib/recurly/requests/item_update.rb', line 19

define_attribute :avalara_transaction_type, Integer

#code ⇒ String

Returns Unique code to identify the item.

Returns:

  • (String) —

    Unique code to identify the item.



23
 
# File 'lib/recurly/requests/item_update.rb', line 23

define_attribute :code, String

#currencies ⇒ Array[Pricing]

Returns Item Pricing.

Returns:

  • (Array[Pricing]) —

    Item Pricing



27
 
# File 'lib/recurly/requests/item_update.rb', line 27

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.

Returns:

  • (Array[CustomField]) —

    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.



31
 
# File 'lib/recurly/requests/item_update.rb', line 31

define_attribute :custom_fields, Array, { :item_type => :CustomField }

#description ⇒ String

Returns Optional, description.

Returns:

  • (String) —

    Optional, description.



35
 
# File 'lib/recurly/requests/item_update.rb', line 35

define_attribute :description, String

#external_sku ⇒ String

Returns Optional, stock keeping unit to link the item to other inventory systems.

Returns:

  • (String) —

    Optional, stock keeping unit to link the item to other inventory systems.



39
 
# File 'lib/recurly/requests/item_update.rb', line 39

define_attribute :external_sku, String

#liability_gl_account_id ⇒ String

Returns The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

Returns:

  • (String) —

    The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.



43
 
# File 'lib/recurly/requests/item_update.rb', line 43

define_attribute :liability_gl_account_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.

Returns:

  • (String) —

    This name describes your item and will appear on the invoice when it's purchased on a one time basis.



47
 
# File 'lib/recurly/requests/item_update.rb', line 47

define_attribute :name, String

#performance_obligation_id ⇒ String

Returns The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

Returns:

  • (String) —

    The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.



51
 
# File 'lib/recurly/requests/item_update.rb', line 51

define_attribute :performance_obligation_id, String

#revenue_gl_account_id ⇒ String

Returns The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

Returns:

  • (String) —

    The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.



55
 
# File 'lib/recurly/requests/item_update.rb', line 55

define_attribute :revenue_gl_account_id, String

#revenue_schedule_type ⇒ String

Returns Revenue schedule type.

Returns:

  • (String) —

    Revenue schedule type



59
 
# File 'lib/recurly/requests/item_update.rb', line 59

define_attribute :revenue_schedule_type, String

#tax_code ⇒ String

Returns Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.

Returns:

  • (String) —

    Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.



63
 
# File 'lib/recurly/requests/item_update.rb', line 63

define_attribute :tax_code, String

#tax_exempt ⇒ Boolean

Returns `true` exempts tax on the item, `false` applies tax on the item.

Returns:

  • (Boolean) —

    `true` exempts tax on the item, `false` applies tax on the item.



67
 
# File 'lib/recurly/requests/item_update.rb', line 67

define_attribute :tax_exempt, :Boolean