gobl 0.17.0 → 0.19.0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.67.0
+##
+
+module GOBL
+  module Regimes
+    module Mx
+      # FoodVouchers carries the data to produce a CFDI's "Complemento de Vales de Despensa" (version 1.0) providing detailed information about food vouchers issued by an e-wallet supplier to its customer's employees.
+      class FoodVouchers < GOBL::Object
+        # The Schema ID of the GOBL FoodVouchers structure
+        SCHEMA_ID = 'https://gobl.org/draft-0/regimes/mx/food-vouchers'
+
+        # @!attribute [r] employer_registration
+        # Customer's employer registration number (maps to `registroPatronal`).
+        # @return [String]
+        property :employer_registration, String
+
+        # @!attribute [r] account_number
+        # Customer's account number (maps to `numeroDeCuenta`).
+        # @return [String]
+        property :account_number, String
+        validates_presence_of :account_number
+
+        # @!attribute [r] total
+        # Sum of all line amounts (calculated, maps to `total`).
+        # @return [GOBL::Num::Amount]
+        property :total, GOBL::Num::Amount
+
+        # @!attribute [r] lines
+        # List of food vouchers issued to the customer's employees (maps to `Conceptos`).
+        # @return [Array<FoodVouchersLine>]
+        property :lines, [FoodVouchersLine]
+        validates_presence_of :lines
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.67.0
+##
+
+module GOBL
+  module Regimes
+    module Mx
+      # FoodVouchersEmployee represents an employee that received a food voucher.
+      class FoodVouchersEmployee < GOBL::Object
+        # The Schema ID of the GOBL FoodVouchersEmployee structure
+        SCHEMA_ID = 'https://gobl.org/draft-0/regimes/mx/food-vouchers#/$defs/FoodVouchersEmployee'
+
+        # @!attribute [r] tax_code
+        # Employee's tax identity code (maps to `rfc`).
+        # @return [GOBL::CBC::Code]
+        property :tax_code, GOBL::CBC::Code
+        validates_presence_of :tax_code
+
+        # @!attribute [r] curp
+        # Employee's CURP ("Clave Única de Registro de Población", maps to `curp`).
+        # @return [GOBL::CBC::Code]
+        property :curp, GOBL::CBC::Code
+        validates_presence_of :curp
+
+        # @!attribute [r] name
+        # Employee's name (maps to `nombre`).
+        # @return [String]
+        property :name, String
+        validates_presence_of :name
+
+        # @!attribute [r] social_security
+        # Employee's Social Security Number (maps to `numSeguridadSocial`).
+        # @return [GOBL::CBC::Code]
+        property :social_security, GOBL::CBC::Code
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.67.0
+##
+
+module GOBL
+  module Regimes
+    module Mx
+      # FoodVouchersLine represents a single food voucher issued to the e-wallet of one of the customer's employees.
+      class FoodVouchersLine < GOBL::Object
+        # The Schema ID of the GOBL FoodVouchersLine structure
+        SCHEMA_ID = 'https://gobl.org/draft-0/regimes/mx/food-vouchers#/$defs/FoodVouchersLine'
+
+        # @!attribute [r] e_wallet_id
+        # Identifier of the e-wallet that received the food voucher (maps to `Identificador`).
+        # @return [GOBL::CBC::Code]
+        property :e_wallet_id, GOBL::CBC::Code
+        validates_presence_of :e_wallet_id
+
+        # @!attribute [r] issue_date_time
+        # Date and time of the food voucher's issue (maps to `Fecha`).
+        # @return [GOBL::Cal::DateTime]
+        property :issue_date_time, GOBL::Cal::DateTime
+        validates_presence_of :issue_date_time
+
+        # @!attribute [r] employee
+        # Employee that received the food voucher.
+        # @return [FoodVouchersEmployee]
+        property :employee, FoodVouchersEmployee
+
+        # @!attribute [r] amount
+        # Amount of the food voucher (maps to `importe`).
+        # @return [GOBL::Num::Amount]
+        property :amount, GOBL::Num::Amount
+        validates_presence_of :amount
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.67.0
+##
+
+module GOBL
+  module Regimes
+    module Mx
+      # FuelAccountBalance carries the data to produce a CFDI's "Complemento de Estado de Cuenta de Combustibles para Monederos Electrónicos" (version 1.2 revision B) providing detailed information about fuel purchases made with electronic wallets.
+      class FuelAccountBalance < GOBL::Object
+        # The Schema ID of the GOBL FuelAccountBalance structure
+        SCHEMA_ID = 'https://gobl.org/draft-0/regimes/mx/fuel-account-balance'
+
+        # @!attribute [r] account_number
+        # Customer's account number (maps to `NumeroDeCuenta`).
+        # @return [String]
+        property :account_number, String
+        validates_presence_of :account_number
+
+        # @!attribute [r] subtotal
+        # Sum of all line totals (i.e. taxes not included) (calculated, maps to `SubTotal`).
+        # @return [GOBL::Num::Amount]
+        property :subtotal, GOBL::Num::Amount
+
+        # @!attribute [r] total
+        # Grand total after taxes have been applied (calculated, maps to `Total`).
+        # @return [GOBL::Num::Amount]
+        property :total, GOBL::Num::Amount
+
+        # @!attribute [r] lines
+        # List of fuel purchases made with the customer's e-wallets (maps to `Conceptos`).
+        # @return [Array<FuelAccountLine>]
+        property :lines, [FuelAccountLine]
+        validates_presence_of :lines
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.67.0
+##
+
+module GOBL
+  module Regimes
+    module Mx
+      # FuelAccountItem provides the details of a fuel purchase.
+      class FuelAccountItem < GOBL::Object
+        # The Schema ID of the GOBL FuelAccountItem structure
+        SCHEMA_ID = 'https://gobl.org/draft-0/regimes/mx/fuel-account-balance#/$defs/FuelAccountItem'
+
+        # @!attribute [r] type
+        # Type of fuel (one of `c_ClaveTipoCombustible` codes, maps to `TipoCombustible`).
+        # @return [GOBL::CBC::Code]
+        property :type, GOBL::CBC::Code
+        validates_presence_of :type
+
+        # @!attribute [r] unit
+        # Reference unit of measure used in the price and the quantity (maps to `Unidad`).
+        # @return [GOBL::Org::Unit]
+        property :unit, GOBL::Org::Unit
+
+        # @!attribute [r] name
+        # Name of the fuel (maps to `NombreCombustible`).
+        # @return [String]
+        property :name, String
+        validates_presence_of :name
+
+        # @!attribute [r] price
+        # Base price of a single unit of the fuel without taxes (maps to `ValorUnitario`).
+        # @return [GOBL::Num::Amount]
+        property :price, GOBL::Num::Amount
+        validates_presence_of :price
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.67.0
+##
+
+module GOBL
+  module Regimes
+    module Mx
+      # FuelAccountLine represents a single fuel purchase made with an e-wallet issued by the invoice's supplier.
+      class FuelAccountLine < GOBL::Object
+        # The Schema ID of the GOBL FuelAccountLine structure
+        SCHEMA_ID = 'https://gobl.org/draft-0/regimes/mx/fuel-account-balance#/$defs/FuelAccountLine'
+
+        # @!attribute [r] e_wallet_id
+        # Identifier of the e-wallet used to make the purchase (maps to `Identificador`).
+        # @return [GOBL::CBC::Code]
+        property :e_wallet_id, GOBL::CBC::Code
+        validates_presence_of :e_wallet_id
+
+        # @!attribute [r] purchase_date_time
+        # Date and time of the purchase (maps to `Fecha`).
+        # @return [GOBL::Cal::DateTime]
+        property :purchase_date_time, GOBL::Cal::DateTime
+        validates_presence_of :purchase_date_time
+
+        # @!attribute [r] vendor_tax_code
+        # Tax Identity Code of the fuel's vendor (maps to `Rfc`)
+        # @return [GOBL::CBC::Code]
+        property :vendor_tax_code, GOBL::CBC::Code
+        validates_presence_of :vendor_tax_code
+
+        # @!attribute [r] service_station_code
+        # Code of the service station where the purchase was made (maps to `ClaveEstacion`).
+        # @return [GOBL::CBC::Code]
+        property :service_station_code, GOBL::CBC::Code
+        validates_presence_of :service_station_code
+
+        # @!attribute [r] quantity
+        # Amount of fuel units purchased (maps to `Cantidad`)
+        # @return [GOBL::Num::Amount]
+        property :quantity, GOBL::Num::Amount
+        validates_presence_of :quantity
+
+        # @!attribute [r] item
+        # Details of the fuel purchased.
+        # @return [FuelAccountItem]
+        property :item, FuelAccountItem
+        validates_presence_of :item
+
+        # @!attribute [r] purchase_code
+        # Identifier of the purchase (maps to `FolioOperacion`).
+        # @return [GOBL::CBC::Code]
+        property :purchase_code, GOBL::CBC::Code
+        validates_presence_of :purchase_code
+
+        # @!attribute [r] total
+        # 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`).
+        # @return [Array<FuelAccountTax>]
+        property :taxes, [FuelAccountTax]
+        validates_presence_of :taxes
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.67.0
+##
+
+module GOBL
+  module Regimes
+    module Mx
+      # FuelAccountTax represents a single tax applied to a fuel purchase.
+      class FuelAccountTax < GOBL::Object
+        # 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`)
+        # @return [GOBL::CBC::Code]
+        property :code, GOBL::CBC::Code
+        validates_presence_of :code
+
+        # @!attribute [r] rate
+        # Rate applicable to either the line total (tasa) or 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`).
+        # @return [GOBL::Num::Amount]
+        property :amount, GOBL::Num::Amount
+        validates_presence_of :amount
+      end
+    end
+  end
+end

