gobl 0.20.0 → 0.22.0

data/lib/generated/gobl/org/registration.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,8 +13,13 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/org/registration'
 
       # @!attribute [r] uuid
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
+
+      # @!attribute [r] label
+      # @return [String]
+      property :label, String
 
       # @!attribute [r] capital
       # @return [GOBL::Num::Amount]
@@ -52,6 +56,10 @@ module GOBL
       # @!attribute [r] entry
       # @return [String]
       property :entry, String
+
+      # @!attribute [r] other
+      # @return [String]
+      property :other, String
     end
   end
 end

data/lib/generated/gobl/org/telephone.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/org/telephone'
 
       # @!attribute [r] uuid
-      # Unique identity code
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] label
       # Identifier for this number.

data/lib/generated/gobl/org/unit.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/org/website.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,12 +13,12 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/org/website'
 
       # @!attribute [r] uuid
-      # Unique identity code
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] label
-      # Identifier for this number.
+      # Label for the website to show alongside the URL.
       # @return [String]
       property :label, String
 

data/lib/generated/gobl/pay/advance.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/pay/advance'
 
       # @!attribute [r] uuid
-      # Unique identifier for this advance.
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] date
       # When the advance was made.
@@ -86,6 +85,11 @@ module GOBL
       # @return [CreditTransfer]
       property :credit_transfer, CreditTransfer
 
+      # @!attribute [r] ext
+      # Tax extensions required by tax regimes or addons.
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
+
       # @!attribute [r] meta
       # Additional details useful for the parties involved.
       # @return [GOBL::CBC::Meta]

data/lib/generated/gobl/pay/card.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/pay/credit_transfer.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/pay/direct_debit.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/pay/due_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/pay/instructions.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -70,6 +69,11 @@ module GOBL
       # @return [String]
       property :notes, String
 
+      # @!attribute [r] ext
+      # Extension key-pairs values defined by a tax regime.
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
+
       # @!attribute [r] meta
       # Non-structured additional data that may be useful.
       # @return [GOBL::CBC::Meta]

data/lib/generated/gobl/pay/online.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -13,16 +12,21 @@ module GOBL
       # The Schema ID of the GOBL Online structure
       SCHEMA_ID = 'https://gobl.org/draft-0/pay/instructions#/$defs/Online'
 
-      # @!attribute [r] name
-      # Descriptive name given to the online provider.
+      # @!attribute [r] key
+      # Key identifier for this online payment method.
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
+
+      # @!attribute [r] label
+      # Descriptive label for the online provider.
       # @return [String]
-      property :name, String
+      property :label, String
 
-      # @!attribute [r] addr
-      # Full URL to be used for payment.
+      # @!attribute [r] url
+      # URL to be used for payment.
       # @return [String]
-      property :addr, String
-      validates_presence_of :addr
+      property :url, String
+      validates_presence_of :url
     end
   end
 end

data/lib/generated/gobl/pay/terms.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/regimes/mx/food_vouchers.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/regimes/mx/food_vouchers_employee.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/regimes/mx/food_vouchers_line.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/regimes/mx/fuel_account_balance.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/regimes/mx/fuel_account_item.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/regimes/mx/fuel_account_line.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -60,7 +59,6 @@ module GOBL
         # Result of quantity multiplied by the unit price (maps to `Importe`).
         # @return [GOBL::Num::Amount]
         property :total, GOBL::Num::Amount
-        validates_presence_of :total
 
         # @!attribute [r] taxes
         # Map of taxes applied to the purchase (maps to `Traslados`).

data/lib/generated/gobl/regimes/mx/fuel_account_tax.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -14,23 +13,26 @@ module GOBL
         # The Schema ID of the GOBL FuelAccountTax structure
         SCHEMA_ID = 'https://gobl.org/draft-0/regimes/mx/fuel-account-balance#/$defs/FuelAccountTax'
 
-        # @!attribute [r] code
-        # Code that identifies the tax ("IVA" or "IEPS", maps to `Impuesto`)
+        # @!attribute [r] cat
+        # Category that identifies the tax ("VAT" or "IEPS", maps to `Impuesto`)
         # @return [GOBL::CBC::Code]
-        property :code, GOBL::CBC::Code
-        validates_presence_of :code
+        property :cat, GOBL::CBC::Code
+        validates_presence_of :cat
+
+        # @!attribute [r] percent
+        # Percent applicable to the line total (tasa) to use instead of Rate (maps to `TasaoCuota`)
+        # @return [GOBL::Num::Percentage]
+        property :percent, GOBL::Num::Percentage
 
         # @!attribute [r] rate
-        # Rate applicable to either the line total (tasa) or the line quantity (cuota) (maps to `TasaOCuota`).
+        # Rate is a fixed fee to apply to the line quantity (cuota) (maps to `TasaOCuota`)
         # @return [GOBL::Num::Amount]
         property :rate, GOBL::Num::Amount
-        validates_presence_of :rate
 
         # @!attribute [r] amount
-        # Total amount of the tax once the rate has been applied (maps to `Importe`).
+        # Total amount of the tax once the percent or rate has been applied (maps to `Importe`).
         # @return [GOBL::Num::Amount]
         property :amount, GOBL::Num::Amount
