Class: GOBL::Tax::CategoryDef

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Tax::CategoryDef

Defined in:

lib/generated/gobl/tax/category_def.rb

Overview

CategoryDef contains the definition of a general type of tax inside a region.

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL CategoryDef structure

'https://gobl.org/draft-0/tax/regime-def#/$defs/CategoryDef'

Instance Attribute Summary

• #code ⇒ GOBL::CBC::Code readonly

  Code to be used in documents.

• #desc ⇒ GOBL::I18n::String readonly

  Useful description of the category.

• #ext ⇒ GOBL::Tax::Extensions readonly

  Extensions key-value pairs that will be copied to the tax combo if this category is used.

• #extensions ⇒ Array<GOBL::CBC::Key> readonly

  Extensions defines a list of extension keys that may be used or required as an alternative or alongside choosing a rate for the tax category.

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

  Map defines a set of regime specific code mappings.

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

  Meta contains additional information about the category that is relevant for local frequently used formats.

• #name ⇒ GOBL::I18n::String readonly

  Short name of the category to be used instead of code in output.

• #rates ⇒ Array<RateDef> readonly

  Specific tax definitions inside this category.

• #retained ⇒ Boolean readonly

  Retained when true implies that the tax amount will be retained by the buyer on behalf of the supplier, and thus subtracted from the invoice taxable base total.

• #sources ⇒ Array<Source> readonly

  List of sources for the information contained in this category.

• #title ⇒ GOBL::I18n::String readonly

  Human name for the code to use for titles.

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#code ⇒ GOBL::CBC::Code (readonly)

Code to be used in documents

Returns:

• (GOBL::CBC::Code)

# File 'lib/generated/gobl/tax/category_def.rb', line 18

property :code, GOBL::CBC::Code

#desc ⇒ GOBL::I18n::String (readonly)

Useful description of the category.

Returns:

• (GOBL::I18n::String)

# File 'lib/generated/gobl/tax/category_def.rb', line 35

property :desc, GOBL::I18n::String

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

Extensions key-value pairs that will be copied to the tax combo if this category is used.

Returns:

• (GOBL::Tax::Extensions)

# File 'lib/generated/gobl/tax/category_def.rb', line 65

property :ext, GOBL::Tax::Extensions

#extensions ⇒ Array<GOBL::CBC::Key> (readonly)

Extensions defines a list of extension keys that may be used or required as an alternative or alongside choosing a rate for the tax category. Every key must be defined in the Regime’s extensions table.

Returns:

• (Array<GOBL::CBC::Key>)

# File 'lib/generated/gobl/tax/category_def.rb', line 50

property :extensions, [GOBL::CBC::Key]

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

Map defines a set of regime specific code mappings.

Returns:

• (GOBL::CBC::CodeMap)

# File 'lib/generated/gobl/tax/category_def.rb', line 55

property :map, GOBL::CBC::CodeMap

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

Meta contains additional information about the category that is relevant for local frequently used formats.

Returns:

• (GOBL::CBC::Meta)

# File 'lib/generated/gobl/tax/category_def.rb', line 70

property :meta, GOBL::CBC::Meta

#name ⇒ GOBL::I18n::String (readonly)

Short name of the category to be used instead of code in output

Returns:

• (GOBL::I18n::String)

# File 'lib/generated/gobl/tax/category_def.rb', line 24

property :name, GOBL::I18n::String

#rates ⇒ Array<RateDef> (readonly)

Specific tax definitions inside this category.

Returns:

• (Array<RateDef>)

# File 'lib/generated/gobl/tax/category_def.rb', line 45

property :rates, [RateDef]

#retained ⇒ Boolean (readonly)

Retained when true implies that the tax amount will be retained by the buyer on behalf of the supplier, and thus subtracted from the invoice taxable base total. Typically used for taxes related to income.

Returns:

• (Boolean)

# File 'lib/generated/gobl/tax/category_def.rb', line 40

property :retained, Boolean

#sources ⇒ Array<Source> (readonly)

List of sources for the information contained in this category.

Returns:

• (Array<Source>)

# File 'lib/generated/gobl/tax/category_def.rb', line 60

property :sources, [Source]

#title ⇒ GOBL::I18n::String (readonly)

Human name for the code to use for titles

Returns:

• (GOBL::I18n::String)

# File 'lib/generated/gobl/tax/category_def.rb', line 30

property :title, GOBL::I18n::String