Class: GOBL::Bill::Delivery

Inherits:
Object show all
Defined in:
lib/generated/gobl/bill/delivery.rb

Overview

Delivery document used to describe the delivery of goods or potentially also services.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Delivery structure

'https://gobl.org/draft-0/bill/delivery'
TYPE_ENUM =

Enumeration of possible values for #type with their corresponding descriptions

{
  'advice' => 'A delivery or despatch advice document send by the supplier to indicate how
an order is to be delivered.',
  'note' => 'A delivery note is a document accompanying a shipment of goods that lists the
items included in the shipment.',
  'waybill' => 'A waybill is a document issued by a carrier giving details and instructions
relating to the shipment of a consignment of goods.',
  'receipt' => 'A delivery receipt is a document that is signed by the person who receives
goods to confirm that they have been received.'
}.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

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

Addons defines a list of keys used to identify tax addons that apply special normalization, scenarios, and validation rules to a document.



49
 
# File 'lib/generated/gobl/bill/delivery.rb', line 49

property :$addons, [GOBL::CBC::Key]

#$regime($regime) ⇒ GOBL::L10n::TaxCountryCode (readonly) 



43
 
# File 'lib/generated/gobl/bill/delivery.rb', line 43

property :$regime, GOBL::L10n::TaxCountryCode

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

Tags are used to help identify specific tax scenarios or requirements that may apply changes to the contents of the document or imply a specific meaning. Converters may use tags to help identify specific situations that do not have a specific extension, for example; self-billed or partial invoices may be identified by their respective tags.



54
 
# File 'lib/generated/gobl/bill/delivery.rb', line 54

property :$tags, [GOBL::CBC::Key]

#attachments ⇒ Array<GOBL::Org::Attachment> (readonly)

Attachments provide additional information or supporting documents that are not included in the main document. It is important that attachments are not used for alternative versions of the PDF, for that, see “links” inside the envelope headers.



209
 
# File 'lib/generated/gobl/bill/delivery.rb', line 209

property :attachments, [GOBL::Org::Attachment]

#charges ⇒ Array<GOBL::Bill::Charge> (readonly)

Charges or surcharges applied to order totals



184
 
# File 'lib/generated/gobl/bill/delivery.rb', line 184

property :charges, [GOBL::Bill::Charge]

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

Code is a sequential identifier that uniquely identifies the delivery. The code can be left empty initially, but is required to sign the document.



88
 
# File 'lib/generated/gobl/bill/delivery.rb', line 88

property :code, GOBL::CBC::Code

#complements ⇒ Array<GOBL::Schema::Object> (readonly)

Additional complementary objects that add relevant information to the delivery.



199
 
# File 'lib/generated/gobl/bill/delivery.rb', line 199

property :complements, [GOBL::Schema::Object]

#courier ⇒ GOBL::Org::Party (readonly)

The courier responsible for delivering the goods.



169
 
# File 'lib/generated/gobl/bill/delivery.rb', line 169

property :courier, GOBL::Org::Party

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

Currency for all delivery totals.



108
 
# File 'lib/generated/gobl/bill/delivery.rb', line 108

property :currency, GOBL::Currency::Code

#customer ⇒ GOBL::Org::Party (readonly)

Legal entity receiving the goods or services, may be nil in certain circumstances such as simplified invoices.



154
 
# File 'lib/generated/gobl/bill/delivery.rb', line 154

property :customer, GOBL::Org::Party

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

DespatchDate is the date when the goods are expected to be despatched.



133
 
# File 'lib/generated/gobl/bill/delivery.rb', line 133

property :despatch_date, GOBL::Cal::Date

#despatcher ⇒ GOBL::Org::Party (readonly)

The party who will despatch the goods defined in the invoice.



159
 
# File 'lib/generated/gobl/bill/delivery.rb', line 159

property :despatcher, GOBL::Org::Party

#discounts ⇒ Array<GOBL::Bill::Discount> (readonly)

Discounts or allowances applied to order totals



179
 
# File 'lib/generated/gobl/bill/delivery.rb', line 179

property :discounts, [GOBL::Bill::Discount]

#exchange_rates ⇒ Array<GOBL::Currency::ExchangeRate> (readonly)

