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:



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

property :code, GOBL::CBC::Code

#currency ⇒ GOBL::Currency::Code (readonly)

Currency used in the document, if different from the parent’s currency.

Returns:



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

property :currency, GOBL::Currency::Code

#description ⇒ String (readonly)

Additional details about the document.

Returns:

  • (String) 


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

property :description, String

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

Extensions for additional codes that may be required.

Returns:



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

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:



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

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

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

IssueDate reflects the date the document was issued.

Returns:



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

property :issue_date, GOBL::Cal::Date

#lines ⇒ Array<Integer> (readonly)

Line index numbers inside the document, if relevant.

Returns:

  • (Array<Integer>) 


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

property :lines, [Integer]

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

Meta contains additional information about the document.

Returns:



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

property :meta, GOBL::CBC::Meta

#payable ⇒ GOBL::Num::Amount (readonly)

Payable is the total amount that is payable in the referenced document. Only needed for specific tax regimes or addons. This may also be used in some scenarios to determine the proportion of the referenced document that has been paid, and calculate the remaining amount due and taxes.

Returns:



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

property :payable, GOBL::Num::Amount

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

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

Returns:



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

property :period, GOBL::Cal::Period

#reason ⇒ String (readonly)

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

Returns:

  • (String) 


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

property :reason, String

#schema ⇒ String (readonly)

Schema of the referenced document if different from that of the parent.

Returns:

  • (String) 


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

property :schema, String

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

Series the referenced document belongs to.

Returns:



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

property :series, GOBL::CBC::Code

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

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

Returns:



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

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

#tax ⇒ GOBL::Tax::Total (readonly)

Tax total breakdown from the original document in the provided currency. Should only be included if required by a specific tax regime or addon.

Returns:



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

property :tax, GOBL::Tax::Total

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

Type of the document referenced according to the defined schema or that of the parent document.

Returns:



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

property :type, GOBL::CBC::Key

#url ⇒ String (readonly)

Link to the source document.

Returns:

  • (String) 


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

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