data/lib/generated/gobl/schema/object.rb

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

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

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.55.0
+## Generated with GOBL v0.67.0
 ##
 
 module GOBL
@@ -14,16 +14,24 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/Category'
 
       # @!attribute [r] code
+      # Code to be used in documents
       # @return [GOBL::CBC::Code]
       property :code, GOBL::CBC::Code
       validates_presence_of :code
 
       # @!attribute [r] name
+      # Short name of the category to be used instead of code in output
       # @return [GOBL::I18n::String]
       property :name, GOBL::I18n::String
       validates_presence_of :name
 
+      # @!attribute [r] title
+      # Human name for the code to use for titles
+      # @return [GOBL::I18n::String]
+      property :title, GOBL::I18n::String
+
       # @!attribute [r] desc
+      # Useful description of the category.
       # @return [GOBL::I18n::String]
       property :desc, GOBL::I18n::String
 
@@ -33,7 +41,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 rates must be defined.
+      # 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
 
@@ -43,7 +51,7 @@ module GOBL
       property :rates, [Rate]
 
       # @!attribute [r] extensions
-      # Extensions defines a list of keys for codes to use as an alternative to choosing a rate for the tax category. Every key must be defined in the Regime's extensions table.
+      # 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.
       # @return [Array<GOBL::CBC::Key>]
       property :extensions, [GOBL::CBC::Key]
 

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

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

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

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

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

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.55.0
+## Generated with GOBL v0.67.0
 ##
 
 module GOBL