Exchange rates to be used when converting the invoices monetary values into other currencies.



113
 
# File 'lib/generated/gobl/bill/delivery.rb', line 113

property :exchange_rates, [GOBL::Currency::ExchangeRate]

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

When the delivery document is to be issued.



93
 
# File 'lib/generated/gobl/bill/delivery.rb', line 93

property :issue_date, GOBL::Cal::Date

#issue_time ⇒ GOBL::Cal::Time (readonly)

IssueTime is an optional field that may be useful to indicate the time of day when the delivery was issued. Some regions and formats may require this field to be set. An empty string will be automatically updated to reflect the current time, otherwise the field can be left with a nil value.



98
 
# File 'lib/generated/gobl/bill/delivery.rb', line 98

property :issue_time, GOBL::Cal::Time

#lines ⇒ Array<GOBL::Bill::Line> (readonly)

List of lines representing each of the items to be ordered.



174
 
# File 'lib/generated/gobl/bill/delivery.rb', line 174

property :lines, [GOBL::Bill::Line]

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

Additional semi-structured data that doesn’t fit into the body of the delivery.



204
 
# File 'lib/generated/gobl/bill/delivery.rb', line 204

property :meta, GOBL::CBC::Meta

#notes ⇒ Array<GOBL::Org::Note> (readonly)

Unstructured information that is relevant to the delivery, such as correction or additional legal details.



194
 
# File 'lib/generated/gobl/bill/delivery.rb', line 194

property :notes, [GOBL::Org::Note]

#ordering ⇒ GOBL::Bill::Ordering (readonly)

Ordering details for the delivery, including links to other documents.



118
 
# File 'lib/generated/gobl/bill/delivery.rb', line 118

property :ordering, GOBL::Bill::Ordering

#preceding ⇒ Array<GOBL::Org::DocumentRef> (readonly)

Key information regarding previous delivery documents that this one will either extend or replace.



123
 
# File 'lib/generated/gobl/bill/delivery.rb', line 123

property :preceding, [GOBL::Org::DocumentRef]

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

ReceiveDate is the date when the goods are expected to be received.



138
 
# File 'lib/generated/gobl/bill/delivery.rb', line 138

property :receive_date, GOBL::Cal::Date

#receiver ⇒ GOBL::Org::Party (readonly)

The party who will receive delivery of the goods defined in the invoice.



164
 
# File 'lib/generated/gobl/bill/delivery.rb', line 164

property :receiver, GOBL::Org::Party

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

Series is used to identify groups of deliveries by date, business area, project, type, customer, a combination of any, or other company specific data. If the output format does not support the series as a separate field, it will be prepended to the code for presentation with a dash (‘-`) for separation.



83
 
# File 'lib/generated/gobl/bill/delivery.rb', line 83

property :series, GOBL::CBC::Code

#supplier ⇒ GOBL::Org::Party (readonly)

The entity supplying the goods or services and usually responsible for paying taxes.



148
 
# File 'lib/generated/gobl/bill/delivery.rb', line 148

property :supplier, GOBL::Org::Party

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

Special tax configuration for calculating totals.



143
 
# File 'lib/generated/gobl/bill/delivery.rb', line 143

property :tax, GOBL::Bill::Tax

#totals ⇒ GOBL::Bill::Totals (readonly)

Summary of all the order totals, including taxes (calculated).



189
 
# File 'lib/generated/gobl/bill/delivery.rb', line 189

property :totals, GOBL::Bill::Totals

#tracking ⇒ Tracking (readonly)

Tracking is used to define specific codes or IDs that may be used to identify and track delivery.



128
 
# File 'lib/generated/gobl/bill/delivery.rb', line 128

property :tracking, Tracking

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

Type of delivery document.



76
 
# File 'lib/generated/gobl/bill/delivery.rb', line 76

property :type, GOBL::CBC::Key

#uuid ⇒ String (readonly)

Universally Unique Identifier.



59
 
# File 'lib/generated/gobl/bill/delivery.rb', line 59

property :uuid, String

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

When the taxes of this delivery become accountable, if none set, the issue date is used.



103
 
# File 'lib/generated/gobl/bill/delivery.rb', line 103

property :value_date, GOBL::Cal::Date