Class: GOBL::Tax::CorrectionDefinition

Inherits:
Object show all
Defined in:
lib/generated/gobl/tax/correction_definition.rb

Overview

CorrectionDefinition contains details about what can be defined in .

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL CorrectionDefinition structure

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

Instance Attribute Summary collapse

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#changes ⇒ Array<KeyDefinition> (readonly)

List of change keys that can be used to describe what has been corrected.

Returns:



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

property :changes, [KeyDefinition]

#methods ⇒ Array<KeyDefinition> (readonly)

Methods describe the methods used to correct an invoice.

Returns:



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

property :methods, [KeyDefinition]

#reason_required ⇒ Boolean (readonly)

ReasonRequired when true implies that a reason must be provided

Returns:

  • (Boolean) 


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

property :reason_required, Boolean

#schema ⇒ String (readonly)

Partial or complete schema URL for the document type supported by correction.

Returns:

  • (String) 


19
 
# File 'lib/generated/gobl/tax/correction_definition.rb', line 19

property :schema, String

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

Stamps that must be copied from the preceding document.

Returns:



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

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

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

The types of sub-documents supported by the regime

Returns:



25
 
# File 'lib/generated/gobl/tax/correction_definition.rb', line 25

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