secretariat 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea7afc077807afc9c37b543936f44c92dd47efde7b88afd9cd0189962a725582
-  data.tar.gz: bf531f1c30ded4f468a0b7b4c8657dece3d9abb3f758b9d1fad167f0ddccdc4a
+  metadata.gz: 3574ab368be0c92f96a25ad98e00f9c17a96da895d1ce3046a1c387eecf43d75
+  data.tar.gz: 90630718af00d0a76af1d75173d58f6c94f7eaf2485dafd9a75a773c2e2f7a97
 SHA512:
-  metadata.gz: b00aa871cdbe0610476e5689756db15ec8f5d584c658548513d2e22c895e1f393e74b42f33b92c7ebb516bf08ebea2b64d240ab58235ef89b0a47a3fa4a9503d
-  data.tar.gz: d34cccd54819f93c2fdf6850a2ffee4306d42034ded2748961814c7159258aab5c06bda3251497ef85e0e417958ab4d044945c544c3e757e244c2df1d7d1a018
+  metadata.gz: c3d9e62d62321d142b502e32b01198256cb22e65b4f0502c071a525a96ae4dff5200d54ca2313a985bad0571c923ebb8c044f5b12b4fd3b1260a4799d2a743cc
+  data.tar.gz: 39ea3264258a3e058b24276caf8232d53db7516b1d10aa2cee66807ee25d601bb68413d61f18125021fcd0bad6bbced1aad14f4b7126392991984f5b8f6dc5db

data/lib/secretariat.rb

@@ -16,6 +16,8 @@ limitations under the License.
 
 require_relative 'secretariat/version'
 require_relative 'secretariat/constants'
+require_relative 'secretariat/helpers'
+require_relative 'secretariat/versioner'
 require_relative 'secretariat/validation_error'
 require_relative 'secretariat/invoice'
 require_relative 'secretariat/trade_party'

data/lib/secretariat/constants.rb

@@ -22,12 +22,36 @@ module Secretariat
    :TAXEXEMPT => "E",
    :ZEROTAXPRODUCTS => "Z",
    :UNTAXEDSERVICE => "O",
-   :INTRACOMMUNITY => "K"
+   :INTRACOMMUNITY => "K",
+   :EXPORT => 'G'
+  }
+
+  TAX_CATEGORY_CODES_1 = {
+   :STANDARDRATE => "S",
+   :REVERSECHARGE => "AE",
+   :TAXEXEMPT => "E",
+   :ZEROTAXPRODUCTS => "Z",
+   :UNTAXEDSERVICE => "O",
+   :INTRACOMMUNITY => "IC",
+   :EXPORT => 'E'
+  }
+
+  PAYMENT_CODES = {
+   :BANKACCOUNT => "42",
+   :NOTSPECIFIED => "1",
+   :AUTOMATICCLEARING => "3",
+   :CASH => "10",
+   :CHECK => "20",
+   :DEBITADVICE => "31",
+   :CREDITCARD => "48",
+   :DEBIT => "49",
+   :COMPENSATION => "97",
   }
 
   TAX_EXEMPTION_REASONS = {
     :REVERSECHARGE => 'Reverse Charge',
-    :INTRACOMMUNITY => ''
+    :INTRACOMMUNITY => 'Intra-community transaction',
+    :EXPORT => 'Export outside the EU'
   }
 
   UNIT_CODES = {

data/lib/secretariat/helpers.rb

@@ -0,0 +1,19 @@
+module Secretariat
+  module Helpers
+    def self.format(something, round: nil, digits:2)
+      dec = BigDecimal(something, 10)
+      dec = dec.round(round, :down) if round
+      "%0.#{digits}f" % dec
+    end
+
+    def self.currency_element(xml, ns, name, amount, currency, add_currency: true, digits: 2)
+      attrs = {}
+      if add_currency
+        attrs[:currencyID] = currency
+      end
+      xml[ns].send(name, attrs) do
+        xml.text(format(amount, round: 4, digits: digits))
+      end
+    end
+  end
+end

data/lib/secretariat/invoice.rb

@@ -24,7 +24,7 @@ module Secretariat
     :buyer,
     :line_items,
     :currency_code,
-    :payment_code,
+    :payment_type,
     :payment_text,
     :tax_category,
     :tax_percent,
@@ -38,6 +38,8 @@ module Secretariat
     keyword_init: true
   ) do
 