-        validates_presence_of :amount
       end
     end
   end

data/lib/generated/gobl/schema/object.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/tax/addon_def.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Tax
+    # AddonDef is an interface that defines the methods that a tax add-on must implement.
+    class AddonDef < GOBL::Object
+      # The Schema ID of the GOBL AddonDef structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/addon-def'
+
+      # @!attribute [r] key
+      # Key that defines how to uniquely idenitfy the add-on.
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
+      validates_presence_of :key
+
+      # @!attribute [r] name
+      # Name of the add-on
+      # @return [GOBL::I18n::String]
+      property :name, GOBL::I18n::String
+      validates_presence_of :name
+
+      # @!attribute [r] description
+      # Description of the add-on
+      # @return [GOBL::I18n::String]
+      property :description, GOBL::I18n::String
+
+      # @!attribute [r] extensions
+      # Extensions defines the list of extensions that are associated with an add-on.
+      # @return [Array<GOBL::CBC::KeyDefinition>]
+      property :extensions, [GOBL::CBC::KeyDefinition]
+      validates_presence_of :extensions
+
+      # @!attribute [r] tags
+      # Tags is slice of tag sets that define what can be assigned to each document schema.
+      # @return [Array<TagSet>]
+      property :tags, [TagSet]
+
+      # @!attribute [r] scenarios
+      # Scenarios are applied to documents after normalization and before validation to ensure that form specific extensions have been added to the document.
+      # @return [Array<ScenarioSet>]
+      property :scenarios, [ScenarioSet]
+      validates_presence_of :scenarios
+
+      # @!attribute [r] inboxes
+      # Inboxes is a list of keys that are used to identify where copies of documents can be sent.
+      # @return [Array<GOBL::CBC::KeyDefinition>]
+      property :inboxes, [GOBL::CBC::KeyDefinition]
+
+      # @!attribute [r] corrections
+      # Corrections is used to provide a map of correction definitions that are supported by the add-on.
+      # @return [CorrectionSet]
+      property :corrections, CorrectionSet
+      validates_presence_of :corrections
+    end
+  end
+end

data/lib/generated/gobl/tax/{category.rb → category_def.rb}

@@ -3,15 +3,14 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
   module Tax
-    # Category contains the definition of a general type of tax inside a region.
-    class Category < GOBL::Object
-      # The Schema ID of the GOBL Category structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/Category'
+    # CategoryDef contains the definition of a general type of tax inside a region.
+    class CategoryDef < GOBL::Object
+      # The Schema ID of the GOBL CategoryDef structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime-def#/$defs/CategoryDef'
 
       # @!attribute [r] code
       # Code to be used in documents
@@ -40,15 +39,10 @@ module GOBL
       # @return [Boolean]
       property :retained, Boolean
 
-      # @!attribute [r] rate_required
-      # RateRequired when true implies that when a tax combo is defined using this category that one of the rate's keys must be defined. This is normally needed for regimes that categorize taxes in local document formats as opposed to grouping by percentage values.
-      # @return [Boolean]
-      property :rate_required, Boolean
-
       # @!attribute [r] rates
       # Specific tax definitions inside this category.
-      # @return [Array<Rate>]
-      property :rates, [Rate]
+      # @return [Array<RateDef>]
+      property :rates, [RateDef]
 
       # @!attribute [r] extensions
       # Extensions defines a list of extension keys that may be used or required as an alternative or alongside choosing a rate for the tax category. Every key must be defined in the Regime's extensions table.
@@ -65,6 +59,11 @@ module GOBL
       # @return [Array<Source>]
       property :sources, [Source]
 
+      # @!attribute [r] ext
+      # Extensions key-value pairs that will be copied to the tax combo if this category is used.
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
+
       # @!attribute [r] meta
       # Meta contains additional information about the category that is relevant for local frequently used formats.
       # @return [GOBL::CBC::Meta]

data/lib/generated/gobl/tax/category_total.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/tax/combo.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -19,13 +18,18 @@ module GOBL
       property :cat, GOBL::CBC::Code
       validates_presence_of :cat
 
+      # @!attribute [r] country
+      # Country code override when issuing with taxes applied from different countries.
+      # @return [GOBL::L10n::TaxCountryCode]
+      property :country, GOBL::L10n::TaxCountryCode
+
       # @!attribute [r] rate
       # Rate within a category to apply.
       # @return [GOBL::CBC::Key]
       property :rate, GOBL::CBC::Key
 
       # @!attribute [r] percent
-      # Percent defines the percentage set manually or determined from the rate key (calculated if rate present).
+      # Percent defines the percentage set manually or determined from the rate key (calculated if rate present). A nil percent implies that this tax combo is **exempt** from tax.
       # @return [GOBL::Num::Percentage]
       property :percent, GOBL::Num::Percentage
 

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

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -11,7 +10,7 @@ module GOBL
     # CorrectionDefinition contains details about what can be defined in .
     class CorrectionDefinition < GOBL::Object
       # The Schema ID of the GOBL CorrectionDefinition structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/CorrectionDefinition'
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime-def#/$defs/CorrectionDefinition'
 
       # @!attribute [r] schema
       # Partial or complete schema URL for the document type supported by correction.

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Tax
+    # CorrectionSet defines a set of correction definitions for a selection of schemas.
+    CorrectionSet = [CorrectionDefinition] # rubocop:disable Naming/ConstantName, Style/MutableConstant
+  end
+end

