gobl 0.19.0 → 0.21.0

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.67.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.67.0
 ##
 
 module GOBL

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

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.67.0
 ##
 
 module GOBL
@@ -41,7 +40,7 @@ module GOBL
       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.
+      # 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. Try to avoid using this. It is better for rates to be determined by the percentage and conditions, not the rate key.
       # @return [Boolean]
       property :rate_required, Boolean
 

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

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.67.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.67.0
 ##
 
 module GOBL
@@ -25,7 +24,7 @@ module GOBL
       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
 
@@ -36,8 +35,8 @@ module GOBL
 
       # @!attribute [r] ext
       # Local codes that apply for a given rate or percentage that need to be identified and validated.
-      # @return [GOBL::Tax::ExtMap]
-      property :ext, GOBL::Tax::ExtMap
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
     end
   end
 end

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

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

data/lib/generated/gobl/tax/{ext_map.rb → extensions.rb}

@@ -3,13 +3,12 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.67.0
 ##
 
 module GOBL
   module Tax
-    # ExtMap is a map of extension keys to either a code or a key.
-    class ExtMap < GOBL::Map
+    # Extensions is a map of extension keys to values.
+    class Extensions < GOBL::Map
     end
   end
 end

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

@@ -3,46 +3,35 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.67.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
       validates_presence_of :country
 
-      # @!attribute [r] zone
-      # Where inside the country the tax identity holder is based for tax purposes like a village, town, district, city, county, state or province. For some areas, this could be a regular post or zip code. See the regime packages for specific validation rules.
-      # @return [GOBL::L10n::Code]
-      property :zone, GOBL::L10n::Code
-
-      # @!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

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

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

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.67.0
 ##
 
 module GOBL
@@ -20,8 +19,8 @@ module GOBL
 
       # @!attribute [r] ext
       # If the rate is defined with extensions, they'll be used to group by also.
-      # @return [GOBL::Tax::ExtMap]
-      property :ext, GOBL::Tax::ExtMap
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
 
       # @!attribute [r] base
       # Base amount that the percentage is applied to.
@@ -30,7 +29,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
 

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

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

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

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.67.0
 ##
 
 module GOBL
@@ -13,10 +12,15 @@ module GOBL
       # The Schema ID of the GOBL RateValue structure
       SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/RateValue'
 
-      # @!attribute [r] zones
-      # Only use this value if one of the zones matches.
-      # @return [Array<GOBL::L10n::Code>]
-      property :zones, [GOBL::L10n::Code]
+      # @!attribute [r] tags
+      # Only apply this rate if one of the tags is present in the invoice.
+      # @return [Array<GOBL::CBC::Key>]
+      property :tags, [GOBL::CBC::Key]
+
+      # @!attribute [r] ext
+      # Ext map of keys that can be used to filter to determine if the rate applies.
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
 
       # @!attribute [r] since
       # Date from which this value should be applied.

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

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.67.0
 ##
 
 module GOBL
@@ -49,33 +48,38 @@ module GOBL
 
       # @!attribute [r] tags
       # Tags that can be applied at the document level to identify additional considerations.
-      # @return [Array<KeyDefinition>]
-      property :tags, [KeyDefinition]
-
-      # @!attribute [r] identity_types
-      # Identity types specific for the regime and may be validated against.
-      # @return [Array<KeyDefinition>]
-      property :identity_types, [KeyDefinition]
+      # @return [Array<GOBL::CBC::KeyDefinition>]
+      property :tags, [GOBL::CBC::KeyDefinition]
 
       # @!attribute [r] extensions
       # Extensions defines the keys that can be used for extended or extra data inside the regime that is specific to the regime and cannot be easily determined from other GOBL structures. Typically these are used to define local codes for suppliers, customers, products, or tax rates.
-      # @return [Array<KeyDefinition>]
-      property :extensions, [KeyDefinition]
+      # @return [Array<GOBL::CBC::KeyDefinition>]
+      property :extensions, [GOBL::CBC::KeyDefinition]
+
+      # @!attribute [r] tax_identity_type_keys
+      # Tax Identity types specific for the regime and may be validated against.
+      # @return [Array<GOBL::CBC::KeyDefinition>]
+      property :tax_identity_type_keys, [GOBL::CBC::KeyDefinition]
 
-      # @!attribute [r] charge_types
-      # Charge types specific for the regime and may be validated or used in the UI as suggestions
-      # @return [Array<KeyDefinition>]
-      property :charge_types, [KeyDefinition]
+      # @!attribute [r] identity_keys
+      # Identity keys used in addition to regular tax identities and specific for the regime that may be validated against.
+      # @return [Array<GOBL::CBC::KeyDefinition>]
+      property :identity_keys, [GOBL::CBC::KeyDefinition]
 
-      # @!attribute [r] payment_means
+      # @!attribute [r] charge_keys
+      # Charge keys specific for the regime and may be validated or used in the UI as suggestions
+      # @return [Array<GOBL::CBC::KeyDefinition>]
+      property :charge_keys, [GOBL::CBC::KeyDefinition]
+
+      # @!attribute [r] payment_means_keys
       # PaymentMeansKeys specific for the regime that extend the original base payment means keys.
-      # @return [Array<KeyDefinition>]
-      property :payment_means, [KeyDefinition]
+      # @return [Array<GOBL::CBC::KeyDefinition>]
+      property :payment_means_keys, [GOBL::CBC::KeyDefinition]
 
       # @!attribute [r] inbox_keys
       # InboxKeys specific to the regime that can be used to identify where a document should be forwarded to.
-      # @return [Array<KeyDefinition>]
-      property :inbox_keys, [KeyDefinition]
+      # @return [Array<GOBL::CBC::KeyDefinition>]
+      property :inbox_keys, [GOBL::CBC::KeyDefinition]
 
       # @!attribute [r] scenarios
       # @return [Array<ScenarioSet>]
