Class: GOBL::Bill::CorrectionOptions

Inherits:
Object show all
Defined in:
lib/generated/gobl/bill/correction_options.rb

Overview

CorrectionOptions defines a structure used to pass configuration options to correct a previous invoice.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL CorrectionOptions structure

'https://gobl.org/draft-0/bill/correction-options'

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

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

Correction method as defined by the tax regime.

Returns:



44
 
# File 'lib/generated/gobl/bill/correction_options.rb', line 44

property :correction_method, GOBL::CBC::Key

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

Correction keys that describe the specific changes according to the tax regime.

Returns:



49
 
# File 'lib/generated/gobl/bill/correction_options.rb', line 49

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

#credit ⇒ Boolean (readonly)

Credit when true indicates that the corrective document should cancel the previous document.

Returns:

  • (Boolean) 


29
 
# File 'lib/generated/gobl/bill/correction_options.rb', line 29

property :credit, Boolean

#debit ⇒ Boolean (readonly)

Debit when true indicates that the corrective document should add new items to the previous document.

Returns:

  • (Boolean) 


34
 
# File 'lib/generated/gobl/bill/correction_options.rb', line 34

property :debit, Boolean

#issue_date ⇒ GOBL::Cal::Date (readonly)

When the new corrective invoice’s issue date should be set to.

Returns:



19
 
# File 'lib/generated/gobl/bill/correction_options.rb', line 19

property :issue_date, GOBL::Cal::Date

#reason ⇒ String (readonly)

Human readable reason for the corrective operation.

Returns:

  • (String) 


39
 
# File 'lib/generated/gobl/bill/correction_options.rb', line 39

property :reason, String

#stamps ⇒ Array<GOBL::Head::Stamp> (readonly)

Stamps of the previous document to include in the preceding data.

Returns:



24
 
# File 'lib/generated/gobl/bill/correction_options.rb', line 24

property :stamps, [GOBL::Head::Stamp]