+    include Versioner
+
     def errors
       @errors
     end
@@ -46,57 +48,93 @@ module Secretariat
       tax_reason || TAX_EXEMPTION_REASONS[tax_category]
     end
 
-    def tax_category_code
+    def tax_category_code(version: 2)
+      if version == 1
+        return TAX_CATEGORY_CODES_1[tax_category] || 'S'
+      end
       TAX_CATEGORY_CODES[tax_category] || 'S'
     end
 
+    def payment_code
+      PAYMENT_CODES[payment_type] || '1'
+    end
+
     def valid?
+      @errors = []
       tax = BigDecimal(tax_amount)
       basis = BigDecimal(basis_amount)
       calc_tax = basis * BigDecimal(tax_percent) / BigDecimal(100)
+      calc_tax = calc_tax.round(2, :down)
       if tax != calc_tax
-        @errors << "Tax amount and calculated tax amount deviate"
+        @errors << "Tax amount and calculated tax amount deviate: #{tax} / #{calc_tax}"
         return false
       end
       grand_total = BigDecimal(grand_total_amount)
       calc_grand_total = basis + tax
       if grand_total != calc_grand_total
-        @errors << "Grand total amount and calculated grand total amount deviate"
+        @errors << "Grand total amount and calculated grand total amount deviate: #{grand_total} / #{calc_grand_total}"
         return false
       end
       line_item_sum = line_items.inject(BigDecimal(0)) do |m, item|
         m + BigDecimal(item.charge_amount)
       end
       if line_item_sum != basis
-        @errors << "Line items do not add up to basis amount"
+        @errors << "Line items do not add up to basis amount #{line_item_sum} / #{basis}"
         return false
       end
       return true
     end
 
 
-    def to_xml()
+    def namespaces(version: 1)
+      by_version(version,
+        {
+          'xmlns:ram' => 'urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:12',
+          'xmlns:udt' => 'urn:un:unece:uncefact:data:standard:UnqualifiedDataType:15',
+          'xmlns:rsm' => 'urn:ferd:CrossIndustryDocument:invoice:1p0',
+          'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance'
+        },
+        {
+          'xmlns:qdt' => 'urn:un:unece:uncefact:data:standard:QualifiedDataType:100',
+          'xmlns:ram' => 'urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100',
+          'xmlns:udt' => 'urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100',
+          'xmlns:rsm' => 'urn:un:unece:uncefact:data:standard:CrossIndustryInvoice:100',
+          'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance'
+        }
+      )
+    end
+
+    def to_xml(version: 1)
+      if version < 1 || version > 2
+        raise 'Unsupported Document Version'
+      end
 
       unless valid?
         raise ValidationError.new("Invoice is invalid", errors)
       end
 
       builder = Nokogiri::XML::Builder.new do |xml|
-        xml.CrossIndustryInvoice({
-          'xmlns:qdt' => 'urn:un:unece:uncefact:data:standard:QualifiedDataType:100',
-          'xmlns:ram' => 'urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100',
-          'xmlns:udt' => 'urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100',
-          'xmlns' => 'urn:un:unece:uncefact:data:standard:CrossIndustryInvoice:100',
-          'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance'
-        }) do
-          xml.ExchangedDocumentContext do
+
+        root = by_version(version, 'CrossIndustryDocument', 'CrossIndustryInvoice')
+
+        xml['rsm'].send(root, namespaces(version: version)) do
+
+          context = by_version(version, 'SpecifiedExchangedDocumentContext', 'ExchangedDocumentContext')
+
+          xml['rsm'].send(context) do
             xml['ram'].GuidelineSpecifiedDocumentContextParameter do
-              xml['ram'].ID 'urn:cen.eu:en16931:2017'
+              version_id = by_version(version, 'urn:ferd:CrossIndustryDocument:invoice:1p0:comfort', 'urn:cen.eu:en16931:2017')
+              xml['ram'].ID version_id
             end
           end
 
-          xml.ExchangedDocument do
+          header = by_version(version, 'HeaderExchangedDocument', 'ExchangedDocument')
+
+          xml['rsm'].send(header) do
             xml['ram'].ID id
