Class: GOBL::Org::DocumentRef

Inherits:
GOBL::Object show all
Defined in:
lib/generated/gobl/org/document_ref.rb

Overview

DocumentRef is used to describe an existing document or a specific part of it’s contents.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL DocumentRef structure

'https://gobl.org/draft-0/org/document-ref'

Instance Attribute Summary collapse

Method Summary

Methods inherited from GOBL::Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

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

Source document’s code or other identifier.

Returns:



38
 
# File 'lib/generated/gobl/org/document_ref.rb', line 38

property :code, GOBL::CBC::Code

#description ⇒ String (readonly)

Additional details about the document.

Returns:

  • (String) 


64
 
# File 'lib/generated/gobl/org/document_ref.rb', line 64

property :description, String

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

Extensions for additional codes that may be required.

Returns:



79
 
# File 'lib/generated/gobl/org/document_ref.rb', line 79

property :ext, GOBL::Tax::Extensions

#identities ⇒ Array<GOBL::Org::Identity> (readonly)

List of additional codes, IDs, or SKUs which can be used to identify the document or its contents, agreed upon by the supplier and customer.

Returns:



49
 
# File 'lib/generated/gobl/org/document_ref.rb', line 49

property :identities, [GOBL::Org::Identity]

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

IssueDate reflects the date the document was issued.

Returns:



28
 
# File 'lib/generated/gobl/org/document_ref.rb', line 28

property :issue_date, GOBL::Cal::Date

#line ⇒ Integer (readonly)

Line index number inside the document, if relevant.

Returns:

  • (Integer) 


44
 
# File 'lib/generated/gobl/org/document_ref.rb', line 44

property :line, Integer

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

Meta contains additional information about the document.

Returns:



84
 
# File 'lib/generated/gobl/org/document_ref.rb', line 84

property :meta, GOBL::CBC::Meta

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

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

Returns:



54
 
# File 'lib/generated/gobl/org/document_ref.rb', line 54

property :period, GOBL::Cal::Period

#reason ⇒ String (readonly)

Human readable description on why this reference is here or needs to be used.

Returns:

  • (String) 


59
 
# File 'lib/generated/gobl/org/document_ref.rb', line 59

property :reason, String

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

Series the referenced document belongs to.

Returns:



33
 
# File 'lib/generated/gobl/org/document_ref.rb', line 33

property :series, GOBL::CBC::Code

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

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

Returns:



69
 
# File 'lib/generated/gobl/org/document_ref.rb', line 69

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

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

Type of the document referenced.

Returns:



23
 
# File 'lib/generated/gobl/org/document_ref.rb', line 23

property :type, GOBL::CBC::Key

#url ⇒ String (readonly)

Link to the source document.

Returns:

  • (String) 


74
 
# File 'lib/generated/gobl/org/document_ref.rb', line 74

property :url, String

#uuid ⇒ String (readonly)

Universally Unique Identifier.

Returns:

  • (String) 


18
 
# File 'lib/generated/gobl/org/document_ref.rb', line 18

property :uuid, String