zugpferd 0.3.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abb862a514f5dca77411e88cf1f21a3ed148192d30c3e6e661dbd9720344cae4
-  data.tar.gz: 7effd9d5bed0d5a9e6d054acbad9602846f7c334a98ee32ec65037c62b4aee95
+  metadata.gz: 9a9f2f51374e01f8940bd39a69c088477348c26d77d69adca3f1737445f99c9d
+  data.tar.gz: 8a541edb6c9b0aa78d87d715e8a04271ef0a8ea03d9d49463b4d0f45f72ce499
 SHA512:
-  metadata.gz: 111a8f3af318dba1cd0d4f5f208ed5a35fce92d59eda7c5660098cc83d10d61d8229ad97a400fba46160bb4bb7df80fe23820c2a35d92f81e563b3b2e1bc36a3
-  data.tar.gz: 16c0f30986919d7365f321ef18c3f3cf820152d6d0abc3943a3889e7485733ffc77d61a392755d48859011e79bac8bd30e3b4e77e65ed0f2fca2c9f866b57065
+  metadata.gz: 5f3051364d36fc4b5fddb4ff6e8369f37aca520f88aaa20784443176706bbfa688da434f4f3ba28fea8953460a092914b7fa0ca4380a9d07e16df5205258b7de
+  data.tar.gz: 4c40141f885ee40dd9da1e67432ba2a7a80cf5d59b2847cf4b487df4682baffc224f7b61d58b5a0b5f51aeeb684b6bf8ae501b9616e124dcaa77828761e8034a

data/lib/zugpferd/cii/mapping.rb

@@ -31,6 +31,13 @@ module Zugpferd
       SETTLEMENT = "#{TRANSACTION}/ram:ApplicableHeaderTradeSettlement"
       AGREEMENT = "#{TRANSACTION}/ram:ApplicableHeaderTradeAgreement"
 
+      # Invoicing period (BG-14)
+      BILLING_PERIOD = "ram:BillingSpecifiedPeriod"
+      BILLING_PERIOD_FIELDS = {
+        start_date: "ram:StartDateTime/udt:DateTimeString",
+        end_date:   "ram:EndDateTime/udt:DateTimeString",
+      }.freeze
+
       INVOICE_SETTLEMENT = {
         currency_code:  "#{SETTLEMENT}/ram:InvoiceCurrencyCode",
         buyer_reference: "#{AGREEMENT}/ram:BuyerReference",
@@ -132,6 +139,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

@@ -36,6 +36,7 @@ module Zugpferd
       def build_invoice(root)
         settlement = root.at_xpath(SETTLEMENT, NS)
         delivery = root.at_xpath(DELIVERY, NS)
+        period = settlement&.at_xpath(BILLING_PERIOD, NS)
         type_code = text(root, INVOICE[:type_code])
         model_class = TYPE_CODE_MAP.fetch(type_code, Model::Invoice)
 
@@ -44,6 +45,8 @@ module Zugpferd
           issue_date: parse_cii_date(text(root, INVOICE[:issue_date])),
           due_date: parse_cii_date(settlement ? text(settlement, PAYMENT_TERMS_DUE_DATE) : nil),
           delivery_date: parse_cii_date(delivery ? text(delivery, DELIVERY_DATE) : nil),
+          invoicing_period_start_date: parse_cii_date(period ? text(period, BILLING_PERIOD_FIELDS[:start_date]) : nil),
+          invoicing_period_end_date: parse_cii_date(period ? text(period, BILLING_PERIOD_FIELDS[:end_date]) : nil),
           type_code: text(root, INVOICE[:type_code]),
           currency_code: text(root, INVOICE_SETTLEMENT[:currency_code]),
           buyer_reference: text(root, INVOICE_SETTLEMENT[:buyer_reference]),
@@ -167,6 +170,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]),
@@ -174,6 +178,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

@@ -173,6 +173,8 @@ module Zugpferd
             end
           end
 
+          build_billing_period(xml, doc) if doc.invoicing_period_start_date || doc.invoicing_period_end_date
+
           doc.allowance_charges.each { |ac| build_allowance_charge(xml, ac) }
 
           if doc.payment_instructions&.note || doc.due_date || doc.payment_instructions&.mandate_reference
@@ -191,6 +193,21 @@ module Zugpferd
         end
       end
 