+            if version == 1
+              xml['ram'].Name "RECHNUNG"
+            end
             xml['ram'].TypeCode '380' # TODO: make configurable
             xml['ram'].IssueDateTime do
               xml['udt'].DateTimeString(format: '102') do
@@ -104,21 +142,33 @@ module Secretariat
               end
             end
           end
-          xml.SupplyChainTradeTransaction do
-            line_items.each_with_index do |item, i|
-              item.to_xml(xml, i + 1) # one indexed
+          transaction = by_version(version, 'SpecifiedSupplyChainTradeTransaction', 'SupplyChainTradeTransaction')
+          xml['rsm'].send(transaction) do
+
+            if version == 2
+              line_items.each_with_index do |item, i|
+                item.to_xml(xml, i + 1, version: version) # one indexed
+              end
             end
-            xml['ram'].ApplicableHeaderTradeAgreement do
+
+            trade_agreement = by_version(version, 'ApplicableSupplyChainTradeAgreement', 'ApplicableHeaderTradeAgreement')
+
+            xml['ram'].send(trade_agreement) do
               xml['ram'].SellerTradeParty do
-                seller.to_xml(xml)
+                seller.to_xml(xml, version: version)
               end
               xml['ram'].BuyerTradeParty do
-                buyer.to_xml(xml)
+                buyer.to_xml(xml, version: version)
               end
             end
-            xml['ram'].ApplicableHeaderTradeDelivery do
-              xml['ram'].ShipToTradeParty do
-                buyer.to_xml(xml, exclude_tax: true)
+
+            delivery = by_version(version, 'ApplicableSupplyChainTradeDelivery', 'ApplicableHeaderTradeDelivery')
+
+            xml['ram'].send(delivery) do
+              if version == 2
+                xml['ram'].ShipToTradeParty do
+                  buyer.to_xml(xml, exclude_tax: true, version: version)
+                end
               end
               xml['ram'].ActualDeliverySupplyChainEvent do
                 xml['ram'].OccurrenceDateTime do
@@ -128,34 +178,47 @@ module Secretariat
                 end
               end
             end
-            xml['ram'].ApplicableHeaderTradeSettlement do
+            trade_settlement = by_version(version, 'ApplicableSupplyChainTradeSettlement', 'ApplicableHeaderTradeSettlement')
+            xml['ram'].send(trade_settlement) do
               xml['ram'].InvoiceCurrencyCode currency_code
               xml['ram'].SpecifiedTradeSettlementPaymentMeans do
                 xml['ram'].TypeCode payment_code
                 xml['ram'].Information payment_text
               end
               xml['ram'].ApplicableTradeTax do
-                xml['ram'].CalculatedAmount tax_amount
+
+                Helpers.currency_element(xml, 'ram', 'CalculatedAmount', tax_amount, currency_code, add_currency: version == 1)
                 xml['ram'].TypeCode 'VAT'
                 if tax_reason_text && tax_reason_text != ''
-                  xml['ram'].ExemptionReason tax_reason
+                  xml['ram'].ExemptionReason tax_reason_text
                 end
-                xml['ram'].BasisAmount basis_amount
-                xml['ram'].CategoryCode tax_category_code
-                xml['ram'].RateApplicablePercent tax_percent
+                Helpers.currency_element(xml, 'ram', 'BasisAmount', basis_amount, currency_code, add_currency: version == 1)
+                xml['ram'].CategoryCode tax_category_code(version: version)
+
+                percent = by_version(version, 'ApplicablePercent', 'RateApplicablePercent')
+                xml['ram'].send(percent, Helpers.format(tax_percent))
               end
               xml['ram'].SpecifiedTradePaymentTerms do
                 xml['ram'].Description "Paid"
               end
