zugpferd 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 837410c3386f0fb24e0c903378bad0e4d797e24867b2a3b15b7fdc6d23f1edb3
-  data.tar.gz: e5a4808ba918693dcd393212064c3e6590038aa61406fcd0fccf37e3a91794d0
+  metadata.gz: 97af66296e92817aef2f4f2fbea2e0ebb7170fb3856732a552ac32210a8e085f
+  data.tar.gz: cc23dea33a361b6fcfc93a52c0928a70bea18757cb2e022dbf123b142480383a
 SHA512:
-  metadata.gz: 1f0fcf101222d3f841c8d1ea2601159509deafcc1c8344a04a70d4b63049d32dd78c180b4e9061f768f65b0675adfdc1393dbfbde9f40ef2efafdd37447e5478
-  data.tar.gz: 9bcf99a1530b14c1540551eab5534be30ffe6c6f1c1bf666f7875f2e7f442f0b929ebc08ff6351b477685520fe724dd7419292f2fce5f5a508a29b3b22cb162d
+  metadata.gz: 79479ce622f08767f6ac5d3d63b5826ca3a3eef621d768005c417600f16b308856280e270a7188f49a03b3ff25f03ec0b169861570cde588fc72005d64a96b92
+  data.tar.gz: 31d343e25f7d8c5e9d2eb459f941b5a0f67d38169e8f264f66100382e8d11ace7e5f2bfb79497d5d0dbbf6f2097965078f7b9fd2ffb0903ae1a56c3c622bdc53

data/lib/zugpferd/cii/mapping.rb

@@ -38,6 +38,13 @@ module Zugpferd
         end_date:   "ram:EndDateTime/udt:DateTimeString",
       }.freeze
 
+      # Preceding invoice reference (BG-3), relative to the settlement node
+      PRECEDING_INVOICE = "ram:InvoiceReferencedDocument"
+      PRECEDING_INVOICE_FIELDS = {
+        number:     "ram:IssuerAssignedID",
+        issue_date: "ram:FormattedIssueDateTime/qdt:DateTimeString",
+      }.freeze
+
       INVOICE_SETTLEMENT = {
         currency_code:  "#{SETTLEMENT}/ram:InvoiceCurrencyCode",
         buyer_reference: "#{AGREEMENT}/ram:BuyerReference",
@@ -57,6 +64,7 @@ module Zugpferd
         legal_registration_id: "ram:SpecifiedLegalOrganization/ram:ID",
         legal_form:            "ram:Description",
         vat_identifier:        "ram:SpecifiedTaxRegistration/ram:ID[@schemeID='VA']",
+        tax_registration_identifier: "ram:SpecifiedTaxRegistration/ram:ID[@schemeID='FC']",
         electronic_address:    "ram:URIUniversalCommunication/ram:URIID",
       }.freeze
 
@@ -166,7 +174,9 @@ module Zugpferd
       # Price (BG-29)
       PRICE = "ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice"
       PRICE_FIELDS = {
-        amount: "ram:ChargeAmount",
+        amount:                 "ram:ChargeAmount",
+        base_quantity:          "ram:BasisQuantity",
+        base_quantity_unit_code: "ram:BasisQuantity/@unitCode",
       }.freeze
     end
   end

data/lib/zugpferd/cii/reader.rb

@@ -58,17 +58,19 @@ module Zugpferd
           customization_id: text(root, INVOICE[:customization_id]),
           profile_id: text(root, INVOICE[:profile_id]),
           note: text(root, INVOICE[:note]),
-          seller: build_party(root.at_xpath(SELLER, NS)),
+          seller: build_party(root.at_xpath(SELLER, NS), seller: true),
           buyer: build_party(root.at_xpath(BUYER, NS)),
           line_items: root.xpath(INVOICE_LINE, NS).map { |n| build_line_item(n) },
           allowance_charges: settlement ? build_allowance_charges(settlement) : [],
