secretariat 3.3.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aede1e2eafc1189446e824cb5977b9c3844f71fa4c505214aa4d9b9f79e1101
-  data.tar.gz: 533c4f81ae8b50977df60f6c2bc31565cbbfd93066c52d8cf1961215971319fd
+  metadata.gz: 101180b4e01b5fab64b9362975b172d91ecebf1926f22d9128339f8c1599084e
+  data.tar.gz: '0795397ea1963f7f8de510bafc929b5590ff52586b1f96b0a8e3b77ec01b1867'
 SHA512:
-  metadata.gz: a3358bd3eec524b4e76fc8f32945dca7cb665d683a256e69350fa31c340db2a75f77f3f64883978da387a52edd9beb4810ffe362d67341c81abe28579a979e1f
-  data.tar.gz: 5f347f7253bc8f814a0e1524c968506679d7bb1108c9a4cf03d9716830829ae393e5cde2df2b9d83210a237b075354863ef06af10df2e3d984a699a9c1d758c3
+  metadata.gz: f21836d1199fd2d1bcf36eb7bda5c2bfcdfc73154e0281200002d5b19bd30ef07c4b5d7b18a400f978637ada150fe7a95efec9623e71267dbbe3cfc7d230d6c9
+  data.tar.gz: d5e574f2a06c3cf7f929b045a58c60867e7986a2f451484aee5ac4cf7185cdae36fc1fd0890a941ef2c330362544043d93a5561a906d09a32d55104c6c10ef83

data/README.md

@@ -7,7 +7,7 @@ See tests for examples.
 1. This is an opinionated library optimised for my very specific usecase
 2. While I did start to add some validations to make sure you can't input absolute garbage into this, I cannot guarantee factual (as in taxation law) correctness of the resulting XML.
 1. The library, for ZUGFeRD 2.x, currently only supports the EN16931 variant. This is probably what you want as well. PRs welcome.
