Class: GOBL::Bill::Preceding

Inherits:
Object show all
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 collapse

SCHEMA_ID =

The Schema ID of the GOBL Preceding structure

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

Enumeration of possible values for #type with their corresponding descriptions

{
  'standard' => 'A regular commercial invoice document between a supplier and customer.',
  'proforma' => 'For a clients validation before sending a final invoice.',
  'corrective' => 'Corrected invoice that completely *replaces* the preceding document.',
  'credit-note' => 'Reflects a refund either partial or complete of the preceding document. A
credit note effectively *extends* the previous document.',
  'debit-note' => 'An additional set of charges to be added to the preceding document.'
}.freeze

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

#code ⇒ String (readonly)

Code of the previous document.

Returns:

  • (String) 


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

property :code, String

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

Extensions for region specific requirements.

Returns:



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

property :ext, GOBL::Tax::Extensions

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

The issue date of the previous document.

Returns:



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

property :issue_date, GOBL::Cal::Date

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

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

Returns:



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

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:



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

property :period, GOBL::Cal::Period

#reason ⇒ String (readonly)

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

Returns:

  • (String) 


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

property :reason, String

#series ⇒ String (readonly)

Series identification code

Returns:

  • (String) 


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

property :series, String

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

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

Returns:



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

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

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

Type of the preceding document

Returns:



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

property :type, GOBL::CBC::Key

#uuid ⇒ String (readonly)

Preceding document’s UUID.

Returns:

  • (String) 


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

property :uuid, String