+          preceding_invoices: settlement ? build_preceding_invoices(settlement) : [],
           tax_breakdown: build_tax_breakdown(settlement),
           monetary_totals: build_monetary_totals(settlement&.at_xpath(MONETARY_TOTAL, NS)),
           payment_instructions: build_payment_instructions(settlement),
         )
       end
 
-      def build_party(node)
+      # Seller-only terms are read only for the seller
+      def build_party(node, seller: false)
         return nil unless node
 
         party = Model::TradeParty.new(
@@ -76,8 +78,9 @@ module Zugpferd
           trading_name: text(node, PARTY[:trading_name]),
           identifier: text(node, PARTY[:identifier]),
           legal_registration_id: text(node, PARTY[:legal_registration_id]),
-          legal_form: text(node, PARTY[:legal_form]),
+          legal_form: (text(node, PARTY[:legal_form]) if seller),
           vat_identifier: text(node, PARTY[:vat_identifier]),
+          tax_registration_identifier: (text(node, PARTY[:tax_registration_identifier]) if seller),
           electronic_address: text(node, PARTY[:electronic_address]),
         )
 
@@ -218,9 +221,20 @@ module Zugpferd
 
         Model::Price.new(
           amount: text(node, PRICE_FIELDS[:amount]),
+          base_quantity: parse_decimal(text(node, PRICE_FIELDS[:base_quantity])),
+          base_quantity_unit_code: node.at_xpath(PRICE_FIELDS[:base_quantity_unit_code], NS)&.text,
         )
       end
 