-              xml['ram'].SpecifiedTradeSettlementHeaderMonetarySummation do
-                xml['ram'].LineTotalAmount basis_amount
-                xml['ram'].TaxBasisTotalAmount basis_amount
-                xml['ram'].TaxTotalAmount(currencyID: currency_code) do
-                  xml.text(tax_amount)
-                end
-                xml['ram'].GrandTotalAmount grand_total_amount
-                xml['ram'].TotalPrepaidAmount paid_amount
-                xml['ram'].DuePayableAmount due_amount
+
+              monetary_summation = by_version(version, 'SpecifiedTradeSettlementMonetarySummation', 'SpecifiedTradeSettlementHeaderMonetarySummation')
+
+              xml['ram'].send(monetary_summation) do
+                Helpers.currency_element(xml, 'ram', 'LineTotalAmount', basis_amount, currency_code, add_currency: version == 1)
+                # TODO: Fix this!
+                Helpers.currency_element(xml, 'ram', 'ChargeTotalAmount', BigDecimal(0), currency_code, add_currency: version == 1)
+                Helpers.currency_element(xml, 'ram', 'AllowanceTotalAmount', BigDecimal(0), currency_code, add_currency: version == 1)
+                Helpers.currency_element(xml, 'ram', 'TaxBasisTotalAmount', basis_amount, currency_code, add_currency: version == 1)
+                Helpers.currency_element(xml, 'ram', 'TaxTotalAmount', tax_amount, currency_code, add_currency: true)
+                Helpers.currency_element(xml, 'ram', 'GrandTotalAmount', grand_total_amount, currency_code, add_currency: version == 1)
+                Helpers.currency_element(xml, 'ram', 'TotalPrepaidAmount', paid_amount, currency_code, add_currency: version == 1)
+                Helpers.currency_element(xml, 'ram', 'DuePayableAmount', due_amount, currency_code, add_currency: version == 1)
+              end
+            end
+            if version == 1
+              line_items.each_with_index do |item, i|
+                item.to_xml(xml, i + 1, version: version) # one indexed
               end
             end
           end
@@ -164,5 +227,4 @@ module Secretariat
       builder.to_xml
     end
   end
-
 end

data/lib/secretariat/line_item.rb

@@ -25,32 +25,49 @@ module Secretariat
     :name,
     :quantity,
     :unit,
-    :unit_amount,
-    :charge_amount,
+    :gross_amount,
+    :net_amount,
     :tax_category,
     :tax_percent,
     :tax_amount,
+    :discount_amount,
+    :discount_reason,
+    :charge_amount,
     :origin_country_code,
+    :currency_code,
     keyword_init: true
   ) do
 
+    include Versioner
+
     def errors
       @errors
     end
 
     def valid?
-      unit_price = BigDecimal(unit_amount)
+      @errors = []
+      net_price = BigDecimal(net_amount)
+      gross_price = BigDecimal(gross_amount)
       charge_price = BigDecimal(charge_amount)
       tax = BigDecimal(tax_amount)
+      unit_price = net_price * BigDecimal(quantity)
 
-      if charge_price != unit_price * BigDecimal(quantity)
-        @errors << "charge price and unit price times quantity deviate"
+      if charge_price != unit_price
+        @errors << "charge price and gross price times quantity deviate: #{charge_price} / #{unit_price}"
         return false
       end
+      if discount_amount
+        discount = BigDecimal(discount_amount)
+        calculated_net_price = (gross_price - discount).round(2, :down)
+        if calculated_net_price != net_price
+          @errors = "Calculated net price and net price deviate: #{calculated_net_price} / #{net_price}"
+          return false
+        end
+      end
 
       calculated_tax = charge_price * BigDecimal(tax_percent) / BigDecimal(100)
       if calculated_tax != tax
-        @errors << "Tax and calculated tax deviate"
+        @errors << "Tax and calculated tax deviate: #{tax} / #{calculated_tax}"
         return false
       end
       return true
@@ -60,12 +77,16 @@ module Secretariat
       UNIT_CODES[unit] || 'C62'
     end
 
-    def tax_category_code
+    def tax_category_code(version: 2)
+      if version == 1
+        return TAX_CATEGORY_CODES_1[tax_category] || 'S'
+      end
       TAX_CATEGORY_CODES[tax_category] || 'S'
     end
 
-    def to_xml(xml, line_item_index)
+    def to_xml(xml, line_item_index, version: 2)
       if !valid?
+        pp errors
         raise ValidationError.new("LineItem #{line_item_index} is invalid", errors)
       end
 
@@ -73,40 +94,79 @@ module Secretariat
         xml['ram'].AssociatedDocumentLineDocument do
           xml['ram'].LineID line_item_index
         end
