gobl 0.21.0 → 0.22.0

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

@@ -17,22 +17,21 @@ module GOBL
       # @return [String]
       property :uuid, String
 
+      # @!attribute [r] label
+      # Label can be used to provide a custom label for the party in a given context in a single language, for example "Supplier", "Host", or similar.
+      # @return [String]
+      property :label, String
+
       # @!attribute [r] name
       # Legal name or representation of the organization.
       # @return [String]
       property :name, String
-      validates_presence_of :name
 
       # @!attribute [r] alias
       # Alternate short name.
       # @return [String]
       property :alias, String
 
-      # @!attribute [r] label
-      # Label can be used to provide a custom label for the party in a given context in a single language, for example "Supplier", "Host", or similar.
-      # @return [String]
-      property :label, String
-
       # @!attribute [r] tax_id
       # The entity's legal ID code used for tax purposes. They may have other numbers, but we're only interested in those valid for tax purposes.
       # @return [GOBL::Tax::Identity]

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

@@ -17,6 +17,11 @@ module GOBL
       # @return [String]
       property :uuid, String
 
+      # @!attribute [r] label
+      # Label can be used to identify the person in a given context in a single language, for example "Attn", "Contact", "Responsible", etc.
+      # @return [String]
+      property :label, String
+
       # @!attribute [r] name
       # Complete details on the name of the person
       # @return [GOBL::Org::Name]

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

@@ -17,6 +17,10 @@ module GOBL
       # @return [String]
       property :uuid, String
 
+      # @!attribute [r] label
+      # @return [String]
+      property :label, String
+
       # @!attribute [r] capital
       # @return [GOBL::Num::Amount]
       property :capital, GOBL::Num::Amount

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

@@ -85,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/instructions.rb

@@ -69,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/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}

@@ -7,10 +7,10 @@
 
 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
@@ -39,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. 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
-
       # @!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.
@@ -64,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/combo.rb

@@ -18,6 +18,11 @@ 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]

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

@@ -10,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/identity.rb

@@ -13,9 +13,9 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/tax/identity'
 
       # @!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] code

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

@@ -7,10 +7,10 @@
 
 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
@@ -36,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

@@ -17,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]

data/lib/generated/gobl/tax/{rate_value.rb → rate_value_def.rb}

@@ -7,10 +7,10 @@
 
 module GOBL
   module Tax
-    # RateValue contains a percentage rate or fixed amount for a given date range.
-    class RateValue < GOBL::Object
-      # The Schema ID of the GOBL RateValue structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/RateValue'
+    # RateValueDef contains a percentage rate or fixed amount for a given date range.
+    class RateValueDef < GOBL::Object
+      # The Schema ID of the GOBL RateValueDef structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime-def#/$defs/RateValueDef'
 
       # @!attribute [r] tags
       # Only apply this rate if one of the tags is present in the invoice.

data/lib/generated/gobl/tax/{regime.rb → regime_def.rb}

@@ -7,13 +7,13 @@
 
 module GOBL
   module Tax
-    # Regime defines the holding structure for the definitions of taxes inside a country or territory.
-    class Regime < GOBL::Object
-      # The Schema ID of the GOBL Regime structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime'
+    # RegimeDef defines the holding structure for the definitions of taxes inside a country or territory.
+    class RegimeDef < GOBL::Object
+      # The Schema ID of the GOBL RegimeDef structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime-def'
 
       # @!attribute [r] name
-      # Name of the country
+      # Name of the tax regime.
       # @return [GOBL::I18n::String]
       property :name, GOBL::I18n::String
       validates_presence_of :name
@@ -31,10 +31,15 @@ module GOBL
 
       # @!attribute [r] country
       # Country code for the region
-      # @return [GOBL::L10n::CountryCode]
-      property :country, GOBL::L10n::CountryCode
+      # @return [GOBL::L10n::TaxCountryCode]
+      property :country, GOBL::L10n::TaxCountryCode
       validates_presence_of :country
 
