gobl 0.20.0 → 0.22.0

data/lib/generated/gobl/bill/correction_options.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -24,6 +23,11 @@ module GOBL
       # @return [GOBL::Cal::Date]
       property :issue_date, GOBL::Cal::Date
 
+      # @!attribute [r] series
+      # Series to assign to the new corrective invoice.
+      # @return [GOBL::CBC::Code]
+      property :series, GOBL::CBC::Code
+
       # @!attribute [r] stamps
       # Stamps of the previous document to include in the preceding data.
       # @return [Array<GOBL::Head::Stamp>]

data/lib/generated/gobl/bill/delivery.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/bill/discount.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,9 +13,9 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Discount'
 
       # @!attribute [r] uuid
-      # Unique identifying for the discount entry
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] i
       # Line number inside the list of discounts (calculated)
@@ -29,12 +28,12 @@ module GOBL
       property :ref, String
 
       # @!attribute [r] base
-      # Base represents the value used as a base for percent calculations. If not already provided, we'll take the invoices sum.
+      # Base represents the value used as a base for percent calculations instead of the invoice's sum of lines.
       # @return [GOBL::Num::Amount]
       property :base, GOBL::Num::Amount
 
       # @!attribute [r] percent
-      # Percentage to apply to the invoice's Sum.
+      # Percentage to apply to the base or invoice's sum.
       # @return [GOBL::Num::Percentage]
       property :percent, GOBL::Num::Percentage
 

data/lib/generated/gobl/bill/invoice.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -13,10 +12,45 @@ module GOBL
       # The Schema ID of the GOBL Invoice structure
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice'
 
+      # Enumeration of possible values for {#$regime} with their corresponding descriptions
+      $REGIME_ENUM = {
+        'AT' => 'Austria',
+        'BE' => 'Belgium',
+        'CA' => 'Canada',
+        'CH' => 'Switzerland',
+        'CO' => 'Colombia',
+        'DE' => 'Germany',
+        'EL' => 'Greece',
+        'ES' => 'Spain',
+        'FR' => 'France',
+        'GB' => 'United Kingdom',
+        'IT' => 'Italy',
+        'MX' => 'Mexico',
+        'NL' => 'The Netherlands',
+        'PL' => 'Poland',
+        'PT' => 'Portugal',
+        'US' => 'United States of America'
+      }.freeze
+
+      # @!attribute [r] $regime
+      # @return [GOBL::L10n::TaxCountryCode]
+      property :$regime, GOBL::L10n::TaxCountryCode
+      validates_inclusion_of :$regime, in: $REGIME_ENUM.keys, allow_blank: true
+
+      # @!attribute [r] $addons
+      # Addons defines a list of keys used to identify tax addons that apply special normalization, scenarios, and validation rules to a document.
+      # @return [Array<GOBL::CBC::Key>]
+      property :$addons, [GOBL::CBC::Key]
+
+      # @!attribute [r] $tags
+      # Tags are used to help identify specific tax scenarios or requirements that will apply changes to the contents of the invoice. Tags by design should always be optional, it should always be possible to build a valid invoice without any tags.
+      # @return [Array<GOBL::CBC::Key>]
+      property :$tags, [GOBL::CBC::Key]
+
       # @!attribute [r] uuid
-      # Unique document ID. Not required, but always recommended in addition to the Code.
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # Enumeration of possible values for {#type} with their corresponding descriptions
       TYPE_ENUM = {
@@ -25,7 +59,12 @@ module GOBL
         '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.'
+        'debit-note' => 'An additional set of charges to be added to the preceding document.',
+        'other' => 'Any other type of invoice that does not fit into the standard categories and implies
+      that any scenarios defined in tax regimes or addons will not be applied.
+
+      This is useful for being able to create invoices with custom types in extensions,
+      but is not recommend for general use.'
       }.freeze
 
       # @!attribute [r] type
@@ -36,13 +75,13 @@ module GOBL
 
       # @!attribute [r] series
       # Used as a prefix to group codes.
-      # @return [String]
-      property :series, String
+      # @return [GOBL::CBC::Code]
+      property :series, GOBL::CBC::Code
 
       # @!attribute [r] code
       # Sequential code used to identify this invoice in tax declarations.
-      # @return [String]
-      property :code, String
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
       validates_presence_of :code
 
       # @!attribute [r] issue_date
