Class: GOBL::Bill::Preceding

Inherits:

Object

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

Defined in:

lib/gobl/bill/preceding.rb

Overview

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

Constant Summary

SCHEMA_ID =

The Schema ID of the GOBL Preceding structure

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

Constants included from Hashme

Hashme::Boolean

Instance Attribute Summary

• #code ⇒ String readonly

  Code of the previous document.

• #correction_method ⇒ String readonly

  How has the previous invoice been corrected?.

• #corrections ⇒ Array<String> readonly

  Specific codes for the corrections made.

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

  The issue date if the previous document.

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

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

• #notes ⇒ String readonly

  Additional details regarding preceding invoice.

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

  Tax period in which the previous invoice had an effect.

• #series ⇒ String readonly

  Series identification code.

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

  Seals of approval from other organisations.

• #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/gobl/bill/preceding.rb', line 29

property :code, String

#correction_method ⇒ String (readonly)

How has the previous invoice been corrected?

Returns:

• (String)

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

property :correction_method, String

#corrections ⇒ Array<String> (readonly)

Specific codes for the corrections made.

Returns:

• (Array<String>)

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

property :corrections, [String]

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

The issue date if the previous document.

Returns:

• (GOBL::Cal::Date)

# File 'lib/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/gobl/bill/preceding.rb', line 66

property :meta, GOBL::CBC::Meta

#notes ⇒ String (readonly)

Additional details regarding preceding invoice

Returns:

• (String)

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

property :notes, String

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

Tax period in which the previous invoice had an effect.

Returns:

• (GOBL::Cal::Period)

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

property :period, GOBL::Cal::Period

#series ⇒ String (readonly)

Series identification code

Returns:

• (String)

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

property :series, String

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

Seals of approval from other organisations.

Returns:

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

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

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/gobl/bill/preceding.rb', line 19

property :uuid, GOBL::UUID::UUID