+      def build_preceding_invoices(settlement_node)
+        settlement_node.xpath(PRECEDING_INVOICE, NS).map do |node|
+          Model::PrecedingInvoice.new(
+            number: text(node, PRECEDING_INVOICE_FIELDS[:number]),
+            issue_date: parse_cii_date(text(node, PRECEDING_INVOICE_FIELDS[:issue_date])),
+          )
+        end
+      end
+
       def build_allowance_charges(settlement_node)
         settlement_node.xpath(ALLOWANCE_CHARGE, NS).map do |node|
           Model::AllowanceCharge.new(

data/lib/zugpferd/cii/writer.rb

@@ -74,7 +74,7 @@ module Zugpferd
       def build_agreement(xml, doc)
         xml["ram"].ApplicableHeaderTradeAgreement do
           xml["ram"].BuyerReference doc.buyer_reference if doc.buyer_reference
-          build_party(xml, "SellerTradeParty", doc.seller) if doc.seller
+          build_party(xml, "SellerTradeParty", doc.seller, seller: true) if doc.seller
           build_party(xml, "BuyerTradeParty", doc.buyer) if doc.buyer
           build_buyer_order_reference(xml, doc) if doc.purchase_order_reference
         end
@@ -86,7 +86,8 @@ module Zugpferd
         end
       end
 
-      def build_party(xml, element_name, party)
+      # Seller-only terms are written only for the seller
+      def build_party(xml, element_name, party, seller: false)
         xml["ram"].send(element_name) do
           if party.identifier
             xml["ram"].ID party.identifier
@@ -94,7 +95,7 @@ module Zugpferd
 
           xml["ram"].Name party.name
 
-          xml["ram"].Description party.legal_form if party.legal_form
+          xml["ram"].Description party.legal_form if seller && party.legal_form
 
           if party.legal_registration_id || party.trading_name
             xml["ram"].SpecifiedLegalOrganization do
@@ -120,6 +121,12 @@ module Zugpferd
               xml["ram"].ID(party.vat_identifier, schemeID: "VA")
             end
           end
+
+          if seller && party.tax_registration_identifier
+            xml["ram"].SpecifiedTaxRegistration do
+              xml["ram"].ID(party.tax_registration_identifier, schemeID: "FC")
+            end
+          end
         end
       end
 
@@ -197,6 +204,20 @@ module Zugpferd
           end
 
           build_monetary_total(xml, doc.monetary_totals, doc.tax_breakdown) if doc.monetary_totals
+
+          # CII allows a single InvoiceReferencedDocument, so only the first BG-3 is written
+          build_preceding_invoice(xml, doc.preceding_invoices.first) if doc.preceding_invoices.any?
+        end
+      end
+
+      def build_preceding_invoice(xml, preceding)
+        xml["ram"].InvoiceReferencedDocument do
+          xml["ram"].IssuerAssignedID preceding.number
+          if preceding.issue_date
+            xml["ram"].FormattedIssueDateTime do
+              xml["qdt"].DateTimeString(format_cii_date(preceding.issue_date), format: "102")
+            end
+          end
         end
       end
 
@@ -303,6 +324,11 @@ module Zugpferd
             if line.price
               xml["ram"].NetPriceProductTradePrice do
                 xml["ram"].ChargeAmount format_decimal(line.price.amount)
+                if line.price.base_quantity
+                  attrs = {}
+                  attrs[:unitCode] = line.price.base_quantity_unit_code if line.price.base_quantity_unit_code
+                  xml["ram"].BasisQuantity(format_decimal(line.price.base_quantity), attrs)
+                end
               end
             end
           end

data/lib/zugpferd/model/billing_document.rb

@@ -19,6 +19,7 @@ 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 [Array<PrecedingInvoice>] BG-3 Preceding invoice references
       # @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
@@ -39,7 +40,7 @@ module Zugpferd
                     :buyer_reference, :purchase_order_reference,
                     :customization_id, :profile_id, :note, :seller, :buyer,
                     :line_items, :tax_breakdown, :monetary_totals,
-                    :payment_instructions, :allowance_charges
+                    :payment_instructions, :allowance_charges, :preceding_invoices
 
       # @param number [String] BT-1 Invoice number
       # @param issue_date [Date] BT-2 Issue date
@@ -54,6 +55,7 @@ module Zugpferd
         @currency_code = currency_code
         @line_items = []
         @allowance_charges = []
+        @preceding_invoices = []
         @tax_breakdown = nil
         rest.each { |k, v| public_send(:"#{k}=", v) }
       end

data/lib/zugpferd/model/payment_instructions.rb

@@ -6,7 +6,7 @@ module Zugpferd
       # @return [String] BT-81 Payment means type code
       # @return [String, nil] BT-83 Remittance information
       # @return [String, nil] BT-84 Payment account identifier (IBAN)
-      # @return [String, nil] BT-82 Payment terms note
+      # @return [String, nil] BT-20 Payment terms
       # @return [String, nil] BT-87 Payment card primary account number
       # @return [String, nil] BT-88 Payment card holder name
       # @return [String, nil] Card network ID (UBL-only, required in CardAccount)

data/lib/zugpferd/model/preceding_invoice.rb

@@ -0,0 +1,17 @@
+module Zugpferd
+  module Model
+    # Reference to a preceding invoice (BG-3).
+    class PrecedingInvoice
+      # @return [String] BT-25 Preceding invoice number
+      # @return [Date, nil] BT-26 Preceding invoice issue date
+      attr_accessor :number, :issue_date
+
+      # @param number [String] BT-25 Preceding invoice number
+      # @param rest [Hash] additional attributes set via accessors
+      def initialize(number:, **rest)
+        @number = number
+        rest.each { |k, v| public_send(:"#{k}=", v) }
+      end
+    end
+  end
+end

data/lib/zugpferd/model/price.rb

@@ -6,7 +6,8 @@ module Zugpferd
     class Price
       # @return [BigDecimal] BT-146 Item net price
       # @return [BigDecimal, nil] BT-149 Item price base quantity
-      attr_accessor :amount, :base_quantity
+      # @return [String, nil] BT-150 Item price base quantity unit of measure code
+      attr_accessor :amount, :base_quantity, :base_quantity_unit_code
 
       # @param amount [String, BigDecimal] BT-146 Item net price
       # @param rest [Hash] additional attributes set via accessors

data/lib/zugpferd/model/trade_party.rb

@@ -10,14 +10,16 @@ module Zugpferd
       # @return [String, nil] BT-28/BT-45 Trading name
       # @return [String, nil] BT-29/BT-46 Party identifier
       # @return [String, nil] BT-30/BT-47 Legal registration identifier
-      # @return [String, nil] BT-33 Company legal form
+      # @return [String, nil] BT-33 Company legal form (seller only)
       # @return [String, nil] BT-31/BT-48 VAT identifier
+      # @return [String, nil] BT-32 Seller tax registration identifier (seller only)
       # @return [String, nil] BT-34/BT-49 Electronic address
       # @return [String, nil] BT-34-1/BT-49-1 Electronic address scheme
       # @return [PostalAddress, nil] BG-5/BG-8 Postal address
       # @return [Contact, nil] BG-6/BG-9 Contact information
       attr_accessor :name, :trading_name, :identifier,
                     :legal_registration_id, :legal_form, :vat_identifier,
+                    :tax_registration_identifier,
                     :electronic_address, :electronic_address_scheme,
                     :postal_address, :contact
 

data/lib/zugpferd/ubl/mapping.rb

@@ -26,6 +26,9 @@ module Zugpferd
         note:               "cbc:Note",
       }.freeze
 
