tradedoc 0.1.0

data/lib/tradedoc/format/cii/coder/remittance_advice.rb

@@ -0,0 +1,130 @@
+module Tradedoc
+  module Format
+    module CII
+      module Coder
+        class RemittanceAdvice
+          NS = {
+            "xmlns:qdt" => "urn:un:unece:uncefact:data:standard:QualifiedDataType:100",
+            "xmlns:ram" => "urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100",
+            "xmlns:rsm" => "urn:un:unece:uncefact:data:standard:CrossIndustryRemittanceAdvice:100",
+            "xmlns:udt" => "urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100",
+            "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema"
+          }.freeze
+
+          def self.namespaces
+            NS
+          end
+
+          def self.can_parse?(xmldoc)
+            xmldoc.root.namespace&.href == namespaces.fetch("xmlns:rsm")
+          end
+
+          def self.ruby_type
+            Model::RemittanceAdvice
+          end
+
+          def self.dump(w, obj)
+            w.add("rsm:CrossIndustryRemittanceAdvice", NS) do
+              w.add("ExchangedDocument") do
+                w.add("ram:ID", obj.id)
+                w.render(obj.issue_date, as: "ram:IssueDateTime")
+
+                if (note = obj.note)
+                  w.add("ram:IncludedNote") do
+                    w.add("ram:Content", note)
+                  end
+                end
+
+                w.render(obj.invoice_period, as: "ram:EffectiveSpecifiedPeriod")
+              end
+
+              w.add("rsm:TradeSettlementPayment") do
+                w.render(obj.payment_means.payment_id, as: "ram:EndToEndID")
+                w.render(obj.payment_means.instruction_id, as: "ram:InstructionID")
+                w.add("ram:SpecifiedPaymentTradeSettlement") do
+                  w.render(obj.supplier, as: "PayeeTradeParty")
+                  w.render(obj.buyer, as: "PayerTradeParty")
+                  w.add("ram:SpecifiedTradeSettlementPaymentMonetarySummation") do
+                    w.render(obj.total_payment_amount, as: "PaymentTotalAmount")
+                  end
+                  w.render(obj.payment_means)
+                end
+              end
+
+              obj.lines.each do |line|
+                w.add("rsm:SupplyChainTradeTransaction") do
+                  w.add("ram:AssociatedDocumentLineDocument") do
+                    w.add("ram:LineID", line.id)
+                  end
+
+                  w.add("ram:ApplicableHeaderTradeSettlement") do
+                    w.render(line.exchange_rate, as: "ram:PaymentApplicableTradeCurrencyExchange")
+
+                    # The final amount *in the payout currency* for this line.
+                    w.add("ram:SpecifiedTradeSettlementHeaderMonetarySummation") do
+                      w.render(line.balance_amount, as: "PaymentTotalAmount")
+                    end
+
+                    w.render(line.document_reference, as: "ram:InvoiceReferencedDocument")
+                  end
+                end
+              end
+            end
+          end
+
+          def self.parse(r)
+            ruby_type.new.tap do |ra|
+              r.with_node("rsm:CrossIndustryRemittanceAdvice") do
+                r.with_node("rsm:ExchangedDocument") do
+                  r.parse("ram:ID", :String) { ra.id = it }
+                  r.with_node("ram:IncludedNote") do
+                    r.parse("ram:Content", :String) { ra.note = it }
+                  end
+                  r.parse("ram:IssueDateTime", :Date) { ra.issue_date = it }
+                  r.parse("ram:EffectiveSpecifiedPeriod", :Period) { ra.invoice_period = it }
+                end
+
+                r.with_node("rsm:TradeSettlementPayment") do
+                  r.with_node("ram:SpecifiedPaymentTradeSettlement") do
+                    r.parse("ram:PayeeTradeParty", :TradeParty) { ra.supplier = it }
+                    r.parse("ram:PayerTradeParty", :TradeParty) { ra.buyer = it }
+                    r.parse("ram:SpecifiedTradeSettlementPaymentMeans", :PaymentMeans) { ra.payment_means = it }
+
+                    r.with_node("ram:SpecifiedTradeSettlementPaymentMonetarySummation") do
+                      r.parse("ram:PaymentTotalAmount", :Money) { ra.total_payment_amount = it }
+                    end
+                  end
+
+                  # Our `PaymentMeans` is spread across multiple different nodes, so we can't
+                  # do a nice clean parse all at once. We have to add to the existing object.
+                  r.parse("ram:EndToEndID", :String) { ra.payment_means.payment_id = it }
+                  r.parse("ram:InstructionID", :String) { ra.payment_means.instruction_id = it }
+                end
+
+                r.with_nodes("rsm:SupplyChainTradeTransaction") do
+                  line = Model::RemittanceAdviceLine.new
+
+                  r.with_node("ram:AssociatedDocumentLineDocument") do
+                    r.parse("ram:LineID", :String) { line.id = it }
+                  end
+
+                  r.with_node("ram:ApplicableHeaderTradeSettlement") do
+                    r.parse("ram:PaymentApplicableTradeCurrencyExchange", :ExchangeRate) { line.exchange_rate = it }
+                    r.with_node("ram:SpecifiedTradeSettlementHeaderMonetarySummation") do
+                      r.parse("ram:GrandTotalAmount", :Money) { line.debit_amount = it }
+                      r.parse("ram:TotalDiscountBasis", :Money) { line.credit_amount = it }
+                      r.parse("ram:PaymentTotalAmount", :Money) { line.balance_amount = it }
+                    end
+                    r.parse("ram:InvoiceReferencedDocument", :DocumentReference) { line.document_reference = it }
+                  end
+
+                  ra.lines.push(line)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tradedoc/format/cii/coder/string.rb

