gobl 0.22.0 → 0.24.0

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

@@ -23,18 +23,23 @@ module GOBL
       # @return [GOBL::L10n::TaxCountryCode]
       property :country, GOBL::L10n::TaxCountryCode
 
+      # @!attribute [r] key
+      # Key helps determine the tax situation within the category.
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
+
       # @!attribute [r] rate
-      # Rate within a category to apply.
+      # Rate within a category and for a given key 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). A nil percent implies that this tax combo is **exempt** from tax.
+      # Percent defines the percentage set manually or determined from the key. A nil percent implies that this tax combo is either exempt or not-subject.
       # @return [GOBL::Num::Percentage]
       property :percent, GOBL::Num::Percentage
 
       # @!attribute [r] surcharge
-      # Some countries require an additional surcharge (calculated if rate present).
+      # Some countries require an additional surcharge (may be determined if key present).
       # @return [GOBL::Num::Percentage]
       property :surcharge, GOBL::Num::Percentage
 

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

@@ -37,6 +37,11 @@ module GOBL
       # Stamps that must be copied from the preceding document.
       # @return [Array<GOBL::CBC::Key>]
       property :stamps, [GOBL::CBC::Key]
+
+      # @!attribute [r] copy_tax
+      # Copy tax from the preceding document to the document ref.
+      # @return [Boolean]
+      property :copy_tax, Boolean
     end
   end
 end

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

@@ -23,6 +23,11 @@ module GOBL
       # @return [GOBL::CBC::Code]
       property :code, GOBL::CBC::Code
 
+      # @!attribute [r] scheme
+      # Scheme is an optional field that may be used to override the tax regime's default tax scheme. Many electronic formats such as UBL or CII define an equivalent field. Examples: `VAT`, `GST`, `ST`, etc.
+      # @return [GOBL::CBC::Code]
+      property :scheme, GOBL::CBC::Code
+
       # @!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]

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Tax
+    # KeyDef defines a key that can be used inside a tax category.
+    class KeyDef < GOBL::Object
+      # The Schema ID of the GOBL KeyDef structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime-def#/$defs/KeyDef'
+
+      # @!attribute [r] key
+      # Key identifies this rate within the system
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
+
+      # @!attribute [r] name
+      # Human name of the rate set
+      # @return [GOBL::I18n::String]
+      property :name, GOBL::I18n::String
+
+      # @!attribute [r] desc
+      # Useful description of the rate.
+      # @return [GOBL::I18n::String]
+      property :desc, GOBL::I18n::String
+
+      # @!attribute [r] no_percent
+      # NoPercent when true implies that the rate when used in a tax Combo should not define a percent value.
+      # @return [Boolean]
+      property :no_percent, Boolean
+    end
+  end
+end

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

@@ -12,11 +12,16 @@ module GOBL
       # 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
+      # @!attribute [r] rate
+      # Rate defines the key for which this rate applies.
       # @return [GOBL::CBC::Key]
-      property :key, GOBL::CBC::Key
-      validates_presence_of :key
+      property :rate, GOBL::CBC::Key
+      validates_presence_of :rate
+
+      # @!attribute [r] keys
+      # Keys identifies the set of tax keys defined in the category that this rate can be used with.
+      # @return [Array<GOBL::CBC::Key>]
+      property :keys, [GOBL::CBC::Key]
 
       # @!attribute [r] name
       # Human name of the rate
@@ -29,21 +34,11 @@ module GOBL
       # @return [GOBL::I18n::String]
       property :desc, GOBL::I18n::String
 
-      # @!attribute [r] exempt
-      # Exempt when true implies that the rate when used in a tax Combo should not define a percent value.
-      # @return [Boolean]
-      property :exempt, Boolean
-
       # @!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<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.
       # @return [GOBL::CBC::Meta]

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

@@ -12,16 +12,16 @@ module GOBL
       # The Schema ID of the GOBL RateTotal structure
       SCHEMA_ID = 'https://gobl.org/draft-0/tax/total#/$defs/RateTotal'
 
-      # @!attribute [r] key
-      # Optional rate key is required when grouping.
-      # @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] key
+      # Tax key if supported by the category.
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
+
       # @!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_def.rb

@@ -12,13 +12,8 @@ module GOBL
       # 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.
-      # @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.
+      # Only apply this rate if one of the tags is present in the invoice. Tags []cbc.Key `json:"tags,omitempty" jsonschema:"title=Tags"` 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
 

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

@@ -51,10 +51,15 @@ module GOBL
       property :currency, GOBL::Currency::Code
       validates_presence_of :currency
 
+      # @!attribute [r] tax_scheme
+      # TaxScheme defines the principal scheme of consumption tax that should be applied to the regime and associated with Tax IDs in some export formats such as UBL or CII. Some regimes may not have a Tax Scheme and as a consequence will not use tax identities, like the US.
+      # @return [GOBL::CBC::Code]
+      property :tax_scheme, GOBL::CBC::Code
+
       # @!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
+      # @return [GOBL::CBC::Key]
+      property :calculator_rounding_rule, GOBL::CBC::Key
 
       # @!attribute [r] tags
       # Tags that can be applied at the document level to identify additional considerations.
@@ -63,33 +68,23 @@ module GOBL
 
       # @!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<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] 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]
+      # @return [Array<GOBL::CBC::Definition>]
+      property :extensions, [GOBL::CBC::Definition]
 
-      # @!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] identities
+      # Identities used in addition to regular tax identities and specific for the regime that may be validated against.
+      # @return [Array<GOBL::CBC::Definition>]
+      property :identities, [GOBL::CBC::Definition]
 
       # @!attribute [r] payment_means_keys
       # PaymentMeansKeys specific for the regime that extend the original base payment means keys.
-      # @return [Array<GOBL::CBC::KeyDefinition>]
-      property :payment_means_keys, [GOBL::CBC::KeyDefinition]
+      # @return [Array<GOBL::CBC::Definition>]
+      property :payment_means_keys, [GOBL::CBC::Definition]
 
       # @!attribute [r] inbox_keys
       # InboxKeys specific to the regime that can be used to identify where a document should be forwarded to.
-      # @return [Array<GOBL::CBC::KeyDefinition>]
-      property :inbox_keys, [GOBL::CBC::KeyDefinition]
+      # @return [Array<GOBL::CBC::Definition>]
+      property :inbox_keys, [GOBL::CBC::Definition]
 
       # @!attribute [r] scenarios
       # @return [Array<ScenarioSet>]

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

@@ -17,6 +17,11 @@ module GOBL
       # @return [GOBL::I18n::String]
       property :name, GOBL::I18n::String
 
+      # @!attribute [r] desc
+      # Description of the scenario for documentation purposes.
+      # @return [GOBL::I18n::String]
+      property :desc, GOBL::I18n::String
+
       # @!attribute [r] type
       # Type of document, if present.
       # @return [Array<GOBL::CBC::Key>]
@@ -32,15 +37,15 @@ module GOBL
       # @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] ext_code
+      # Extension code that along side the key must be present for a match to happen. This cannot be used without an `cbc.Code`. The value will be copied to the note code if needed.
+      # @return [GOBL::CBC::Code]
+      property :ext_code, GOBL::CBC::Code
 
       # @!attribute [r] note
       # A note to be added to the document if the scenario is applied.
-      # @return [GOBL::CBC::Note]
-      property :note, GOBL::CBC::Note
+      # @return [ScenarioNote]
+      property :note, ScenarioNote
 
       # @!attribute [r] codes
       # Codes is used to define additional codes for regime specific situations.

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+##
+
+module GOBL
+  module Tax
+    # ScenarioNote represents the structure of the note that needs to be added to the document.
+    class ScenarioNote < GOBL::Object
+      # The Schema ID of the GOBL ScenarioNote structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime-def#/$defs/ScenarioNote'
+
+      # @!attribute [r] key
+      # Key specifying subject of the text
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
+
+      # @!attribute [r] code
+      # Code used for additional data that may be required to identify the note.
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
+
+      # @!attribute [r] src
+      # Source of this note, especially useful when auto-generated.
+      # @return [GOBL::CBC::Key]
+      property :src, GOBL::CBC::Key
+
+      # @!attribute [r] text
+      # The contents of the note
+      # @return [String]
+      property :text, String
+      validates_presence_of :text
+
+      # @!attribute [r] ext
+      # Extension data
+      # @return [GOBL::Tax::Extensions]
+      property :ext, GOBL::Tax::Extensions
+    end
+  end
+end

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

@@ -20,8 +20,8 @@ module GOBL
 
       # @!attribute [r] list
       # List of tags for the schema
-      # @return [Array<GOBL::CBC::KeyDefinition>]
-      property :list, [GOBL::CBC::KeyDefinition]
+      # @return [Array<GOBL::CBC::Definition>]
+      property :list, [GOBL::CBC::Definition]
       validates_presence_of :list
     end
   end

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

@@ -18,10 +18,15 @@ module GOBL
       property :categories, [CategoryTotal]
 
       # @!attribute [r] sum
-      # Total value of all the taxes applied.
+      # Total value of all non-retained or indirect taxes.
       # @return [GOBL::Num::Amount]
       property :sum, GOBL::Num::Amount
       validates_presence_of :sum
+
+      # @!attribute [r] retained
+      # Sum of retained or withheld tax amounts
+      # @return [GOBL::Num::Amount]
+      property :retained, GOBL::Num::Amount
     end
   end
 end

data/lib/gobl/version.rb

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

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: gobl
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Luismi Cavalle
 - Sam Lown
 - David Lilue
 - Juanjo Molinero
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-26 00:00:00.000000000 Z
+date: 2025-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -55,15 +55,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- data/regimes/ae.json
 - data/regimes/at.json
 - data/regimes/be.json
+- data/regimes/br.json
 - data/regimes/ca.json
 - data/regimes/ch.json
 - data/regimes/co.json
@@ -73,6 +75,7 @@ files:
 - data/regimes/fr.json
 - data/regimes/gb.json
 - data/regimes/gr.json
+- data/regimes/in.json
 - data/regimes/it.json
 - data/regimes/mx.json
 - data/regimes/nl.json
@@ -82,26 +85,31 @@ files:
 - lib/generated/gobl/bill/charge.rb
 - lib/generated/gobl/bill/correction_options.rb
 - lib/generated/gobl/bill/delivery.rb
+- lib/generated/gobl/bill/delivery_details.rb
 - lib/generated/gobl/bill/discount.rb
 - lib/generated/gobl/bill/invoice.rb
 - lib/generated/gobl/bill/line.rb
 - lib/generated/gobl/bill/line_charge.rb
 - lib/generated/gobl/bill/line_discount.rb
+- lib/generated/gobl/bill/order.rb
 - lib/generated/gobl/bill/ordering.rb
-- lib/generated/gobl/bill/outlay.rb
 - lib/generated/gobl/bill/payment.rb
+- lib/generated/gobl/bill/payment_details.rb
+- lib/generated/gobl/bill/payment_line.rb
+- lib/generated/gobl/bill/sub_line.rb
 - lib/generated/gobl/bill/tax.rb
 - lib/generated/gobl/bill/totals.rb
+- lib/generated/gobl/bill/tracking.rb
 - lib/generated/gobl/cal/date.rb
 - lib/generated/gobl/cal/date_time.rb
 - lib/generated/gobl/cal/period.rb
+- lib/generated/gobl/cal/time.rb
 - lib/generated/gobl/cbc/code.rb
 - lib/generated/gobl/cbc/code_map.rb
+- lib/generated/gobl/cbc/definition.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/cbc/value_definition.rb
+- lib/generated/gobl/cbc/source.rb
 - lib/generated/gobl/currency/amount.rb
 - lib/generated/gobl/currency/code.rb
 - lib/generated/gobl/currency/exchange_rate.rb
@@ -117,6 +125,7 @@ files:
 - lib/generated/gobl/l10n/tax_country_code.rb
 - lib/generated/gobl/note/message.rb
 - lib/generated/gobl/org/address.rb
+- lib/generated/gobl/org/attachment.rb
 - lib/generated/gobl/org/coordinates.rb
 - lib/generated/gobl/org/document_ref.rb
 - lib/generated/gobl/org/email.rb
@@ -125,6 +134,7 @@ files:
 - lib/generated/gobl/org/inbox.rb
 - lib/generated/gobl/org/item.rb
 - lib/generated/gobl/org/name.rb
+- lib/generated/gobl/org/note.rb
 - lib/generated/gobl/org/party.rb
 - lib/generated/gobl/org/person.rb
 - lib/generated/gobl/org/registration.rb
@@ -148,6 +158,7 @@ files:
 - lib/generated/gobl/regimes/mx/fuel_account_tax.rb
 - lib/generated/gobl/schema/object.rb
 - lib/generated/gobl/tax/addon_def.rb
+- lib/generated/gobl/tax/catalogue_def.rb
 - lib/generated/gobl/tax/category_def.rb
 - lib/generated/gobl/tax/category_total.rb
 - lib/generated/gobl/tax/combo.rb
@@ -155,15 +166,16 @@ files:
 - lib/generated/gobl/tax/correction_set.rb
 - lib/generated/gobl/tax/extensions.rb
 - lib/generated/gobl/tax/identity.rb
+- lib/generated/gobl/tax/key_def.rb
 - lib/generated/gobl/tax/rate_def.rb
 - lib/generated/gobl/tax/rate_total.rb
 - lib/generated/gobl/tax/rate_total_surcharge.rb
 - lib/generated/gobl/tax/rate_value_def.rb
 - lib/generated/gobl/tax/regime_def.rb
 - lib/generated/gobl/tax/scenario.rb
+- lib/generated/gobl/tax/scenario_note.rb
 - lib/generated/gobl/tax/scenario_set.rb
 - lib/generated/gobl/tax/set.rb
-- lib/generated/gobl/tax/source.rb
 - lib/generated/gobl/tax/tag_set.rb
 - lib/generated/gobl/tax/total.rb
 - lib/gobl.rb
@@ -189,7 +201,7 @@ licenses:
 - Apache-2.0
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -204,8 +216,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.1.4
 requirements: []
-rubygems_version: 3.4.20
-signing_key: 
+rubygems_version: 3.4.5
+signing_key:
 specification_version: 4
 summary: Minimalist ruby version of the GOBL library
 test_files: []

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

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-##
-## DO NOT EDIT - This file was generated automatically.
-##
-##
-
-module GOBL
-  module Bill
-    # Outlay represents a reimbursable expense that was paid for by the supplier and invoiced separately by the third party directly to the customer.
-    class Outlay < GOBL::Object
-      # The Schema ID of the GOBL Outlay structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Outlay'
-
-      # @!attribute [r] uuid
-      # Universally Unique Identifier.
-      # @return [String]
-      property :uuid, String
-
-      # @!attribute [r] i
-      # Outlay number index inside the invoice for ordering (calculated).
-      # @return [Integer]
-      property :i, Integer
-
-      # @!attribute [r] date
-      # When was the outlay made.
-      # @return [GOBL::Cal::Date]
-      property :date, GOBL::Cal::Date
-
-      # @!attribute [r] code
-      # Invoice number or other reference detail used to identify the outlay.
-      # @return [String]
-      property :code, String
-
-      # @!attribute [r] series
-      # Series of the outlay invoice.
-      # @return [String]
-      property :series, String
-
-      # @!attribute [r] description
-      # Details on what the outlay was.
-      # @return [String]
-      property :description, String
-      validates_presence_of :description
-
-      # @!attribute [r] supplier
-      # Who was the supplier of the outlay
-      # @return [GOBL::Org::Party]
-      property :supplier, GOBL::Org::Party
-
-      # @!attribute [r] amount
-      # Amount paid by the supplier.
-      # @return [GOBL::Num::Amount]
-      property :amount, GOBL::Num::Amount
-      validates_presence_of :amount
-    end
-  end
-end

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

@@ -1,37 +0,0 @@
-# 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/tax/source.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-##
-## DO NOT EDIT - This file was generated automatically.
-##
-##
-
-module GOBL
-  module Tax
-    # 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-def#/$defs/Source'
-
-      # @!attribute [r] title
-      # Title of the linked source to help distinguish between this and other links.
-      # @return [GOBL::I18n::String]
-      property :title, GOBL::I18n::String
-
-      # @!attribute [r] url
-      # URL for the website.
-      # @return [String]
-      property :url, String
-      validates_presence_of :url
-    end
-  end
-end