@@ -91,11 +95,6 @@ module GOBL
       # @return [Array<Category>]
       property :categories, [Category]
       validates_presence_of :categories
-
-      # @!attribute [r] zones
-      # List of zones to identify specific areas, regions, or provinces inside a country tha may be required for tax purposes.
-      # @return [Array<Zone>]
-      property :zones, [Zone]
     end
   end
 end

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

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

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

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

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

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

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

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

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

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

data/lib/gobl/operations/validation_result.rb

@@ -4,8 +4,6 @@ module GOBL
   module Operations
     # The result of a GOBL validation over a GOBL structure
     class ValidationResult
-      SERVICE_ERROR_REGEX = /^code=(?<code>\d+), message=(?<msg>.+)$/.freeze # @api private
-
       def initialize(errors)
         @errors = errors
       end
@@ -30,7 +28,7 @@ module GOBL
       # @param service_error [String]
       # @return [ValidationResult]
       def self.from_service_error(service_error)
-        message = service_error.match(SERVICE_ERROR_REGEX)[:msg]
+        message = service_error["message"] || service_error["key"]
         errors = message.split('; ')
         new errors
       end

data/lib/gobl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GOBL
-  VERSION = '0.19.0'
+  VERSION = '0.21.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gobl
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Luismi Cavalle
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-05 00:00:00.000000000 Z
+date: 2024-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -62,12 +62,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- data/regimes/at.json
+- data/regimes/be.json
 - data/regimes/ca.json
+- data/regimes/ch.json
 - data/regimes/co.json
 - data/regimes/de.json
 - data/regimes/es.json
 - data/regimes/fr.json
 - data/regimes/gb.json
+- data/regimes/gr.json
 - data/regimes/it.json
 - data/regimes/mx.json
 - data/regimes/nl.json
@@ -93,10 +97,13 @@ files:
 - lib/generated/gobl/cal/date_time.rb
 - lib/generated/gobl/cal/period.rb
 - lib/generated/gobl/cbc/code.rb
+- lib/generated/gobl/cbc/code_definition.rb
 - lib/generated/gobl/cbc/code_map.rb
 - lib/generated/gobl/cbc/key.rb
+- lib/generated/gobl/cbc/key_definition.rb
 - lib/generated/gobl/cbc/meta.rb
 - lib/generated/gobl/cbc/note.rb
+- lib/generated/gobl/currency/amount.rb
 - lib/generated/gobl/currency/code.rb
 - lib/generated/gobl/currency/exchange_rate.rb
 - lib/generated/gobl/dsig/digest.rb
@@ -140,12 +147,10 @@ files:
 - lib/generated/gobl/schema/object.rb
 - lib/generated/gobl/tax/category.rb
 - lib/generated/gobl/tax/category_total.rb
-- lib/generated/gobl/tax/code_definition.rb
 - lib/generated/gobl/tax/combo.rb
 - lib/generated/gobl/tax/correction_definition.rb
-- lib/generated/gobl/tax/ext_map.rb
+- lib/generated/gobl/tax/extensions.rb
 - lib/generated/gobl/tax/identity.rb
-- lib/generated/gobl/tax/key_definition.rb
 - lib/generated/gobl/tax/rate.rb
 - lib/generated/gobl/tax/rate_total.rb
 - lib/generated/gobl/tax/rate_total_surcharge.rb
@@ -156,8 +161,6 @@ files:
 - lib/generated/gobl/tax/set.rb
 - lib/generated/gobl/tax/source.rb
 - lib/generated/gobl/tax/total.rb
-- lib/generated/gobl/tax/zone.rb
-- lib/generated/gobl/uuid/uuid.rb
 - lib/gobl.rb
 - lib/gobl/config.rb
 - lib/gobl/enum.rb

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-##
-## DO NOT EDIT - This file was generated automatically.
-##
-## Generated with GOBL v0.67.0
-##
-
-module GOBL
-  module Tax
-    # Zone represents an area inside a country, like a province or a state, which shares the basic definitions of the country, but may vary in some validation rules.
-    class Zone < GOBL::Object
-      # The Schema ID of the GOBL Zone structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/Zone'
-
-      # @!attribute [r] code
-      # Unique zone code.
-      # @return [GOBL::L10n::Code]
-      property :code, GOBL::L10n::Code
-      validates_presence_of :code
-
-      # @!attribute [r] name
-      # Name of the zone to be use if a locality or region is not applicable.
-      # @return [GOBL::I18n::String]
-      property :name, GOBL::I18n::String
-
-      # @!attribute [r] locality
-      # Village, town, district, or city name which should coincide with address data.
-      # @return [GOBL::I18n::String]
-      property :locality, GOBL::I18n::String
-
-      # @!attribute [r] region
-      # Province, county, or state which should match address data.
-      # @return [GOBL::I18n::String]
-      property :region, GOBL::I18n::String
-
-      # @!attribute [r] codes
-      # Codes defines a set of regime specific code mappings.
-      # @return [GOBL::CBC::CodeMap]
-      property :codes, GOBL::CBC::CodeMap
-
-      # @!attribute [r] meta
-      # Any additional information
-      # @return [GOBL::CBC::Meta]
-      property :meta, GOBL::CBC::Meta
-    end
-  end
-end

data/lib/generated/gobl/uuid/uuid.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-##
-## DO NOT EDIT - This file was generated automatically.
-##
-## Generated with GOBL v0.67.0
-##
-
-module GOBL
-  module UUID
-    # Universally Unique Identifier. We only recommend using versions 1 and 4 within GOBL.
-    class UUID < String
-      # The Schema ID of the GOBL UUID structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/uuid/uuid'
-    end
-  end
-end