@@ -0,0 +1,21 @@
+module Tradedoc
+  module Format
+    module CII
+      module Coder
+        class String
+          def self.ruby_type
+            ::String
+          end
+
+          def self.dump(w, obj, as:)
+            w.add(as, obj)
+          end
+
+          def self.parse(r, strip: true, nilify: true)
+            r.text(strip:, nilify:)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tradedoc/format/cii/coder/tax_subtotal.rb

@@ -0,0 +1,35 @@
+module Tradedoc
+  module Format
+    module CII
+      module Coder
+        class TaxSubtotal
+          def self.ruby_type
+            Model::TaxSubtotal
+          end
+
+          def self.dump(w, obj, as: "ram:ApplicableTradeTax")
+            w.add(as) do
+              w.render(obj.tax_amount, as: "ram:CalculatedAmount")
+              w.render(obj.tax_category.tax_scheme, as: "ram:TypeCode")
+              w.render(obj.taxable_amount, as: "ram:BasisAmount")
+              w.render(obj.tax_category.code.edifact_id, as: "ram:CategoryCode")
+              w.render(obj.tax_category.rate_percent, as: "ram:RateApplicablePercent")
+            end
+          end
+
+          def self.parse(r, default_currency: nil)
+            ruby_type.new.tap do |obj|
+              obj.tax_category ||= Model::TaxCategory.new
+
+              r.parse("ram:CalculatedAmount", :Money, default_currency:) { obj.tax_amount = it }
+              r.parse("ram:TypeCode", :String) { obj.tax_category.tax_scheme = it }
+              r.parse("ram:BasisAmount", :Money, default_currency:) { obj.taxable_amount = it }
+              r.parse("ram:CategoryCode", :String) { obj.tax_category.code = it }
+              r.parse("ram:RateApplicablePercent", :BigDecimal) { obj.tax_category.rate_percent = it }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tradedoc/format/cii/coder/trade_party.rb

@@ -0,0 +1,29 @@
+module Tradedoc
+  module Format
+    module CII
+      module Coder
+        class TradeParty
+          def self.ruby_type
+            Model::TradeParty
+          end
+
+          def self.dump(w, obj, as:)
+            w.add(as) do
+              w.render(obj.name, as: "Name")
+              w.render(obj.contact, as: "ram:DefinedTradeContact")
+              w.render(obj.address, as: "PostalTradeAddress")
+            end
+          end
+
+          def self.parse(r)
+            ruby_type.new.tap do |tp|
+              r.parse("ram:Name", :String) { tp.name = it }
+              r.parse("ram:DefinedTradeContact", :Contact) { tp.contact = it }
+              r.parse("ram:PostalTradeAddress", :Address) { tp.address = it }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tradedoc/format/cii/coder.rb