-        xml['ram'].SpecifiedTradeProduct do
-          xml['ram'].Name name
-          xml['ram'].OriginTradeCountry do
-            xml['ram'].ID origin_country_code
+        if (version == 2)
+          xml['ram'].SpecifiedTradeProduct do
+            xml['ram'].Name name
+            xml['ram'].OriginTradeCountry do
+              xml['ram'].ID origin_country_code
+            end
           end
         end
-        xml['ram'].SpecifiedLineTradeAgreement do
+        agreement = by_version(version, 'SpecifiedSupplyChainTradeAgreement', 'SpecifiedLineTradeAgreement')
+
+        xml['ram'].send(agreement) do
           xml['ram'].GrossPriceProductTradePrice do
-            xml['ram'].ChargeAmount unit_amount
-            xml['ram'].BasisQuantity(unitCode: unit_code) do
-              xml.text(quantity)
+            Helpers.currency_element(xml, 'ram', 'ChargeAmount', gross_amount, currency_code, add_currency: version == 1, digits: 4)
+            if version == 2 && discount_amount
+              xml['ram'].BasisQuantity(unitCode: unit_code) do
+                xml.text(Helpers.format(quantity, digits: 4))
+              end
+              xml['ram'].AppliedTradeAllowanceCharge do
+                xml['ram'].ChargeIndicator do
+                  xml['udt'].Indicator 'false'
+                end
+                Helpers.currency_element(xml, 'ram', 'ActualAmount', discount_amount, currency_code, add_currency: version == 1)
+                xml['ram'].Reason discount_reason
+              end
+            end
+            if version == 1 && discount_amount
+              xml['ram'].AppliedTradeAllowanceCharge do
+                xml['ram'].ChargeIndicator do
+                  xml['udt'].Indicator 'false'
+                end
+                Helpers.currency_element(xml, 'ram', 'ActualAmount', discount_amount, currency_code, add_currency: version == 1)
+                xml['ram'].Reason discount_reason
+              end
             end
           end
           xml['ram'].NetPriceProductTradePrice do
-            xml['ram'].ChargeAmount unit_amount
-            xml['ram'].BasisQuantity(unitCode: unit_code) do
-              xml.text(quantity)
+            Helpers.currency_element(xml, 'ram', 'ChargeAmount', net_amount, currency_code, add_currency: version == 1, digits: 4)
+            if version == 2
+              xml['ram'].BasisQuantity(unitCode: unit_code) do
+                xml.text(Helpers.format(quantity, digits: 4))
+              end
             end
           end
         end
-        xml['ram'].SpecifiedLineTradeDelivery do
+
+        delivery = by_version(version, 'SpecifiedSupplyChainTradeDelivery', 'SpecifiedLineTradeDelivery')
+
+        xml['ram'].send(delivery) do
           xml['ram'].BilledQuantity(unitCode: unit_code) do
-            xml.text(quantity)
+            xml.text(Helpers.format(quantity, digits: 4))
           end
         end
-        xml['ram'].SpecifiedLineTradeSettlement do
+
+        settlement = by_version(version, 'SpecifiedSupplyChainTradeSettlement', 'SpecifiedLineTradeSettlement')
+
+        xml['ram'].send(settlement) do
           xml['ram'].ApplicableTradeTax do
             xml['ram'].TypeCode 'VAT'
-            xml['ram'].CategoryCode tax_category_code
-            xml['ram'].RateApplicablePercent tax_percent
+            xml['ram'].CategoryCode tax_category_code(version: version)
 
+            percent = by_version(version, 'ApplicablePercent', 'RateApplicablePercent')
+            xml['ram'].send(percent,Helpers.format(tax_percent))
+
+          end
+          monetary_summation = by_version(version, 'SpecifiedTradeSettlementMonetarySummation', 'SpecifiedTradeSettlementLineMonetarySummation')
+          xml['ram'].send(monetary_summation) do
+            Helpers.currency_element(xml, 'ram', 'LineTotalAmount', charge_amount, currency_code, add_currency: version == 1)
           end
-          xml['ram'].SpecifiedTradeSettlementLineMonetarySummation do
-            xml['ram'].LineTotalAmount charge_amount
+        end
+
+        if version == 1
+          xml['ram'].SpecifiedTradeProduct do
+            xml['ram'].Name name
           end
         end
       end