Class: GOBL::Org::Item

Inherits:
GOBL::Object show all
Defined in:
lib/generated/gobl/org/item.rb

Overview

Item is used to describe a single product or service.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Item structure

'https://gobl.org/draft-0/org/item'

Instance Attribute Summary collapse

Method Summary

Methods inherited from GOBL::Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#alt_prices ⇒ Array<GOBL::Currency::Amount> (readonly)

AltPrices defines a list of prices with their currencies that may be used as an alternative to the item’s base price.

Returns:



60
 
# File 'lib/generated/gobl/org/item.rb', line 60

property :alt_prices, [GOBL::Currency::Amount]

#currency ⇒ GOBL::Currency::Code (readonly)

Currency used for the item’s price.

Returns:



49
 
# File 'lib/generated/gobl/org/item.rb', line 49

property :currency, GOBL::Currency::Code

#description ⇒ String (readonly)

Detailed description of the item.

Returns:

  • (String) 


44
 
# File 'lib/generated/gobl/org/item.rb', line 44

property :description, String

#ext ⇒ GOBL::Tax::Extensions (readonly)

Extension code map for any additional regime specific codes that may be required.

Returns:



75
 
# File 'lib/generated/gobl/org/item.rb', line 75

property :ext, GOBL::Tax::Extensions

#identities ⇒ Array<GOBL::Org::Identity> (readonly)

List of additional codes, IDs, or SKUs which can be used to identify the item. They should be agreed upon between supplier and customer.

Returns:



39
 
# File 'lib/generated/gobl/org/item.rb', line 39

property :identities, [GOBL::Org::Identity]

#key ⇒ GOBL::CBC::Key (readonly)

Special key used to classify the item sometimes required by some regimes.

Returns:



28
 
# File 'lib/generated/gobl/org/item.rb', line 28

property :key, GOBL::CBC::Key

#meta ⇒ GOBL::CBC::Meta (readonly)

Additional meta information that may be useful

Returns:



80
 
# File 'lib/generated/gobl/org/item.rb', line 80

property :meta, GOBL::CBC::Meta

#name ⇒ String (readonly)

Brief name of the item

Returns:

  • (String) 


33
 
# File 'lib/generated/gobl/org/item.rb', line 33

property :name, String

#origin ⇒ GOBL::L10n::ISOCountryCode (readonly)

Country code of where this item was from originally.

Returns:



70
 
# File 'lib/generated/gobl/org/item.rb', line 70

property :origin, GOBL::L10n::ISOCountryCode

#price ⇒ GOBL::Num::Amount (readonly)

Base price of a single unit to be sold.

Returns:



54
 
# File 'lib/generated/gobl/org/item.rb', line 54

property :price, GOBL::Num::Amount

#ref ⇒ String (readonly)

Primary reference code that identifies this item. Additional codes can be provided in the ‘identities’ property.

Returns:

  • (String) 


23
 
# File 'lib/generated/gobl/org/item.rb', line 23

property :ref, String

#unit ⇒ GOBL::Org::Unit (readonly)

Unit of measure.

Returns:



65
 
# File 'lib/generated/gobl/org/item.rb', line 65

property :unit, GOBL::Org::Unit

#uuid ⇒ String (readonly)

Universally Unique Identifier.

Returns:

  • (String) 


18
 
# File 'lib/generated/gobl/org/item.rb', line 18

property :uuid, String