zugpferd 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 985b4ac96323c6efebddb2908c4346a25444370b4b930f052d79056586553695
-  data.tar.gz: 80bbf8c1df7fd5ce7cc7357b1bd197b6c75926eea07354ae8ba65976af60885a
+  metadata.gz: 837410c3386f0fb24e0c903378bad0e4d797e24867b2a3b15b7fdc6d23f1edb3
+  data.tar.gz: e5a4808ba918693dcd393212064c3e6590038aa61406fcd0fccf37e3a91794d0
 SHA512:
-  metadata.gz: 28d68c38b89914a8a9d3edd29e073cc1d40790fdd47a8be96d698daaf55cffff9c9b5c146a9720884644a3cab473fc6c6d996c3601819be27961e93cd75335fe
-  data.tar.gz: '03648cd41bd7b8759d7159c1d9d9ba2d649d1d93721d6b11557b6fa060ebbb045cecaffc71b62047fe903b6f4c8b5ff6114a650de72136d37a8210ca5b2a0583'
+  metadata.gz: 1f0fcf101222d3f841c8d1ea2601159509deafcc1c8344a04a70d4b63049d32dd78c180b4e9061f768f65b0675adfdc1393dbfbde9f40ef2efafdd37447e5478
+  data.tar.gz: 9bcf99a1530b14c1540551eab5534be30ffe6c6f1c1bf666f7875f2e7f442f0b929ebc08ff6351b477685520fe724dd7419292f2fce5f5a508a29b3b22cb162d

data/lib/zugpferd/cii/mapping.rb

@@ -41,6 +41,7 @@ module Zugpferd
       INVOICE_SETTLEMENT = {
         currency_code:  "#{SETTLEMENT}/ram:InvoiceCurrencyCode",
         buyer_reference: "#{AGREEMENT}/ram:BuyerReference",
+        purchase_order_reference: "#{AGREEMENT}/ram:BuyerOrderReferencedDocument/ram:IssuerAssignedID",
       }.freeze
 
       # Seller (BG-4)
@@ -93,6 +94,7 @@ module Zugpferd
 
       # TaxTotal (BG-23)
       TAX_SUBTOTAL = "ram:ApplicableTradeTax"
+      TAX_FALLBACK_CURRENCY = "ram:InvoiceCurrencyCode"
       TAX = {
         taxable_amount:        "ram:BasisAmount",
         tax_amount:            "ram:CalculatedAmount",
@@ -139,6 +141,13 @@ module Zugpferd
         line_extension_amount: "ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:LineTotalAmount",
       }.freeze
 