data/lib/generated/gobl/tax/extensions.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/tax/identity.rb

@@ -3,41 +3,35 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
   module Tax
-    # Identity stores the details required to identify an entity for tax purposes.
+    # Identity stores the details required to identify an entity for tax purposes in a specific country.
     class Identity < GOBL::Object
       # The Schema ID of the GOBL Identity structure
       SCHEMA_ID = 'https://gobl.org/draft-0/tax/identity'
 
-      # @!attribute [r] uuid
-      # Unique universal identity code for this tax identity.
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
-
       # @!attribute [r] country
-      # ISO country code for Where the tax identity was issued.
-      # @return [GOBL::L10n::CountryCode]
-      property :country, GOBL::L10n::CountryCode
+      # Tax country code for Where the tax identity was issued.
+      # @return [GOBL::L10n::TaxCountryCode]
+      property :country, GOBL::L10n::TaxCountryCode
       validates_presence_of :country
 
-      # @!attribute [r] type
-      # Type is set according the requirements of each regime, some have a single tax document type code, others require a choice to be made.
-      # @return [GOBL::CBC::Key]
-      property :type, GOBL::CBC::Key
-
       # @!attribute [r] code
       # Normalized code shown on the original identity document.
       # @return [GOBL::CBC::Code]
       property :code, GOBL::CBC::Code
 
-      # @!attribute [r] meta
-      # Additional details that may be required.
-      # @return [GOBL::CBC::Meta]
-      property :meta, GOBL::CBC::Meta
+      # @!attribute [r] type
+      # Type is set according to the requirements of each regime, some have a single tax document type code, others require a choice to be made. Deprecated: Tax Identities should only be used for VAT or similar codes for companies. Use the identities array for other types of identification.
+      # @return [GOBL::CBC::Key]
+      property :type, GOBL::CBC::Key
+
+      # @!attribute [r] zone
+      # Zone identifies a sub-locality within a country. Deprecated: Removed 2024-03-14 in favour of using tax tags and extensions with local data when required. Maintained here to support data migration.
+      # @return [GOBL::L10n::Code]
+      property :zone, GOBL::L10n::Code
     end
   end
 end

data/lib/generated/gobl/tax/{rate.rb → rate_def.rb}

@@ -3,15 +3,14 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
   module Tax
-    # Rate defines a single rate inside a category
-    class Rate < GOBL::Object
-      # The Schema ID of the GOBL Rate structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/Rate'
+    # RateDef defines a single rate inside a category
+    class RateDef < GOBL::Object
+      # The Schema ID of the GOBL RateDef structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime-def#/$defs/RateDef'
 
       # @!attribute [r] key
       # Key identifies this rate within the system
@@ -37,18 +36,13 @@ module GOBL
 
       # @!attribute [r] values
       # Values contains a list of Value objects that contain the current and historical percentage values for the rate and additional filters. Order is important, newer values should come before older values.
-      # @return [Array<RateValue>]
-      property :values, [RateValue]
-
-      # @!attribute [r] extensions
-      # Extensions defines a list of keys for codes that can or must be associated with the tax rate for it to be validated. Every key must be defined in the Regime's extensions.
-      # @return [Array<GOBL::CBC::Key>]
-      property :extensions, [GOBL::CBC::Key]
-
-      # @!attribute [r] map
-      # Map is used to associate specific codes with the chosen rate.
-      # @return [GOBL::CBC::CodeMap]
-      property :map, GOBL::CBC::CodeMap
+      # @return [Array<RateValueDef>]
+      property :values, [RateValueDef]
+
+      # @!attribute [r] ext
+      # Extensions key-value pair that will be copied to the tax combo if this rate is used.
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
 
       # @!attribute [r] meta
       # Meta contains additional information about the rate that is relevant for local frequently used implementations.

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

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -18,6 +17,11 @@ module GOBL
       # @return [GOBL::CBC::Key]
       property :key, GOBL::CBC::Key
 
+      # @!attribute [r] country
+      # Country code override when issuing with taxes applied from different countries, it'd be very strange to mix rates from different countries, but in theory this would be possible.
+      # @return [GOBL::L10n::TaxCountryCode]
+      property :country, GOBL::L10n::TaxCountryCode
+
       # @!attribute [r] ext
       # If the rate is defined with extensions, they'll be used to group by also.
       # @return [GOBL::Tax::Extensions]
@@ -30,7 +34,7 @@ module GOBL
       validates_presence_of :base
 
       # @!attribute [r] percent
-      # Percentage of the rate, which may be nil for exempt rates.
+      # Percentage of the rate. Will be nil when taxes are **exempt**.
       # @return [GOBL::Num::Percentage]
       property :percent, GOBL::Num::Percentage