Class: GOBL::Org::Item

Inherits:

GOBL::Object

• Object
• Struct
• GOBL::Object
• GOBL::Org::Item

Defined in:

lib/generated/gobl/org/item.rb

Overview

Item is used to describe a single product or service.

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL Item structure

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

Instance Attribute Summary

• #currency ⇒ GOBL::Currency::Code readonly

  Currency used for the item’s price.

• #desc ⇒ String readonly

  Detailed description.

• #ext ⇒ GOBL::CBC::CodeMap readonly

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

• #identities ⇒ Array<GOBL::Org::Identity> readonly

  List of additional codes, IDs, or SKUs which can be used to identify the item.

• #key ⇒ GOBL::CBC::Key readonly

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

• #meta ⇒ GOBL::CBC::Meta readonly

  Additional meta information that may be useful.

• #name ⇒ String readonly

  Brief name of the item.

• #origin ⇒ GOBL::L10n::CountryCode readonly

  Country code of where this item was from originally.

• #price ⇒ GOBL::Num::Amount readonly

  Base price of a single unit to be sold.

• #ref ⇒ String readonly

  Primary reference code that identifies this item.

• #unit ⇒ GOBL::Org::Unit readonly

  Unit of measure.

• #uuid ⇒ GOBL::UUID::UUID readonly

  Unique identity of this item.

Method Summary

Methods inherited from GOBL::Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

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

Currency used for the item’s price.

Returns:

• (GOBL::Currency::Code)

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

property :currency, GOBL::Currency::Code

#desc ⇒ String (readonly)

Detailed description

Returns:

• (String)

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

property :desc, String

#ext ⇒ GOBL::CBC::CodeMap (readonly)

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

Returns:

• (GOBL::CBC::CodeMap)

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

property :ext, GOBL::CBC::CodeMap

#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:

• (Array<GOBL::Org::Identity>)

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

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

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

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

Returns:

• (GOBL::CBC::Key)

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

property :key, GOBL::CBC::Key

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

Additional meta information that may be useful

Returns:

• (GOBL::CBC::Meta)

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

property :meta, GOBL::CBC::Meta

#name ⇒ String (readonly)

Brief name of the item

Returns:

• (String)

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

property :name, String

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

Country code of where this item was from originally.

Returns:

• (GOBL::L10n::CountryCode)

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

property :origin, GOBL::L10n::CountryCode

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

Base price of a single unit to be sold.

Returns:

• (GOBL::Num::Amount)

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

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)

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

property :ref, String

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

Unit of measure.

Returns:

• (GOBL::Org::Unit)

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

property :unit, GOBL::Org::Unit

#uuid ⇒ GOBL::UUID::UUID (readonly)

Unique identity of this item

Returns:

• (GOBL::UUID::UUID)

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

property :uuid, GOBL::UUID::UUID