+      # Invoice line period (BG-26)
+      LINE_PERIOD = "ram:SpecifiedLineTradeSettlement/ram:BillingSpecifiedPeriod"
+      LINE_PERIOD_FIELDS = {
+        start_date: "ram:StartDateTime/udt:DateTimeString",
+        end_date:   "ram:EndDateTime/udt:DateTimeString",
+      }.freeze
+
       # Item (BG-31)
       ITEM = "ram:SpecifiedTradeProduct"
       ITEM_FIELDS = {

data/lib/zugpferd/cii/reader.rb

@@ -12,6 +12,9 @@ module Zugpferd
     class Reader
       include Mapping
 
+      # Raised when BT-110 is missing and the VAT breakdown (BG-23) does not sum to 0.
+      class MissingTaxTotalError < Zugpferd::Error; end
+
       TYPE_CODE_MAP = {
         "381" => Model::CreditNote,
         "384" => Model::CorrectedInvoice,
@@ -25,6 +28,7 @@ module Zugpferd
       # @param xml_string [String] valid CII D16B XML
       # @return [Model::BillingDocument]
       # @raise [Nokogiri::XML::SyntaxError] if the XML is malformed
+      # @raise [MissingTaxTotalError] if BT-110 is missing and the VAT breakdown does not sum to 0
       def read(xml_string)
         doc = Nokogiri::XML(xml_string) { |config| config.strict }
         root = doc.root
@@ -50,6 +54,7 @@ module Zugpferd
           type_code: text(root, INVOICE[:type_code]),
           currency_code: text(root, INVOICE_SETTLEMENT[:currency_code]),
           buyer_reference: text(root, INVOICE_SETTLEMENT[:buyer_reference]),
+          purchase_order_reference: text(root, INVOICE_SETTLEMENT[:purchase_order_reference]),
           customization_id: text(root, INVOICE[:customization_id]),
           profile_id: text(root, INVOICE[:profile_id]),
           note: text(root, INVOICE[:note]),
@@ -129,14 +134,9 @@ module Zugpferd
 
         totals_node = settlement_node.at_xpath(MONETARY_TOTAL, NS)
         tax_total_node = totals_node&.at_xpath(TOTALS[:tax_total_amount], NS)
-        currency = tax_total_node&.[]("currencyID")
-
-        breakdown = Model::TaxBreakdown.new(
-          tax_amount: tax_total_node&.text,
-          currency_code: currency,
-        )
+        currency = tax_total_node ? tax_total_node["currencyID"] : text(settlement_node, TAX_FALLBACK_CURRENCY)
 
-        breakdown.subtotals = settlement_node.xpath(TAX_SUBTOTAL, NS).map do |sub|
+        subtotals = settlement_node.xpath(TAX_SUBTOTAL, NS).map do |sub|
           Model::TaxSubtotal.new(
             taxable_amount: text(sub, TAX[:taxable_amount]),
             tax_amount: text(sub, TAX[:tax_amount]),
@@ -148,9 +148,25 @@ module Zugpferd
           )
         end
 
+        breakdown = Model::TaxBreakdown.new(
+          tax_amount: tax_total_node ? tax_total_node.text : zero_tax_total(subtotals),
+          currency_code: currency,
+        )
+        breakdown.subtotals = subtotals
         breakdown
       end
 
+      # BR-CO-15 lets CII omit BT-110 on invoices without VAT. A breakdown
+      # that shows VAT contradicts that, even where the Schematron passes it.
+      def zero_tax_total(subtotals)
+        sum = subtotals.sum(BigDecimal("0"), &:tax_amount)
+        return sum if subtotals.any? && sum.zero?
+
+        raise MissingTaxTotalError,
+              "Invoice total VAT amount (BT-110) is missing and the VAT breakdown (BG-23) " \
+              "#{subtotals.empty? ? "is empty" : "sums to #{sum.to_s("F")}"}"
+      end
+
       def build_monetary_totals(node)
         return nil unless node
 
@@ -170,6 +186,7 @@ module Zugpferd
         item_node = node.at_xpath(ITEM, NS)
         price_node = node.at_xpath(PRICE, NS)
         tax_node = node.at_xpath(ITEM_TAX, NS)
+        period_node = node.at_xpath(LINE_PERIOD, NS)
 
         Model::LineItem.new(
           id: text(node, LINE[:id]),
@@ -177,6 +194,8 @@ module Zugpferd
           unit_code: node.at_xpath(LINE[:unit_code], NS)&.text,
           line_extension_amount: text(node, LINE[:line_extension_amount]),
           note: text(node, LINE[:note]),
+          period_start_date: parse_cii_date(period_node ? text(period_node, LINE_PERIOD_FIELDS[:start_date]) : nil),
+          period_end_date: parse_cii_date(period_node ? text(period_node, LINE_PERIOD_FIELDS[:end_date]) : nil),
           item: build_item(item_node, tax_node),
           price: build_price(price_node),
         )

data/lib/zugpferd/cii/writer.rb

@@ -76,6 +76,13 @@ module Zugpferd
           xml["ram"].BuyerReference doc.buyer_reference if doc.buyer_reference
           build_party(xml, "SellerTradeParty", doc.seller) if doc.seller
           build_party(xml, "BuyerTradeParty", doc.buyer) if doc.buyer
+          build_buyer_order_reference(xml, doc) if doc.purchase_order_reference
+        end
+      end
+
+      def build_buyer_order_reference(xml, doc)
+        xml["ram"].BuyerOrderReferencedDocument do
+          xml["ram"].IssuerAssignedID doc.purchase_order_reference
         end
       end
 
@@ -314,6 +321,8 @@ module Zugpferd
               end
             end
 
+            build_line_period(xml, line) if line.period_start_date || line.period_end_date
+
             xml["ram"].SpecifiedTradeSettlementLineMonetarySummation do
               xml["ram"].LineTotalAmount format_decimal(line.line_extension_amount)
             end
@@ -321,6 +330,21 @@ module Zugpferd
         end
       end
 
+      def build_line_period(xml, line)
+        xml["ram"].BillingSpecifiedPeriod do
+          if line.period_start_date
+            xml["ram"].StartDateTime do
+              xml["udt"].DateTimeString(format_cii_date(line.period_start_date), format: "102")
+            end
+          end
+          if line.period_end_date
+            xml["ram"].EndDateTime do
+              xml["udt"].DateTimeString(format_cii_date(line.period_end_date), format: "102")
+            end
+          end
+        end
+      end
+
       def build_item(xml, item)
         xml["ram"].SpecifiedTradeProduct do
           xml["ram"].SellerAssignedID item.sellers_identifier if item.sellers_identifier

data/lib/zugpferd/model/billing_document.rb

@@ -22,6 +22,7 @@ module Zugpferd
       # @return [Date, nil] BT-73 Invoicing period start date
       # @return [Date, nil] BT-74 Invoicing period end date
       # @return [String, nil] BT-10 Buyer reference
+      # @return [String, nil] BT-13 Purchase order reference
       # @return [String, nil] BT-24 Specification identifier
       # @return [String, nil] BT-23 Business process type
       # @return [String, nil] BT-22 Invoice note
@@ -35,7 +36,8 @@ module Zugpferd
       attr_accessor :number, :issue_date, :due_date, :type_code,
                     :currency_code, :delivery_date,
                     :invoicing_period_start_date, :invoicing_period_end_date,
-                    :buyer_reference, :customization_id, :profile_id, :note, :seller, :buyer,
+                    :buyer_reference, :purchase_order_reference,
+                    :customization_id, :profile_id, :note, :seller, :buyer,
                     :line_items, :tax_breakdown, :monetary_totals,
                     :payment_instructions, :allowance_charges
 

data/lib/zugpferd/model/line_item.rb

@@ -9,10 +9,13 @@ module Zugpferd
       # @return [String] BT-130 Unit of measure code
       # @return [BigDecimal] BT-131 Line extension amount
       # @return [String, nil] BT-127 Invoice line note
+      # @return [Date, nil] BT-134 Invoice line period start date
+      # @return [Date, nil] BT-135 Invoice line period end date
       # @return [Item, nil] BG-31 Item information
       # @return [Price, nil] BG-29 Price details
       attr_accessor :id, :invoiced_quantity, :unit_code,
-                    :line_extension_amount, :note, :item, :price
+                    :line_extension_amount, :note, :period_start_date,
+                    :period_end_date, :item, :price
 
       # @param id [String] BT-126 Line identifier
       # @param invoiced_quantity [String, BigDecimal] BT-129 Quantity

data/lib/zugpferd/ubl/mapping.rb

@@ -37,6 +37,9 @@ module Zugpferd
         end_date:   "cbc:EndDate",
       }.freeze
 
+      # Purchase order reference (BT-13)
+      ORDER_REFERENCE = "cac:OrderReference/cbc:ID"
+
       # Seller (BG-4)
       SELLER = "cac:AccountingSupplierParty/cac:Party"
       # Buyer (BG-7)
@@ -132,6 +135,13 @@ module Zugpferd
         note:                  "cbc:Note",
       }.freeze
 
