Class: GOBL::Bill::Preceding

Inherits:

Object

• Object
• Struct
• Object
• GOBL::Bill::Preceding

Defined in:

lib/generated/gobl/bill/preceding.rb

Overview

Preceding allows for information to be provided about a previous invoice that this one will replace, subtract from, or add to.

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL Preceding structure

'https://gobl.org/draft-0/bill/invoice#/$defs/Preceding'

Instance Attribute Summary

• #code ⇒ String readonly

  Code of the previous document.

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

  Tax regime specific keys reflecting the method used to correct the preceding invoice.

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

  Tax regime specific keys reflecting why the preceding invoice is being replaced.

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

  The issue date of the previous document.

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

  Additional semi-structured data that may be useful in specific regions.

• #period ⇒ GOBL::Cal::Period readonly

  Tax period in which the previous invoice had an effect required by some tax regimes and formats.

• #reason ⇒ String readonly

  Human readable description on why the preceding invoice is being replaced.

• #series ⇒ String readonly

  Series identification code.

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

  Seals of approval from other organisations that may need to be listed.

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

  Preceding document’s UUID if available can be useful for tracing.

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#code ⇒ String (readonly)

Code of the previous document.

Returns:

• (String)

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

property :code, String

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

Tax regime specific keys reflecting the method used to correct the preceding invoice.

Returns:

• (GOBL::CBC::Key)

# File 'lib/generated/gobl/bill/preceding.rb', line 55

property :correction_method, GOBL::CBC::Key

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

Tax regime specific keys reflecting why the preceding invoice is being replaced.

Returns:

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

# File 'lib/generated/gobl/bill/preceding.rb', line 50

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

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

The issue date of the previous document.

Returns:

• (GOBL::Cal::Date)

# File 'lib/generated/gobl/bill/preceding.rb', line 35

property :issue_date, GOBL::Cal::Date

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

Additional semi-structured data that may be useful in specific regions

Returns:

• (GOBL::CBC::Meta)

# File 'lib/generated/gobl/bill/preceding.rb', line 65

property :meta, GOBL::CBC::Meta

#period ⇒ GOBL::Cal::Period (readonly)

Tax period in which the previous invoice had an effect required by some tax regimes and formats.

Returns:

• (GOBL::Cal::Period)

# File 'lib/generated/gobl/bill/preceding.rb', line 60

property :period, GOBL::Cal::Period

#reason ⇒ String (readonly)

Human readable description on why the preceding invoice is being replaced.

Returns:

• (String)

# File 'lib/generated/gobl/bill/preceding.rb', line 40

property :reason, String

#series ⇒ String (readonly)

Series identification code

Returns:

• (String)

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

property :series, String

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

Seals of approval from other organisations that may need to be listed.

Returns:

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

# File 'lib/generated/gobl/bill/preceding.rb', line 45

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

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

Preceding document’s UUID if available can be useful for tracing.

Returns:

• (GOBL::UUID::UUID)

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

property :uuid, GOBL::UUID::UUID