+      def build_billing_period(xml, doc)
+        xml["ram"].BillingSpecifiedPeriod do
+          if doc.invoicing_period_start_date
+            xml["ram"].StartDateTime do
+              xml["udt"].DateTimeString(format_cii_date(doc.invoicing_period_start_date), format: "102")
+            end
+          end
+          if doc.invoicing_period_end_date
+            xml["ram"].EndDateTime do
+              xml["udt"].DateTimeString(format_cii_date(doc.invoicing_period_end_date), format: "102")
+            end
+          end
+        end
+      end
+
       def build_payment_means(xml, payment)
         xml["ram"].SpecifiedTradeSettlementPaymentMeans do
           xml["ram"].TypeCode payment.payment_means_code
@@ -297,6 +314,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
@@ -304,6 +323,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

@@ -19,6 +19,8 @@ module Zugpferd
       # @return [String] BT-3 Invoice type code
       # @return [String] BT-5 Document currency code (default: "EUR")
       # @return [Date, nil] BT-72 Actual delivery date
+      # @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-24 Specification identifier
       # @return [String, nil] BT-23 Business process type
@@ -31,8 +33,9 @@ module Zugpferd
       # @return [PaymentInstructions, nil] BG-16 Payment information
       # @return [Array<AllowanceCharge>] BG-20/BG-21 Document-level allowances and charges
       attr_accessor :number, :issue_date, :due_date, :type_code,
-                    :currency_code, :delivery_date, :buyer_reference,
-                    :customization_id, :profile_id, :note, :seller, :buyer,
+                    :currency_code, :delivery_date,
+                    :invoicing_period_start_date, :invoicing_period_end_date,
+                    :buyer_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

@@ -30,6 +30,13 @@ module Zugpferd
       DELIVERY = "cac:Delivery"
       DELIVERY_DATE = "cbc:ActualDeliveryDate"
 
+      # Invoicing period (BG-14)
+      INVOICE_PERIOD = "cac:InvoicePeriod"
+      INVOICE_PERIOD_FIELDS = {
+        start_date: "cbc:StartDate",
+        end_date:   "cbc:EndDate",
+      }.freeze
+
       # Seller (BG-4)
       SELLER = "cac:AccountingSupplierParty/cac:Party"
       # Buyer (BG-7)
@@ -125,6 +132,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

@@ -34,12 +34,15 @@ module Zugpferd
         model_class = @credit_note ? Model::CreditNote : Model::Invoice
 
         delivery_node = root.at_xpath(DELIVERY, @ns)
+        period_node = root.at_xpath(INVOICE_PERIOD, @ns)
 
         model_class.new(
           number: text(root, INVOICE[:number]),
           issue_date: parse_date(text(root, INVOICE[:issue_date])),
           due_date: parse_date(text(root, INVOICE[:due_date])),
           delivery_date: delivery_node ? parse_date(text(delivery_node, DELIVERY_DATE)) : nil,
+          invoicing_period_start_date: period_node ? parse_date(text(period_node, INVOICE_PERIOD_FIELDS[:start_date])) : nil,
+          invoicing_period_end_date: period_node ? parse_date(text(period_node, INVOICE_PERIOD_FIELDS[:end_date])) : nil,
           type_code: text(root, type_code_element),
           currency_code: text(root, INVOICE[:currency_code]),
           buyer_reference: text(root, INVOICE[:buyer_reference]),
@@ -165,6 +168,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]
@@ -175,6 +179,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

@@ -50,6 +50,7 @@ module Zugpferd
         xml["cbc"].Note doc.note if doc.note
         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_supplier(xml, doc.seller, doc.payment_instructions) if doc.seller
         build_customer(xml, doc.buyer) if doc.buyer
@@ -141,6 +142,13 @@ module Zugpferd
         end
       end
 
+      def build_invoice_period(xml, doc)
+        xml["cac"].InvoicePeriod do
+          xml["cbc"].StartDate doc.invoicing_period_start_date.to_s if doc.invoicing_period_start_date
+          xml["cbc"].EndDate doc.invoicing_period_end_date.to_s if doc.invoicing_period_end_date
+        end
+      end
+
       def build_delivery(xml, doc)
         xml["cac"].Delivery do
           xml["cbc"].ActualDeliveryDate doc.delivery_date.to_s
@@ -266,11 +274,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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zugpferd
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.5.0
 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