+      # BT-9 in a credit note (it has no cbc:DueDate)
+      CREDIT_NOTE_DUE_DATE = "cac:PaymentMeans/cbc:PaymentDueDate"
+
       # Delivery (BG-13)
       DELIVERY = "cac:Delivery"
       DELIVERY_DATE = "cbc:ActualDeliveryDate"
@@ -40,6 +43,13 @@ module Zugpferd
       # Purchase order reference (BT-13)
       ORDER_REFERENCE = "cac:OrderReference/cbc:ID"
 
+      # Preceding invoice reference (BG-3)
+      PRECEDING_INVOICE = "cac:BillingReference/cac:InvoiceDocumentReference"
+      PRECEDING_INVOICE_FIELDS = {
+        number:     "cbc:ID",
+        issue_date: "cbc:IssueDate",
+      }.freeze
+
       # Seller (BG-4)
       SELLER = "cac:AccountingSupplierParty/cac:Party"
       # Buyer (BG-7)
@@ -53,6 +63,7 @@ module Zugpferd
         legal_registration_id:   "cac:PartyLegalEntity/cbc:CompanyID",
         legal_form:              "cac:PartyLegalEntity/cbc:CompanyLegalForm",
         vat_identifier:          "cac:PartyTaxScheme[cac:TaxScheme/cbc:ID='VAT']/cbc:CompanyID",
+        tax_registration_identifier: "cac:PartyTaxScheme[cac:TaxScheme/cbc:ID!='VAT']/cbc:CompanyID",
         electronic_address:      "cbc:EndpointID",
       }.freeze
 
@@ -155,7 +166,9 @@ module Zugpferd
       # Price (BG-29)
       PRICE = "cac:Price"
       PRICE_FIELDS = {
-        amount: "cbc:PriceAmount",
+        amount:                 "cbc:PriceAmount",
+        base_quantity:          "cbc:BaseQuantity",
+        base_quantity_unit_code: "cbc:BaseQuantity/@unitCode",
       }.freeze
     end
   end

data/lib/zugpferd/ubl/reader.rb

@@ -30,6 +30,7 @@ module Zugpferd
       def build_invoice(root)
         type_code_element = @credit_note ? "cbc:CreditNoteTypeCode" : INVOICE[:type_code]
         line_element = @credit_note ? "cac:CreditNoteLine" : INVOICE_LINE
+        due_date_element = @credit_note ? CREDIT_NOTE_DUE_DATE : INVOICE[:due_date]
 
         model_class = @credit_note ? Model::CreditNote : Model::Invoice
 
@@ -39,7 +40,7 @@ module Zugpferd
         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])),
+          due_date: parse_date(text(root, due_date_element)),
           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,
@@ -50,17 +51,19 @@ module Zugpferd
           customization_id: text(root, INVOICE[:customization_id]),
           profile_id: text(root, INVOICE[:profile_id]),
           note: text(root, INVOICE[:note]),
-          seller: build_party(root.at_xpath(SELLER, @ns)),
+          seller: build_party(root.at_xpath(SELLER, @ns), seller: true),
           buyer: build_party(root.at_xpath(BUYER, @ns)),
           line_items: root.xpath(line_element, @ns).map { |n| build_line_item(n) },
           allowance_charges: root.xpath(ALLOWANCE_CHARGE, @ns).map { |n| build_allowance_charge(n) },
+          preceding_invoices: root.xpath(PRECEDING_INVOICE, @ns).map { |n| build_preceding_invoice(n) },
           tax_breakdown: build_tax_breakdown(root.at_xpath(TAX_TOTAL, @ns)),
           monetary_totals: build_monetary_totals(root.at_xpath(MONETARY_TOTAL, @ns)),
           payment_instructions: build_payment_instructions(root),
         )
       end
 
-      def build_party(node)
+      # Seller-only terms are read only for the seller
+      def build_party(node, seller: false)
         return nil unless node
 
         party = Model::TradeParty.new(
@@ -68,8 +71,9 @@ module Zugpferd
           trading_name: text(node, PARTY[:trading_name]),
           identifier: text(node, PARTY[:identifier]),
           legal_registration_id: text(node, PARTY[:legal_registration_id]),
-          legal_form: text(node, PARTY[:legal_form]),
+          legal_form: (text(node, PARTY[:legal_form]) if seller),
           vat_identifier: text(node, PARTY[:vat_identifier]),
+          tax_registration_identifier: (text(node, PARTY[:tax_registration_identifier]) if seller),
           electronic_address: text(node, PARTY[:electronic_address]),
         )
 
@@ -204,6 +208,15 @@ module Zugpferd
 
         Model::Price.new(
           amount: text(node, PRICE_FIELDS[:amount]),
+          base_quantity: parse_decimal(text(node, PRICE_FIELDS[:base_quantity])),
+          base_quantity_unit_code: node.at_xpath(PRICE_FIELDS[:base_quantity_unit_code], @ns)&.text,
+        )
+      end
+
+      def build_preceding_invoice(node)
+        Model::PrecedingInvoice.new(
+          number: text(node, PRECEDING_INVOICE_FIELDS[:number]),
+          issue_date: parse_date(text(node, PRECEDING_INVOICE_FIELDS[:issue_date])),
         )
       end
 

data/lib/zugpferd/ubl/writer.rb

@@ -41,7 +41,7 @@ module Zugpferd
         xml["cbc"].ProfileID doc.profile_id if doc.profile_id
         xml["cbc"].ID doc.number
         xml["cbc"].IssueDate doc.issue_date.to_s
-        xml["cbc"].DueDate doc.due_date.to_s if doc.due_date
+        xml["cbc"].DueDate doc.due_date.to_s if doc.due_date && !@credit_note
         if @credit_note
           xml["cbc"].CreditNoteTypeCode doc.type_code
         else
@@ -52,11 +52,12 @@ module Zugpferd
         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
+        doc.preceding_invoices.each { |pi| build_preceding_invoice(xml, pi) }
 
         build_supplier(xml, doc.seller, doc.payment_instructions) if doc.seller
         build_customer(xml, doc.buyer) if doc.buyer
         build_delivery(xml, doc) if doc.delivery_date
-        build_payment_means(xml, doc.payment_instructions) if doc.payment_instructions
+        build_payment_means(xml, doc.payment_instructions, doc.due_date) if doc.payment_instructions
         build_payment_terms(xml, doc.payment_instructions) if doc.payment_instructions&.note
         doc.allowance_charges.each { |ac| build_allowance_charge(xml, ac, doc.currency_code) }
         build_tax_total(xml, doc.tax_breakdown) if doc.tax_breakdown
