gobl 0.20.0 → 0.21.0

data/lib/generated/gobl/org/item.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/item'
 
       # @!attribute [r] uuid
-      # Unique identity of this item
-      # @return [GOBL::UUID::UUID]
-      property :uuid, GOBL::UUID::UUID
+      # Universally Unique Identifier.
+      # @return [String]
+      property :uuid, String
 
       # @!attribute [r] ref
       # Primary reference code that identifies this item. Additional codes can be provided in the 'identities' property.
@@ -55,6 +54,11 @@ module GOBL
       property :price, GOBL::Num::Amount
       validates_presence_of :price
 
+      # @!attribute [r] alt_prices
+      # AltPrices defines a list of prices with their currencies that may be used as an alternative to the item's base price.
+      # @return [Array<GOBL::Currency::Amount>]
+      property :alt_prices, [GOBL::Currency::Amount]
+
       # @!attribute [r] unit
       # Unit of measure.
       # @return [GOBL::Org::Unit]

data/lib/generated/gobl/org/name.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/name'
 
       # @!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] alias
       # What the person would like to be called

data/lib/generated/gobl/org/party.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/party'
 
       # @!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] name
       # Legal name or representation of the organization.
@@ -29,6 +28,11 @@ module GOBL
       # @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

@@ -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/person'
 
       # @!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] name
       # Complete details on the name of the person

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,9 @@ 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] capital
       # @return [GOBL::Num::Amount]
@@ -52,6 +52,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.

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

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/category.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.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.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
@@ -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
 

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

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
       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

@@ -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/rate_total.rb

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -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.69.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.69.0
 ##
 
 module GOBL
@@ -18,6 +17,11 @@ module GOBL
       # @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.
       # @return [GOBL::Cal::Date]

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

@@ -3,7 +3,6 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.69.0
 ##
 
 module GOBL
@@ -52,25 +51,30 @@ module GOBL
       # @return [Array<GOBL::CBC::KeyDefinition>]
       property :tags, [GOBL::CBC::KeyDefinition]
 
-      # @!attribute [r] identity_types
-      # Identity types specific for the regime and may be validated against.
-      # @return [Array<GOBL::CBC::KeyDefinition>]
-      property :identity_types, [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<GOBL::CBC::KeyDefinition>]
       property :extensions, [GOBL::CBC::KeyDefinition]
 
-      # @!attribute [r] charge_types
-      # Charge types specific for the regime and may be validated or used in the UI as suggestions
+      # @!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]
+
+      # @!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_types, [GOBL::CBC::KeyDefinition]
+      property :charge_keys, [GOBL::CBC::KeyDefinition]
 
-      # @!attribute [r] payment_means
+      # @!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, [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.

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

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