@@ -0,0 +1,27 @@
+module Tradedoc
+  module Format
+    module CII
+      module Coder
+      end
+    end
+  end
+end
+
+require_relative "coder/address"
+require_relative "coder/big_decimal"
+require_relative "coder/contact"
+require_relative "coder/date"
+require_relative "coder/document_reference"
+require_relative "coder/exchange_rate"
+require_relative "coder/financial_account"
+require_relative "coder/financial_institution"
+require_relative "coder/invoice"
+require_relative "coder/invoice_line"
+require_relative "coder/monetary_total"
+require_relative "coder/money"
+require_relative "coder/payment_means"
+require_relative "coder/period"
+require_relative "coder/remittance_advice"
+require_relative "coder/string"
+require_relative "coder/tax_subtotal"
+require_relative "coder/trade_party"

data/lib/tradedoc/format/cii.rb

@@ -0,0 +1,12 @@
+# CII, or Cross-Industry Invoice standard from UN/CEFACT
+module Tradedoc
+  module Format
+    module CII
+      extend Accessors
+      extend Finders
+      extend XMLSerialization
+    end
+  end
+end
+
+require_relative "cii/coder"

data/lib/tradedoc/format/facturae.rb

@@ -0,0 +1,51 @@
+module Tradedoc
+  module Format
+    # Spanish e-invoice format.
+    # No actual support implemented yet, just detection.
+    module FacturaE
+      extend Accessors
+      extend Finders
+      extend XMLSerialization
+
+      def self.file_extensions
+        Set[".xml", ".xsig"]
+      end
+
+      module Coder
+        class Invoice
+          # Each revision of the spec gets its own namespace.
+          # `NS` is for building current-spec documents.
+          # `OTHER_NS` is for detecting legacy versions that can still be parsed.
+          NS = {
+            "xmlns" => "http://www.facturae.gob.es/formato/Versiones/Facturaev3_2_2.xml"
+          }.freeze
+
+          OTHER_NS = Set[
+            "http://www.facturae.es/Facturae/2007/v3.0/Facturae",
+            "http://www.facturae.es/Facturae/2009/v3.2/Facturae",
+            "http://www.facturae.es/Facturae/2014/v3.2.1/Facturae"
+          ].freeze
+
+          private_constant :NS, :OTHER_NS
+
+          def self.namespaces
+            NS
+          end
+
+          def self.can_parse?(xmldoc)
+            root_ns = xmldoc.root.namespace&.href
+            namespaces.fetch("xmlns") == root_ns || OTHER_NS.include?(root_ns)
+          end
+
+          def self.dump(w, obj)
+            raise NotImplementedError
+          end
+
+          def self.parse(r)
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tradedoc/format/fatturapa/coder/invoice.rb

@@ -0,0 +1,31 @@
+module Tradedoc
+  module Format
+    module FatturaPA
+      module Coder
+        class Invoice
+          NS = {
+            "xmlns:p" => "http://ivaservizi.agenziaentrate.gov.it/docs/xsd/fatture/v1.2"
+          }
+          private_constant :NS
+
+          def self.namespaces
+            NS
+          end
+
+          # @param xmldoc [Nokogiri::XML::Document]
+          def self.can_parse?(xmldoc)
+            xmldoc.root.namespace&.href == namespaces.fetch("xmlns:p")
+          end
+
+          def self.dump(w, obj)
+            raise NotImplementedError
+          end
+
+          def self.parse(r)
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tradedoc/format/fatturapa/coder.rb

@@ -0,0 +1,8 @@
+module Tradedoc
+  module FatturaPA
+    module Coder
+    end
+  end
+end
+
+require_relative "coder/invoice"

data/lib/tradedoc/format/fatturapa.rb

@@ -0,0 +1,13 @@
+module Tradedoc
+  module Format
+    # Italian e-invoice format. Not compliant with EN 16931.
+    # https://www.fatturapa.gov.it/en/norme-e-regole/documentazione-fattura-elettronica/formato-fatturapa/
+    module FatturaPA
+      extend Accessors
+      extend Finders
+      extend XMLSerialization
+    end
+  end
+end
+
+require_relative "fatturapa/coder"

