Class: GOBL::Bill::CorrectionOptions

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Bill::CorrectionOptions

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

SCHEMA_ID =

The Schema ID of the GOBL CorrectionOptions structure

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

Instance Attribute Summary

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

  Extensions for region specific requirements.

• #issue_date ⇒ GOBL::Cal::Date readonly

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

• #reason ⇒ String readonly

  Human readable reason for the corrective operation.

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

  Series to assign to the new corrective invoice.

• #stamps ⇒ Array<GOBL::Head::Stamp> readonly

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

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

  The type of corrective invoice to produce.

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

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

Extensions for region specific requirements.

Returns:

• (GOBL::Tax::Extensions)

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

property :ext, GOBL::Tax::Extensions

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

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

Returns:

• (GOBL::Cal::Date)

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

property :issue_date, GOBL::Cal::Date

#reason ⇒ String (readonly)

Human readable reason for the corrective operation.

Returns:

• (String)

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

property :reason, String

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

Series to assign to the new corrective invoice.

Returns:

• (GOBL::CBC::Code)

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

property :series, GOBL::CBC::Code

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

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

Returns:

• (Array<GOBL::Head::Stamp>)

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

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

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

The type of corrective invoice to produce.

Returns:

• (GOBL::CBC::Key)

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

property :type, GOBL::CBC::Key