@@ -72,8 +111,8 @@ module GOBL
 
       # @!attribute [r] preceding
       # Key information regarding previous invoices and potentially details as to why they were corrected.
-      # @return [Array<Preceding>]
-      property :preceding, [Preceding]
+      # @return [Array<GOBL::Org::DocumentRef>]
+      property :preceding, [GOBL::Org::DocumentRef]
 
       # @!attribute [r] tax
       # Special tax configuration for billing.
@@ -87,7 +126,7 @@ module GOBL
       validates_presence_of :supplier
 
       # @!attribute [r] customer
-      # Legal entity receiving the goods or services, may be empty in certain circumstances such as simplified invoices.
+      # Legal entity receiving the goods or services, may be nil in certain circumstances such as simplified invoices.
       # @return [GOBL::Org::Party]
       property :customer, GOBL::Org::Party
 

data/lib/generated/gobl/bill/line.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,9 +13,9 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Line'
 
       # @!attribute [r] uuid
-      # Unique identifier for this line
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] i
       # Line number inside the parent (calculated)

data/lib/generated/gobl/bill/line_charge.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/bill/line_discount.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/bill/ordering.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -15,8 +14,8 @@ module GOBL
 
       # @!attribute [r] code
       # Identifier assigned by the customer or buyer for internal routing purposes.
-      # @return [String]
-      property :code, String
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
 
       # @!attribute [r] identities
       # Any additional Codes, IDs, SKUs, or other regional or custom identifiers that may be used to identify the order.
@@ -28,50 +27,50 @@ module GOBL
       # @return [GOBL::Cal::Period]
       property :period, GOBL::Cal::Period
 
-      # @!attribute [r] project
-      # Project this invoice refers to.
-      # @return [DocumentReference]
-      property :project, DocumentReference
+      # @!attribute [r] buyer
+      # Party who is responsible for making the purchase, but is not responsible for handling taxes.
+      # @return [GOBL::Org::Party]
+      property :buyer, GOBL::Org::Party
+
+      # @!attribute [r] seller
+      # Party who is selling the goods but is not responsible for taxes like the supplier.
+      # @return [GOBL::Org::Party]
+      property :seller, GOBL::Org::Party
+
+      # @!attribute [r] projects
+      # Projects this invoice refers to.
+      # @return [Array<GOBL::Org::DocumentRef>]
+      property :projects, [GOBL::Org::DocumentRef]
 
-      # @!attribute [r] contract
-      # The identification of a contract.
-      # @return [DocumentReference]
-      property :contract, DocumentReference
+      # @!attribute [r] contracts
+      # The identification of contracts.
+      # @return [Array<GOBL::Org::DocumentRef>]
+      property :contracts, [GOBL::Org::DocumentRef]
 
-      # @!attribute [r] purchase
-      # Purchase order issued by the customer or buyer.
-      # @return [DocumentReference]
-      property :purchase, DocumentReference
+      # @!attribute [r] purchases
+      # Purchase orders issued by the customer or buyer.
+      # @return [Array<GOBL::Org::DocumentRef>]
+      property :purchases, [GOBL::Org::DocumentRef]
 
-      # @!attribute [r] sale
-      # Sales order issued by the supplier or seller.
-      # @return [DocumentReference]
-      property :sale, DocumentReference
+      # @!attribute [r] sales
+      # Sales orders issued by the supplier or seller.
+      # @return [Array<GOBL::Org::DocumentRef>]
+      property :sales, [GOBL::Org::DocumentRef]
 
       # @!attribute [r] receiving
       # Receiving Advice.
-      # @return [DocumentReference]
-      property :receiving, DocumentReference
+      # @return [Array<GOBL::Org::DocumentRef>]
+      property :receiving, [GOBL::Org::DocumentRef]
 
       # @!attribute [r] despatch
       # Despatch advice.
-      # @return [DocumentReference]
-      property :despatch, DocumentReference
+      # @return [Array<GOBL::Org::DocumentRef>]
+      property :despatch, [GOBL::Org::DocumentRef]
 
       # @!attribute [r] tender
       # Tender advice, the identification of the call for tender or lot the invoice relates to.
-      # @return [DocumentReference]
-      property :tender, DocumentReference
-
-      # @!attribute [r] buyer
-      # Party who is responsible for making the purchase, but is not responsible for handling taxes.
-      # @return [GOBL::Org::Party]
-      property :buyer, GOBL::Org::Party
-
-      # @!attribute [r] seller
-      # Party who is selling the goods but is not responsible for taxes like the supplier.
-      # @return [GOBL::Org::Party]
-      property :seller, GOBL::Org::Party
+      # @return [Array<GOBL::Org::DocumentRef>]
+      property :tender, [GOBL::Org::DocumentRef]
     end
   end
 end

data/lib/generated/gobl/bill/outlay.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,9 +13,9 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Outlay'
 
       # @!attribute [r] uuid
-      # Unique identity for this outlay.
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] i
       # Outlay number index inside the invoice for ordering (calculated).

data/lib/generated/gobl/bill/payment.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/bill/tax.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -18,10 +17,10 @@ module GOBL
       # @return [GOBL::CBC::Code]
       property :prices_include, GOBL::CBC::Code
 
-      # @!attribute [r] tags
-      # Special tax tags that apply to this invoice according to local requirements.
-      # @return [Array<GOBL::CBC::Key>]
-      property :tags, [GOBL::CBC::Key]
+      # @!attribute [r] ext
+      # Additional extensions that are applied to the invoice as a whole as opposed to specific sections.
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
 
       # @!attribute [r] meta
       # Any additional data that may be required for processing, but should never be relied upon by recipients.

data/lib/generated/gobl/bill/totals.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/cal/date.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/cal/date_time.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/cal/period.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/cbc/code.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/cbc/code_map.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/cbc/key.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/cbc/key_definition.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -35,15 +34,10 @@ module GOBL
       # @return [GOBL::CBC::Meta]
       property :meta, GOBL::CBC::Meta
 
-      # @!attribute [r] codes
-      # Codes describes the list of codes that can be used alongside the Key, for example with identities.
-      # @return [Array<GOBL::CBC::CodeDefinition>]
-      property :codes, [GOBL::CBC::CodeDefinition]
-
-      # @!attribute [r] keys
-      # Keys is used instead of codes to define a further sub-set of keys that can be used alongside this one.
-      # @return [Array<GOBL::CBC::KeyDefinition>]
-      property :keys, [GOBL::CBC::KeyDefinition]
+      # @!attribute [r] values
+      # Values defines the possible values associated with the key.
+      # @return [Array<GOBL::CBC::ValueDefinition>]
+      property :values, [GOBL::CBC::ValueDefinition]
 
       # @!attribute [r] pattern
       # Pattern is used to validate the key value instead of using a fixed value from the code or key definitions.

data/lib/generated/gobl/cbc/meta.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/cbc/note.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL

data/lib/generated/gobl/cbc/value_definition.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module CBC
+    # ValueDefinition describes a specific value and how it maps to a human name and description if appropriate.
+    class ValueDefinition < GOBL::Object
+      # The Schema ID of the GOBL ValueDefinition structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/cbc/value-definition'
+
+      # @!attribute [r] value
+      # Value for which the definition is for.
+      # @return [String]
+      property :value, String
+      validates_presence_of :value
+
+      # @!attribute [r] name
+      # Short name for the value, if relevant.
+      # @return [GOBL::I18n::String]
+      property :name, GOBL::I18n::String
+
+      # @!attribute [r] desc
+      # Description offering more details about when the value should be used.
+      # @return [GOBL::I18n::String]
+      property :desc, GOBL::I18n::String
+
+      # @!attribute [r] meta
+      # Meta defines any additional details that may be useful or associated with the value.
+      # @return [GOBL::CBC::Meta]
+      property :meta, GOBL::CBC::Meta
+    end
+  end
+end

data/lib/generated/gobl/currency/amount.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Currency
+    # An Amount represents a monetary value in a specific currency.
+    class Amount < GOBL::Object
+      # The Schema ID of the GOBL Amount structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/currency/amount'
+
+      # @!attribute [r] label
+      # Label allows for additional information to be added to the currency Amount that may be useful.
+      # @return [String]
+      property :label, String
+
+      # @!attribute [r] currency
+      # Code defines the currency for this amount.
+      # @return [GOBL::Currency::Code]
+      property :currency, GOBL::Currency::Code
+      validates_presence_of :currency
+
+      # @!attribute [r] value
+      # Value is the amount in the currency.
+      # @return [GOBL::Num::Amount]
+      property :value, GOBL::Num::Amount
+      validates_presence_of :value
+    end
+  end
+end