@@ -67,7 +68,7 @@ module Zugpferd
       def build_supplier(xml, party, payment_instructions = nil)
         xml["cac"].AccountingSupplierParty do
           build_party(xml, party,
-            creditor_reference_id: payment_instructions&.creditor_reference_id)
+            creditor_reference_id: payment_instructions&.creditor_reference_id, seller: true)
         end
       end
 
@@ -77,7 +78,8 @@ module Zugpferd
         end
       end
 
-      def build_party(xml, party, creditor_reference_id: nil)
+      # Seller-only terms are written only for the seller
+      def build_party(xml, party, creditor_reference_id: nil, seller: false)
         xml["cac"].Party do
           if party.electronic_address
             attrs = {}
@@ -114,10 +116,19 @@ module Zugpferd
             end
           end
 
+          if seller && party.tax_registration_identifier
+            xml["cac"].PartyTaxScheme do
+              xml["cbc"].CompanyID party.tax_registration_identifier
+              xml["cac"].TaxScheme do
+                xml["cbc"].ID "FC"
+              end
+            end
+          end
+
           xml["cac"].PartyLegalEntity do
             xml["cbc"].RegistrationName party.name
             xml["cbc"].CompanyID party.legal_registration_id if party.legal_registration_id
-            xml["cbc"].CompanyLegalForm party.legal_form if party.legal_form
+            xml["cbc"].CompanyLegalForm party.legal_form if seller && party.legal_form
           end
 
           build_contact(xml, party.contact) if party.contact
@@ -156,15 +167,26 @@ module Zugpferd
         end
       end
 
+      def build_preceding_invoice(xml, preceding)
+        xml["cac"].BillingReference do
+          xml["cac"].InvoiceDocumentReference do
+            xml["cbc"].ID preceding.number
+            xml["cbc"].IssueDate preceding.issue_date.to_s if preceding.issue_date
+          end
+        end
+      end
+
       def build_delivery(xml, doc)
         xml["cac"].Delivery do
           xml["cbc"].ActualDeliveryDate doc.delivery_date.to_s
         end
       end
 
-      def build_payment_means(xml, payment)
+      # A credit note has no cbc:DueDate, BT-9 is written as PaymentDueDate instead.
+      def build_payment_means(xml, payment, due_date = nil)
         xml["cac"].PaymentMeans do
           xml["cbc"].PaymentMeansCode payment.payment_means_code
+          xml["cbc"].PaymentDueDate due_date.to_s if @credit_note && due_date
           xml["cbc"].PaymentID payment.payment_id if payment.payment_id
           if payment.card_account_id
             xml["cac"].CardAccount do
@@ -318,6 +340,11 @@ module Zugpferd
       def build_price(xml, price, currency_code)
         xml["cac"].Price do
           xml["cbc"].PriceAmount(format_decimal(price.amount), currencyID: currency_code)
+          if price.base_quantity
+            attrs = {}
+            attrs[:unitCode] = price.base_quantity_unit_code if price.base_quantity_unit_code
+            xml["cbc"].BaseQuantity(format_decimal(price.base_quantity), attrs)
+          end
         end
       end
 

data/lib/zugpferd.rb

@@ -20,6 +20,7 @@ require_relative "zugpferd/model/tax_breakdown"
 require_relative "zugpferd/model/tax_subtotal"
 require_relative "zugpferd/model/payment_instructions"
 require_relative "zugpferd/model/allowance_charge"
+require_relative "zugpferd/model/preceding_invoice"
 require_relative "zugpferd/ubl/reader"
 require_relative "zugpferd/ubl/writer"
 require_relative "zugpferd/cii/reader"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zugpferd
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Alexander Zeitler
@@ -90,6 +90,7 @@ files:
 - lib/zugpferd/model/partial_invoice.rb
 - lib/zugpferd/model/payment_instructions.rb
 - lib/zugpferd/model/postal_address.rb
+- lib/zugpferd/model/preceding_invoice.rb
 - lib/zugpferd/model/prepayment_invoice.rb
 - lib/zugpferd/model/price.rb
 - lib/zugpferd/model/self_billed_invoice.rb