+      # @!attribute [r] alt_country_codes
+      # Alternative localization codes that may be used to identify the tax regime in specific circumstances.
+      # @return [Array<GOBL::L10n::Code>]
+      property :alt_country_codes, [GOBL::L10n::Code]
+
       # @!attribute [r] zone
       # Specific Locality, region, city, province, county, or similar code inside the country, if needed.
       # @return [GOBL::L10n::Code]
@@ -46,10 +51,15 @@ module GOBL
       property :currency, GOBL::Currency::Code
       validates_presence_of :currency
 
+      # @!attribute [r] calculator_rounding_rule
+      # Rounding rule to use when calculating the tax totals, default is always `sum-then-round`.
+      # @return [String]
+      property :calculator_rounding_rule, String
+
       # @!attribute [r] tags
       # Tags that can be applied at the document level to identify additional considerations.
-      # @return [Array<GOBL::CBC::KeyDefinition>]
-      property :tags, [GOBL::CBC::KeyDefinition]
+      # @return [Array<TagSet>]
+      property :tags, [TagSet]
 
       # @!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.
@@ -87,13 +97,13 @@ module GOBL
 
       # @!attribute [r] corrections
       # Configuration details for corrections to be used with correction options.
-      # @return [Array<CorrectionDefinition>]
-      property :corrections, [CorrectionDefinition]
+      # @return [CorrectionSet]
+      property :corrections, CorrectionSet
 
       # @!attribute [r] categories
       # List of tax categories.
-      # @return [Array<Category>]
-      property :categories, [Category]
+      # @return [Array<CategoryDef>]
+      property :categories, [CategoryDef]
       validates_presence_of :categories
     end
   end

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

@@ -10,7 +10,12 @@ module GOBL
     # Scenario is used to describe a tax scenario of a document based on the combination of document type and tag used.
     class Scenario < GOBL::Object
       # The Schema ID of the GOBL Scenario structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/Scenario'
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime-def#/$defs/Scenario'
+
+      # @!attribute [r] name
+      # Name of the scenario for further information.
+      # @return [GOBL::I18n::String]
+      property :name, GOBL::I18n::String
 
       # @!attribute [r] type
       # Type of document, if present.
@@ -18,14 +23,19 @@ module GOBL
       property :type, [GOBL::CBC::Key]
 
       # @!attribute [r] tags
-      # Tag that was applied to the document
+      # Array of tags that have been applied to the document.
       # @return [Array<GOBL::CBC::Key>]
       property :tags, [GOBL::CBC::Key]
 
-      # @!attribute [r] name
-      # Name of the scenario for further information.
-      # @return [GOBL::I18n::String]
-      property :name, GOBL::I18n::String
+      # @!attribute [r] ext_key
+      # Extension key that must be present in the document.
+      # @return [GOBL::CBC::Key]
+      property :ext_key, GOBL::CBC::Key
+
+      # @!attribute [r] ext_value
+      # Extension value that along side the key must be present for a match to happen. This cannot be used without an `ExtKey`. The value will be copied to the note code if needed.
+      # @return [String]
+      property :ext_value, String
 
       # @!attribute [r] note
       # A note to be added to the document if the scenario is applied.
@@ -37,10 +47,10 @@ module GOBL
       # @return [GOBL::CBC::CodeMap]
       property :codes, GOBL::CBC::CodeMap
 
-      # @!attribute [r] meta
-      # Any additional local meta data that may be useful in integrations.
-      # @return [GOBL::CBC::Meta]
-      property :meta, GOBL::CBC::Meta
+      # @!attribute [r] ext
+      # Ext represents a set of tax extensions that should be applied to the document in the appropriate "tax" context.
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
     end
   end
 end

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

@@ -10,7 +10,7 @@ module GOBL
     # ScenarioSet is a collection of tax scenarios for a given schema that can be used to determine special codes or notes that need to be included in the final document.
     class ScenarioSet < GOBL::Object
       # The Schema ID of the GOBL ScenarioSet structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/ScenarioSet'
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime-def#/$defs/ScenarioSet'
 
       # @!attribute [r] schema
       # Partial or complete schema URL for the document type

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

@@ -10,7 +10,7 @@ module GOBL
     # Source describes where the information for the taxes comes from.
     class Source < GOBL::Object
       # The Schema ID of the GOBL Source structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/Source'
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime-def#/$defs/Source'
 
       # @!attribute [r] title
       # Title of the linked source to help distinguish between this and other links.

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Tax
+    # TagSet defines a set of tags and their descriptions that can be used for a specific schema in the context of a Regime or Addon.
+    class TagSet < GOBL::Object
+      # The Schema ID of the GOBL TagSet structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime-def#/$defs/TagSet'
+
+      # @!attribute [r] schema
+      # Schema that the tags are associated with.
+      # @return [String]
+      property :schema, String
+      validates_presence_of :schema
+
+      # @!attribute [r] list
+      # List of tags for the schema
+      # @return [Array<GOBL::CBC::KeyDefinition>]
+      property :list, [GOBL::CBC::KeyDefinition]
+      validates_presence_of :list
+    end
+  end
+end

data/lib/gobl/extensions/bill/invoice_helper.rb

@@ -5,15 +5,14 @@ module GOBL
     module Bill
       # Additional methods for the generated {GOBL::Bill::Invoice} class
       module InvoiceHelper
-        # Returns the applicable regime based on the supplier’s tax ID
-        def regime
-          regime_country && GOBL::Tax::Regime.fetch(regime_country)
+        def self.included(klass)
+          klass.alias_method :tags, '$tags'
+          klass.alias_method :tags=, '$tags='
         end
 
-        # Returns the invoice’s scenario summary which aggregates the data of
-        # the matching regime’s scenarios
-        def scenario_summary
-          ScenarioSummary.new(matching_scenarios)
+        # Returns the applicable regime based on the supplier’s tax ID
+        def regime
+          regime_country && GOBL::Tax::RegimeDef.fetch(regime_country)
         end
 
         private
@@ -21,35 +20,6 @@ module GOBL
         def regime_country
           supplier&.tax_id&.country
         end
-
-        def matching_scenarios
-          return [] unless scenario_set
-
-          scenario_set.list.select do |scenario|
-            matches_scenario?(scenario)
-          end
-        end
-
-        def matches_scenario?(scenario)
-          matches_scenario_tags?(scenario) && matches_scenario_type?(scenario)
-        end
-
-        def matches_scenario_type?(scenario)
-          scenario.type.blank? || scenario.type.include?(type)
-        end
-
-        def matches_scenario_tags?(scenario)
-          scenario_tags = scenario.tags || []
-          tax_tags = tax&.tags || []
-
-          (scenario_tags - tax_tags).empty?
-        end
-
-        def scenario_set
-          regime&.scenarios&.find do |scenario_set|
-            self.class::SCHEMA_ID.include?(scenario_set.schema)
-          end
-        end
       end
     end
   end

data/lib/gobl/extensions/envelope_helper.rb

@@ -17,6 +17,10 @@ module GOBL
       def extract
         doc.extract
       end
+
+      def signed?
+        sigs.present?
+      end
     end
   end
 end

data/lib/gobl/version.rb

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

data/lib/gobl.rb

@@ -18,7 +18,8 @@ loader.inflector.inflect(
   'tax_id' => 'TaxID',
   'dsig' => 'DSig',
   'id' => 'ID',
-  'cbc' => 'CBC'
+  'cbc' => 'CBC',
+  'iso_country_code' => 'ISOCountryCode'
 )
 loader.ignore("#{__dir__}/ext")
 loader.setup
@@ -49,5 +50,5 @@ GOBL::I18n::String.include GOBL::Extensions::I18n::ValueKeysHelper
 GOBL::Schema::Object.include GOBL::Extensions::Schema::ObjectHelper
 GOBL::Schema::Object.extend GOBL::Extensions::Schema::ObjectHelper::ClassMethods
 GOBL::Envelope.include GOBL::Extensions::EnvelopeHelper
-GOBL::Tax::Regime.extend GOBL::Extensions::Tax::RegimeHelper::ClassMethods
+GOBL::Tax::RegimeDef.extend GOBL::Extensions::Tax::RegimeHelper::ClassMethods
 GOBL::Bill::Invoice.include GOBL::Extensions::Bill::InvoiceHelper