@@ -36,8 +36,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::CBC::CodeMap]
-      property :ext, GOBL::CBC::CodeMap
+      # @return [GOBL::Tax::ExtMap]
+      property :ext, GOBL::Tax::ExtMap
     end
   end
 end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.67.0
+##
+
+module GOBL
+  module Tax
+    # 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'
+
+      # @!attribute [r] schema
+      # Partial or complete schema URL for the document type supported by correction.
+      # @return [String]
+      property :schema, String
+      validates_presence_of :schema
+
+      # @!attribute [r] types
+      # The types of sub-documents supported by the regime
+      # @return [Array<GOBL::CBC::Key>]
+      property :types, [GOBL::CBC::Key]
+
+      # @!attribute [r] extensions
+      # Extension keys that can be included
+      # @return [Array<GOBL::CBC::Key>]
+      property :extensions, [GOBL::CBC::Key]
+
+      # @!attribute [r] reason_required
+      # ReasonRequired when true implies that a reason must be provided
+      # @return [Boolean]
+      property :reason_required, Boolean
+
+      # @!attribute [r] stamps
+      # Stamps that must be copied from the preceding document.
+      # @return [Array<GOBL::CBC::Key>]
+      property :stamps, [GOBL::CBC::Key]
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+##
+## 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
+    end
+  end
+end

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

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

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

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.55.0
+## Generated with GOBL v0.67.0
 ##
 
 module GOBL
@@ -20,9 +20,10 @@ module GOBL
       validates_presence_of :key
 
       # @!attribute [r] name
-      # Short name for the key, if relevant.
+      # Short name for the key.
       # @return [GOBL::I18n::String]
       property :name, GOBL::I18n::String
+      validates_presence_of :name
 
       # @!attribute [r] desc
       # Description offering more details about when the key should be used.
@@ -34,6 +35,11 @@ module GOBL
       # @return [Array<CodeDefinition>]
       property :codes, [CodeDefinition]
 
+      # @!attribute [r] keys
+      # Keys is used instead of codes to define a further sub-set of keys that can be used alongside this one.
+      # @return [Array<KeyDefinition>]
+      property :keys, [KeyDefinition]
+
       # @!attribute [r] map
       # Map helps map local keys to specific codes, useful for converting the described key into a local code.
       # @return [GOBL::CBC::CodeMap]

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

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

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

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

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

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

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

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