+      # Invoice line period (BG-26)
+      LINE_PERIOD = "cac:InvoicePeriod"
+      LINE_PERIOD_FIELDS = {
+        start_date: "cbc:StartDate",
+        end_date:   "cbc:EndDate",
+      }.freeze
+
       # Item (BG-31)
       ITEM = "cac:Item"
       ITEM_FIELDS = {

data/lib/zugpferd/ubl/reader.rb

@@ -46,6 +46,7 @@ module Zugpferd
           type_code: text(root, type_code_element),
           currency_code: text(root, INVOICE[:currency_code]),
           buyer_reference: text(root, INVOICE[:buyer_reference]),
+          purchase_order_reference: text(root, ORDER_REFERENCE),
           customization_id: text(root, INVOICE[:customization_id]),
           profile_id: text(root, INVOICE[:profile_id]),
           note: text(root, INVOICE[:note]),
@@ -168,6 +169,7 @@ module Zugpferd
       def build_line_item(node)
         item_node = node.at_xpath(ITEM, @ns)
         price_node = node.at_xpath(PRICE, @ns)
+        period_node = node.at_xpath(LINE_PERIOD, @ns)
 
         quantity_element = @credit_note ? "cbc:CreditedQuantity" : LINE[:invoiced_quantity]
         unit_code_element = @credit_note ? "cbc:CreditedQuantity/@unitCode" : LINE[:unit_code]
@@ -178,6 +180,8 @@ module Zugpferd
           unit_code: node.at_xpath(unit_code_element, @ns)&.text,
           line_extension_amount: text(node, LINE[:line_extension_amount]),
           note: text(node, LINE[:note]),
+          period_start_date: period_node ? parse_date(text(period_node, LINE_PERIOD_FIELDS[:start_date])) : nil,
+          period_end_date: period_node ? parse_date(text(period_node, LINE_PERIOD_FIELDS[:end_date])) : nil,
           item: build_item(item_node),
           price: build_price(price_node),
         )

