gobl 0.24.1 → 0.24.3

data/data/schemas/tax/total.json

@@ -0,0 +1,135 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/tax/total",
+  "$ref": "#/$defs/Total",
+  "$defs": {
+    "CategoryTotal": {
+      "properties": {
+        "code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Code"
+        },
+        "retained": {
+          "type": "boolean",
+          "title": "Retained"
+        },
+        "informative": {
+          "type": "boolean",
+          "title": "Informative"
+        },
+        "rates": {
+          "items": {
+            "$ref": "#/$defs/RateTotal"
+          },
+          "type": "array",
+          "title": "Rates"
+        },
+        "amount": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Amount"
+        },
+        "surcharge": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Surcharge"
+        }
+      },
+      "type": "object",
+      "required": [
+        "code",
+        "rates",
+        "amount"
+      ],
+      "description": "CategoryTotal groups together all rates inside a given category."
+    },
+    "RateTotal": {
+      "properties": {
+        "country": {
+          "$ref": "https://gobl.org/draft-0/l10n/tax-country-code",
+          "title": "Country",
+          "description": "Country code override when issuing with taxes applied from different countries,\nit'd be very strange to mix rates from different countries, but in theory\nthis would be possible."
+        },
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Key",
+          "description": "Tax key if supported by the category."
+        },
+        "ext": {
+          "$ref": "https://gobl.org/draft-0/tax/extensions",
+          "title": "Extensions",
+          "description": "If the rate is defined with extensions, they'll be used to group by also."
+        },
+        "base": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Base",
+          "description": "Base amount that the percentage is applied to."
+        },
+        "percent": {
+          "$ref": "https://gobl.org/draft-0/num/percentage",
+          "title": "Percent",
+          "description": "Percentage of the rate. Will be nil when taxes are **exempt**."
+        },
+        "surcharge": {
+          "$ref": "#/$defs/RateTotalSurcharge",
+          "title": "Surcharge",
+          "description": "Surcharge applied to the rate."
+        },
+        "amount": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Amount",
+          "description": "Total amount of rate, excluding surcharges"
+        }
+      },
+      "type": "object",
+      "required": [
+        "base",
+        "amount"
+      ],
+      "description": "RateTotal contains a sum of all the tax rates in the document with a matching category and rate."
+    },
+    "RateTotalSurcharge": {
+      "properties": {
+        "percent": {
+          "$ref": "https://gobl.org/draft-0/num/percentage",
+          "title": "Percent"
+        },
+        "amount": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Amount"
+        }
+      },
+      "type": "object",
+      "required": [
+        "percent",
+        "amount"
+      ],
+      "description": "RateTotalSurcharge reflects the sum surcharges inside the rate."
+    },
+    "Total": {
+      "properties": {
+        "categories": {
+          "items": {
+            "$ref": "#/$defs/CategoryTotal"
+          },
+          "type": "array",
+          "title": "Categories",
+          "description": "Grouping of all the taxes by their category"
+        },
+        "sum": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Sum",
+          "description": "Total value of all non-retained or indirect taxes."
+        },
+        "retained": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Retained",
+          "description": "Sum of retained or withheld tax amounts"
+        }
+      },
+      "type": "object",
+      "required": [
+        "sum"
+      ],
+      "description": "Total contains a set of Category Totals which in turn contain all the accumulated taxes contained in the document."
+    }
+  }
+}

data/lib/gobl/extensions/tax/addon_helper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module GOBL
+  module Extensions
+    module Tax
+      # Additional methods for the generated {GOBL::Tax::Regime} class
+      module AddonHelper
+        module ClassMethods
+          # Loads a {GOBL::Tax::Regime} object identified by the given code with all its data
+          #
+          # @param code [String] the code of the regime to load
+          #
+          # @return [Regime] the requested regime
+          def fetch(code)
+            addons[code] ||= load_addon(code)
+          end
+
+          protected
+
+          # map of regime ID to regime instance
+          def addons
+            @addons ||= {}
+          end
+
+          def load_addon(code)
+            path = File.join("#{__dir__}/../../../../data/addons", "#{code.to_s.downcase}.json")
+            msg = "addon definition for #{code} does not exist at #{path}"
+            raise StandardError, msg unless File.exist?(path)
+
+            data = File.read(path)
+            from_json!(data)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gobl/version.rb

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

data/lib/gobl.rb

@@ -51,4 +51,5 @@ 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::RegimeDef.extend GOBL::Extensions::Tax::RegimeHelper::ClassMethods
+GOBL::Tax::AddonDef.extend GOBL::Extensions::Tax::AddonHelper::ClassMethods
 GOBL::Bill::Invoice.include GOBL::Extensions::Bill::InvoiceHelper

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gobl
 version: !ruby/object:Gem::Version
-  version: 0.24.1
+  version: 0.24.3
 platform: ruby
 authors:
 - Luismi Cavalle
@@ -62,6 +62,28 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- data/addons/br-nfe-v4.json
+- data/addons/br-nfse-v1.json
+- data/addons/co-dian-v2.json
+- data/addons/de-xrechnung-v3.json
+- data/addons/de-zugferd-v2.json
+- data/addons/es-facturae-v3.json
+- data/addons/es-tbai-v1.json
+- data/addons/es-verifactu-v1.json
+- data/addons/eu-en16931-v2017.json
+- data/addons/fr-choruspro-v1.json
+- data/addons/fr-facturx-v1.json
+- data/addons/gr-mydata-v1.json
+- data/addons/it-sdi-v1.json
+- data/addons/it-ticket-v1.json
+- data/addons/mx-cfdi-v4.json
+- data/addons/pl-favat-v2.json
+- data/addons/pt-saft-v1.json
+- data/catalogues/cef.json
+- data/catalogues/iso.json
+- data/catalogues/untdid.json
+- data/currency/iso.json
+- data/currency/non-iso.json
 - data/regimes/ae.json
 - data/regimes/at.json
 - data/regimes/be.json
@@ -85,6 +107,75 @@ files:
 - data/regimes/se.json
 - data/regimes/sg.json
 - data/regimes/us.json
+- data/schemas/bill/charge.json
+- data/schemas/bill/correction-options.json
+- data/schemas/bill/delivery-details.json
+- data/schemas/bill/delivery.json
+- data/schemas/bill/discount.json
+- data/schemas/bill/invoice.json
+- data/schemas/bill/line.json
+- data/schemas/bill/order.json
+- data/schemas/bill/ordering.json
+- data/schemas/bill/payment-details.json
+- data/schemas/bill/payment.json
+- data/schemas/bill/tax.json
+- data/schemas/bill/totals.json
+- data/schemas/cal/date-time.json
+- data/schemas/cal/date.json
+- data/schemas/cal/period.json
+- data/schemas/cal/time.json
+- data/schemas/cbc/code-map.json
+- data/schemas/cbc/code.json
+- data/schemas/cbc/definition.json
+- data/schemas/cbc/key.json
+- data/schemas/cbc/meta.json
+- data/schemas/cbc/source.json
+- data/schemas/currency/amount.json
+- data/schemas/currency/code.json
+- data/schemas/currency/exchange-rate.json
+- data/schemas/dsig/digest.json
+- data/schemas/dsig/signature.json
+- data/schemas/envelope.json
+- data/schemas/head/header.json
+- data/schemas/head/link.json
+- data/schemas/head/stamp.json
+- data/schemas/i18n/string.json
+- data/schemas/l10n/code.json
+- data/schemas/l10n/iso-country-code.json
+- data/schemas/l10n/tax-country-code.json
+- data/schemas/note/message.json
+- data/schemas/num/amount.json
+- data/schemas/num/percentage.json
+- data/schemas/org/address.json
+- data/schemas/org/attachment.json
+- data/schemas/org/coordinates.json
+- data/schemas/org/document-ref.json
+- data/schemas/org/email.json
+- data/schemas/org/identity.json
+- data/schemas/org/image.json
+- data/schemas/org/inbox.json
+- data/schemas/org/item.json
+- data/schemas/org/name.json
+- data/schemas/org/note.json
+- data/schemas/org/party.json
+- data/schemas/org/person.json
+- data/schemas/org/registration.json
+- data/schemas/org/telephone.json
+- data/schemas/org/unit.json
+- data/schemas/org/website.json
+- data/schemas/pay/advance.json
+- data/schemas/pay/instructions.json
+- data/schemas/pay/terms.json
+- data/schemas/regimes/mx/food-vouchers.json
+- data/schemas/regimes/mx/fuel-account-balance.json
+- data/schemas/schema/object.json
+- data/schemas/tax/addon-def.json
+- data/schemas/tax/catalogue-def.json
+- data/schemas/tax/extensions.json
+- data/schemas/tax/identity.json
+- data/schemas/tax/regime-def.json
+- data/schemas/tax/set.json
+- data/schemas/tax/total.json
 - lib/generated/gobl/bill/charge.rb
 - lib/generated/gobl/bill/correction_options.rb
 - lib/generated/gobl/bill/delivery.rb
@@ -188,6 +279,7 @@ files:
 - lib/gobl/extensions/envelope_helper.rb
 - lib/gobl/extensions/i18n/value_keys_helper.rb
 - lib/gobl/extensions/schema/object_helper.rb
+- lib/gobl/extensions/tax/addon_helper.rb
 - lib/gobl/extensions/tax/regime_helper.rb
 - lib/gobl/id.rb
 - lib/gobl/map.rb