-3. This does not contain any code to attach the XML to a PDF file, mainly because I have yet to find a ruby library to do that. For software that does this, take a look at [this python library](https://github.com/akretion/factur-x).
+3. This does not contain any code to attach the XML to a PDF file, mainly because I have yet to find a ruby library to do that. For software that does this, take a look at [this python library](https://github.com/akretion/factur-x) or [this Java library which also does extended validation](https://mustangproject.org)
 
 ## Contributors
 

data/lib/secretariat/constants.rb

@@ -66,7 +66,7 @@ module Secretariat
 
   # For the background of vertical and horizontal tax calculation see https://hilfe.pacemo.de/de-form/articles/3489851-rundungsfehler-bei-rechnungen
   # The idea of introducing an unknown value is that this could be inferred from the given invoice total and line items by probing both variants and selecting the matching one - or reporting a taxation error if neither matches.
-  TAX_CALCULATION_METHODS = %i[HORIZONTAL VERTICAL UNKNOWN].freeze
+  TAX_CALCULATION_METHODS = %i[HORIZONTAL VERTICAL NONE UNKNOWN].freeze
 
   UNIT_CODES = {
     :PIECE => "C62",

data/lib/secretariat/invoice.rb

@@ -65,11 +65,26 @@ module Secretariat
 
     def taxes
       taxes = {}
+      # Shortcut for cases where invoices only have one tax and the calculation is off by a cent because of rounding errors
+      # (This can happen if the VAT and the net amount is calculated backwards from a round gross amount)
+      if tax_calculation_method == :NONE
+        tax = Tax.new(tax_percent: BigDecimal(tax_percent || BigDecimal(0)), tax_category: tax_category)
+        tax.base_amount = BigDecimal(basis_amount)
+        tax.tax_amount = BigDecimal(tax_amount || 0)
+        return [tax]
+      end
+
       line_items.each do |line_item|
-        taxes[line_item.tax_percent] = Tax.new(tax_percent: BigDecimal(line_item.tax_percent), tax_category: line_item.tax_category) if taxes[line_item.tax_percent].nil?
-        taxes[line_item.tax_percent].tax_amount += BigDecimal(line_item.tax_amount)
-        taxes[line_item.tax_percent].base_amount += BigDecimal(line_item.net_amount) * line_item.quantity
+        if line_item.tax_percent.nil?
+          taxes['0'] = Tax.new(tax_percent: BigDecimal(0), tax_category: line_item.tax_category, tax_amount: BigDecimal(0)) if taxes['0'].nil?
+          taxes['0'].base_amount += BigDecimal(line_item.net_amount) * line_item.quantity
+        else
+          taxes[line_item.tax_percent] = Tax.new(tax_percent: BigDecimal(line_item.tax_percent), tax_category: line_item.tax_category) if taxes[line_item.tax_percent].nil?
+          taxes[line_item.tax_percent].tax_amount += BigDecimal(line_item.tax_amount)
+          taxes[line_item.tax_percent].base_amount += BigDecimal(line_item.net_amount) * line_item.quantity
+        end
       end
+      
       if tax_calculation_method == :VERTICAL
         taxes.values.map do |tax|
           tax.tax_amount = (tax.base_amount * tax.tax_percent / 100).round(2)
@@ -98,12 +113,19 @@ module Secretariat
         @errors << "Base amount and summed tax base amount deviate: #{basis} / #{summed_tax_base_amount}"
         return false
       end
-      taxes.each do |tax|
-        calc_tax = tax.base_amount * BigDecimal(tax.tax_percent) / BigDecimal(100)
-        calc_tax = calc_tax.round(2)
-        if tax.tax_amount != calc_tax
-          @errors << "Tax amount and calculated tax amount deviate for rate #{tax.tax_percent}: #{tax.tax_amount} / #{calc_tax}"
-          return false
+      if tax_calculation_method == :ITEM_BASED
+        line_items_tax_amount = line_items.sum(&:tax_amount)
+        if tax_amount != line_items_tax_amount
+          @errors << "Tax amount #{tax_amount} and summed up item tax amounts #{line_items_tax_amount} deviate"
+        end
+      elsif tax_calculation_method != :NONE
+        taxes.each do |tax|
+          calc_tax = tax.base_amount * BigDecimal(tax.tax_percent) / BigDecimal(100)
+          calc_tax = calc_tax.round(2)
+          if tax.tax_amount != calc_tax
+            @errors << "Tax amount and calculated tax amount deviate for rate #{tax.tax_percent}: #{tax.tax_amount} / #{calc_tax}"
+            return false
+          end
         end
       end
       grand_total = BigDecimal(grand_total_amount)
@@ -150,7 +172,7 @@ module Secretariat
         raise ValidationError.new("Invoice is invalid", errors)
       end
 
-      builder = Nokogiri::XML::Builder.new do |xml|
+      builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
 
         root = by_version(version, 'CrossIndustryDocument', 'CrossIndustryInvoice')
 
@@ -250,9 +272,10 @@ module Secretariat
                   end
                   Helpers.currency_element(xml, 'ram', 'BasisAmount', tax.base_amount, currency_code, add_currency: version == 1)
                   xml['ram'].CategoryCode tax_category_code(tax, version: version)
-
-                  percent = by_version(version, 'ApplicablePercent', 'RateApplicablePercent')
-                  xml['ram'].send(percent, Helpers.format(tax.tax_percent))
+                  # unless tax.untaxable?
+                    percent = by_version(version, 'ApplicablePercent', 'RateApplicablePercent')
+                    xml['ram'].send(percent, Helpers.format(tax.tax_percent))
+                  # end
                 end
               end
               if version == 2 && service_period_start && service_period_end

data/lib/secretariat/line_item.rb

@@ -14,8 +14,6 @@ See the License for the specific language governing permissions and
 limitations under the License.
 =end
 
-
-
 require 'bigdecimal'
 module Secretariat
 
@@ -63,13 +61,15 @@ module Secretariat
           return false
         end
       end
-
-      calculated_tax = charge_price * BigDecimal(tax_percent) / BigDecimal(100)
-      calculated_tax = calculated_tax.round(2)
-      calculated_tax = -calculated_tax if quantity.negative?
-      if calculated_tax != tax
-        @errors << "Tax and calculated tax deviate: #{tax} / #{calculated_tax}"
-        return false
+      if tax_category != :UNTAXEDSERVICE
+        self.tax_percent ||= BigDecimal(0)
+        calculated_tax = charge_price * BigDecimal(tax_percent) / BigDecimal(100)
+        calculated_tax = calculated_tax.round(2)
+        calculated_tax = -calculated_tax if quantity.negative?
+        if calculated_tax != tax
+          @errors << "Tax and calculated tax deviate: #{tax} / #{calculated_tax}"
+          return false
+        end
       end
       return true
     end
@@ -85,11 +85,17 @@ module Secretariat
       TAX_CATEGORY_CODES[tax_category] || 'S'
     end
 
+    def untaxable?
+      tax_category == :UNTAXEDSERVICE
+    end
+
     def to_xml(xml, line_item_index, version: 2, validate: true)
       net_price = net_amount && BigDecimal(net_amount)
       gross_price = gross_amount && BigDecimal(gross_amount)
       charge_price = charge_amount && BigDecimal(charge_amount)
 
+      self.tax_percent ||= BigDecimal(0)
+
       if net_price&.zero?
         self.tax_percent = 0
       end
@@ -170,10 +176,10 @@ module Secretariat
           xml['ram'].ApplicableTradeTax do
             xml['ram'].TypeCode 'VAT'
             xml['ram'].CategoryCode tax_category_code(version: version)
-
-            percent = by_version(version, 'ApplicablePercent', 'RateApplicablePercent')
-            xml['ram'].send(percent,Helpers.format(tax_percent))
-
+            unless untaxable?
+              percent = by_version(version, 'ApplicablePercent', 'RateApplicablePercent')
+              xml['ram'].send(percent,Helpers.format(tax_percent))            
+            end
           end
           monetary_summation = by_version(version, 'SpecifiedTradeSettlementMonetarySummation', 'SpecifiedTradeSettlementLineMonetarySummation')
           xml['ram'].send(monetary_summation) do

data/lib/secretariat/tax.rb

@@ -30,5 +30,10 @@ module Secretariat
       self.tax_amount = 0
       self.base_amount = 0
     end
+
+    def untaxable?
+      tax_category == :UNTAXEDSERVICE
+    end
+
   end
 end

data/lib/secretariat/trade_party.rb

@@ -16,10 +16,15 @@ limitations under the License.
 
 module Secretariat
   TradeParty = Struct.new('TradeParty',
-    :name, :street1, :street2, :city, :postal_code, :country_id, :vat_id,
+    :name, :street1, :street2, :city, :postal_code, :country_id, :vat_id, :global_id, :global_id_scheme_id, :tax_id,
     keyword_init: true,
   ) do
     def to_xml(xml, exclude_tax: false, version: 2)
+      if global_id && global_id != '' && global_id_scheme_id && global_id_scheme_id != ''
+        xml['ram'].GlobalID(schemeID: global_id_scheme_id) do
+          xml.text(global_id)
+        end
+      end
       xml['ram'].Name name
       xml['ram'].PostalTradeAddress do
         xml['ram'].PostcodeCode postal_code
@@ -36,9 +41,13 @@ module Secretariat
             xml.text(vat_id)
           end
         end
+      elsif tax_id && tax_id != ''
+        xml['ram'].SpecifiedTaxRegistration do
+          xml['ram'].ID(schemeID: 'FC') do
+            xml.text(tax_id)
+          end
+        end
       end
     end
   end
-
-
 end

data/lib/secretariat/version.rb

@@ -15,5 +15,5 @@ limitations under the License.
 =end
 
 module Secretariat
-  VERSION = '3.3.0'
+  VERSION = '3.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: secretariat
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Jan Krutisch