data/lib/tradedoc/format/isdoc.rb

@@ -0,0 +1,40 @@
+module Tradedoc
+  module Format
+    # Czechia
+    module ISDOC
+      extend Accessors
+      extend Finders
+      extend XMLSerialization
+
+      def self.file_extensions
+        Set[".isdoc"]
+      end
+
+      module Coder
+        class Invoice
+          NS = {
+            "xmlns" => "http://isdoc.cz/namespace/2013"
+          }.freeze
+
+          private_constant :NS
+
+          def self.namespaces
+            NS
+          end
+
+          def self.can_parse?(xmldoc)
+            xmldoc.root.namespace&.href == namespaces.fetch("xmlns")
+          end
+
+          def self.dump(w, obj)
+            raise NotImplementedError
+          end
+
+          def self.parse(r)
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tradedoc/format/ksef/coder/invoice.rb

@@ -0,0 +1,32 @@
+module Tradedoc
+  module Format
+    module KSEF
+      module Coder
+        class Invoice
+          NS = {
+            "xmlns" => "http://crd.gov.pl/wzor/2025/06/25/13775/",
+            "xmlns:etd" => "http://crd.gov.pl/xml/schematy/dziedzinowe/mf/2022/01/05/eD/DefinicjeTypy/"
+          }
+          private_constant :NS
+
+          def self.namespaces
+            NS
+          end
+
+          # @param xmldoc [Nokogiri::XML::Document]
+          def self.can_parse?(xmldoc)
+            xmldoc.root.namespace&.href == namespaces.fetch("xmlns")
+          end
+
+          def self.dump(w, obj)
+            raise NotImplementedError
+          end
+
+          def self.parse(r)
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tradedoc/format/ksef/coder.rb

@@ -0,0 +1,10 @@
+module Tradedoc
+  module Format
+    module KSEF
+      module Coder
+      end
+    end
+  end
+end
+
+require_relative "coder/invoice"

data/lib/tradedoc/format/ksef.rb

@@ -0,0 +1,17 @@
+module Tradedoc
+  module Format
+    # Poland
+    # https://ksef.mf.gov.pl/
+    module KSEF
+      extend Accessors
+      extend Finders
+      extend XMLSerialization
+
+      def self.label
+        "KSeF"
+      end
+    end
+  end
+end
+
+require_relative "ksef/coder"

data/lib/tradedoc/format/mydata.rb

@@ -0,0 +1,42 @@
+module Tradedoc
+  module Format
+    # Greece
+    module MyData
+      extend Accessors
+      extend Finders
+      extend XMLSerialization
+
+      def self.label
+        "myDATA"
+      end
+
+      module Coder
+        class Invoice
+          NS = {
+            "xmlns" => "http://www.aade.gr/myDATA/invoice/v1.0",
+            "xmlns:icls" => "https://www.aade.gr/myDATA/incomeClassificaton/v1.0",
+            "xmlns:ecls" => "https://www.aade.gr/myDATA/expensesClassificaton/v1.0"
+          }.freeze
+
+          private_constant :NS
+
+          def self.namespaces
+            NS
+          end
+
+          def self.can_parse?(xmldoc)
+            xmldoc.root.namespace&.href == namespaces.fetch("xmlns")
+          end
+
+          def self.dump(w, obj)
+            raise NotImplementedError
+          end
+
+          def self.parse(r)
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tradedoc/format/nav.rb

@@ -0,0 +1,38 @@
+module Tradedoc
+  module Format
+    # Current Hungarian e-invoice format
+    module NAV
+      extend Accessors
+      extend Finders
+      extend XMLSerialization
+
+      module Coder
+        class Invoice
+          NS = {
+            "xmlns" => "http://schemas.nav.gov.hu/OSA/3.0/data",
+            "xmlns:base" => "http://schemas.nav.gov.hu/OSA/3.0/base",
+            "xmlns:common" => "http://schemas.nav.gov.hu/NTCA/1.0/common"
+          }.freeze
+
+          private_constant :NS
+
+          def self.namespaces
+            NS
+          end
+
+          def self.can_parse?(xmldoc)
+            xmldoc.root.namespace&.href == namespaces.fetch("xmlns")
+          end
+
+          def self.dump(w, obj)
+            raise NotImplementedError
+          end
+
+          def self.parse(r)
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tradedoc/format/ubl/coder/address.rb

@@ -0,0 +1,48 @@
+module Tradedoc
+  module Format
+    module UBL
+      module Coder
+        class Address
+          def self.ruby_type
+            Model::Address
+          end
+
+          def self.dump(w, obj, as:)
+            w.add("cac:#{as}") do
+              w.render(obj.street_name, as: "cbc:StreetName")
+              w.render(obj.building_number, as: "cbc:BuildingNumber")
+              w.render(obj.city, as: "cbc:CityName")
+              w.render(obj.postal_code, as: "cbc:PostalZone")
+              w.render(obj.subdivision&.name, as: "cbc:CountrySubentity")
+              w.render(obj.subdivision&.code, as: "cbc:CountrySubentityCode")
+              obj.lines.each do |line|
+                w.add("cac:AddressLine") do
+                  w.add("cbc:Line", line)
+                end
+              end
+              w.render(obj.country)
+            end
+          end
+
+          def self.parse(r)
+            ruby_type.new.tap do |obj|
+              obj.subdivision = {}
+              r.parse("cbc:StreetName", :String) { obj.street_name = it }
+              r.parse("cbc:BuildingNumber", :String) { obj.building_number = it }
+              r.parse("cbc:CityName", :String) { obj.city = it }
+              r.parse("cbc:PostalZone", :String) { obj.postal_code = it }
+              r.parse("cbc:CountrySubentity", :String) { obj.subdivision.name = it }
+              r.parse("cbc:CountrySubentityCode", :String) { obj.subdivision.code = it }
+              r.parse("cac:Country", :Country) { obj.country = it }
+              r.with_nodes("cac:AddressLine") do
+                r.with_node("cbc:Line") do
+                  obj.lines.push(r.text)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tradedoc/format/ubl/coder/big_decimal.rb

@@ -0,0 +1,21 @@
+module Tradedoc
+  module Format
+    module UBL
+      module Coder
+        class BigDecimal
+          def self.ruby_type
+            ::BigDecimal
+          end
+
+          def self.dump(w, obj, as:)
+            w.add(as, obj.to_s("F"))
+          end
+
+          def self.parse(r)
+            ruby_type.interpret_loosely(r.text)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tradedoc/format/ubl/coder/contact.rb

@@ -0,0 +1,29 @@
+module Tradedoc
+  module Format
+    module UBL
+      module Coder
+        class Contact
+          def self.ruby_type
+            Model::Contact
+          end
+
+          def self.dump(w, obj, as: "cac:Contact")
+            w.add(as) do
+              w.render(obj.name, as: "cbc:Name")
+              w.render(obj.phone, as: "cbc:Telephone")
+              w.render(obj.email, as: "cbc:ElectronicMail")
+            end
+          end
+
+          def self.parse(r)
+            ruby_type.new.tap do |c|
+              r.parse("cbc:Name", :String) { c.name = it }
+              r.parse("cbc:Telephone", :String) { c.phone = it }
+              r.parse("cbc:ElectronicMail", :String) { c.email = it }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tradedoc/format/ubl/coder/country.rb

@@ -0,0 +1,27 @@
+module Tradedoc
+  module Format
+    module UBL
+      module Coder
+        class Country
+          def self.ruby_type
+            Model::Country
+          end
+
+          def self.dump(w, obj, as: "cac:Country")
+            w.add(as) do
+              w.render(obj.iso_code, as: "cbc:IdentificationCode")
+              w.render(obj.name, as: "cbc:Name")
+            end
+          end
+
+          def self.parse(r)
+            ruby_type.new.tap do |c|
+              r.parse("cbc:IdentificationCode", :String) { c.iso_code = it }
+              r.parse("cbc:Name", :String) { c.name = it }
+            end
+          end
+        end
+      end
+    end
+  end
+end