data/lib/zugpferd/ubl/writer.rb

@@ -51,6 +51,7 @@ module Zugpferd
         xml["cbc"].DocumentCurrencyCode doc.currency_code
         xml["cbc"].BuyerReference doc.buyer_reference if doc.buyer_reference
         build_invoice_period(xml, doc) if doc.invoicing_period_start_date || doc.invoicing_period_end_date
+        build_order_reference(xml, doc) if doc.purchase_order_reference
 
         build_supplier(xml, doc.seller, doc.payment_instructions) if doc.seller
         build_customer(xml, doc.buyer) if doc.buyer
@@ -149,6 +150,12 @@ module Zugpferd
         end
       end
 
+      def build_order_reference(xml, doc)
+        xml["cac"].OrderReference do
+          xml["cbc"].ID doc.purchase_order_reference
+        end
+      end
+
       def build_delivery(xml, doc)
         xml["cac"].Delivery do
           xml["cbc"].ActualDeliveryDate doc.delivery_date.to_s
@@ -274,11 +281,19 @@ module Zugpferd
                           unitCode: line.unit_code)
           xml["cbc"].LineExtensionAmount(format_decimal(line.line_extension_amount),
                                          currencyID: currency_code)
+          build_line_period(xml, line) if line.period_start_date || line.period_end_date
           build_item(xml, line.item) if line.item
           build_price(xml, line.price, currency_code) if line.price
         end
       end
 
+      def build_line_period(xml, line)
+        xml["cac"].InvoicePeriod do
+          xml["cbc"].StartDate line.period_start_date.to_s if line.period_start_date
+          xml["cbc"].EndDate line.period_end_date.to_s if line.period_end_date
+        end
+      end
+
       def build_item(xml, item)
         xml["cac"].Item do
           xml["cbc"].Description item.description if item.description

data/lib/zugpferd.rb

@@ -1,3 +1,7 @@
+module Zugpferd
+  class Error < StandardError; end
+end
+
 require_relative "zugpferd/model/billing_document"
 require_relative "zugpferd/model/invoice"
 require_relative "zugpferd/model/credit_note"
@@ -20,7 +24,3 @@ require_relative "zugpferd/ubl/reader"
 require_relative "zugpferd/ubl/writer"
 require_relative "zugpferd/cii/reader"
 require_relative "zugpferd/cii/writer"
-
-module Zugpferd
-  class Error < StandardError; end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zugpferd
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Alexander Zeitler
@@ -27,14 +27,14 @@ dependencies:
   name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency