zugpferd 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb023a7256c9cf26f6688283b6204bbccc0f46f2a6c8f0bb8082c2b1db277151
-  data.tar.gz: 00d5dc92b2d38a3744af4388017629d83b74b28241014448c75b684fb8de7c5c
+  metadata.gz: 05fc84848e61ccfc901d5a22ab7d35ff8032531d543dcd85883073a7d0bd2c43
+  data.tar.gz: cd37bf998f94dd2be0f9adac19761976145b49f7aace4d22d5af2812df173e1a
 SHA512:
-  metadata.gz: 0b6313dfce9be63204e9c7317be9abfbd38c0a53c97e5a7960c4b4fab98421f7f5ec892af59457c4babcdc0ec811de4159f926ae8f443df5f1d417055eb3847f
-  data.tar.gz: 449b38ee768cea1a0a5167f498c5b80a6bc3604bfe92967cabed4e51d230fe56b307dd88c5313886cb2b67d6b053932bf5f8e575b18385b781fd323f74d10fdf
+  metadata.gz: 245cb66ea6b7b151145130747873780113acd36790a66420e23b210ddd1920082e22bd50661cadde218bf15bc1713687ddbc0b5a802bfd0245aa6b72b569fe7c
+  data.tar.gz: 72af5d37db91aaa59deee1cc9b9ec7aa70347d1dce1f87decc6f5347f5714a077d869533f4bcb23d9bb42b4b52b6db73157904c987c98144c5a888616d7f5f24

data/lib/zugpferd/cii/mapping.rb

@@ -26,6 +26,8 @@ module Zugpferd
       # Delivery (BG-13)
       DELIVERY = "#{TRANSACTION}/ram:ApplicableHeaderTradeDelivery"
       DELIVERY_DATE = "ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeString"
+      # Deliver to address (BG-15), fields as in ADDRESS
+      DELIVER_TO_ADDRESS = "ram:ShipToTradeParty/ram:PostalTradeAddress"
 
       # Settlement (contains currency, payment, tax, totals)
       SETTLEMENT = "#{TRANSACTION}/ram:ApplicableHeaderTradeSettlement"
@@ -64,6 +66,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
 

data/lib/zugpferd/cii/reader.rb

@@ -49,6 +49,7 @@ 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),
+          deliver_to_address: build_deliver_to_address(delivery),
           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]),
@@ -58,7 +59,7 @@ 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) : [],
@@ -69,7 +70,8 @@ module Zugpferd
         )
       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(
@@ -77,8 +79,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]),
         )
 
@@ -103,6 +106,11 @@ module Zugpferd
         )
       end
 
+      def build_deliver_to_address(delivery_node)
+        addr_node = delivery_node&.at_xpath(DELIVER_TO_ADDRESS, NS)
+        build_postal_address(addr_node) if addr_node
+      end
+
       def build_contact(node)
         Model::Contact.new(
           name: text(node, CONTACT_FIELDS[:name]),

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
 
@@ -150,6 +157,11 @@ module Zugpferd
 
       def build_delivery(xml, doc)
         xml["ram"].ApplicableHeaderTradeDelivery do
+          if doc.deliver_to_address
+            xml["ram"].ShipToTradeParty do
+              build_postal_address(xml, doc.deliver_to_address)
+            end
+          end
           if doc.delivery_date
             xml["ram"].ActualDeliverySupplyChainEvent do
               xml["ram"].OccurrenceDateTime do

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 [PostalAddress, nil] BG-15 Deliver to address
       # @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
@@ -35,7 +36,7 @@ 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,
+                    :currency_code, :delivery_date, :deliver_to_address,
                     :invoicing_period_start_date, :invoicing_period_end_date,
                     :buyer_reference, :purchase_order_reference,
                     :customization_id, :profile_id, :note, :seller, :buyer,

data/lib/zugpferd/model/postal_address.rb

@@ -1,14 +1,14 @@
 module Zugpferd
   module Model
-    # Postal address (BG-5 / BG-8).
+    # Postal address (BG-5 / BG-8 / BG-15).
     class PostalAddress
-      # @return [String, nil] BT-35/BT-50 Street name
-      # @return [String, nil] BT-37/BT-52 City name
-      # @return [String, nil] BT-38/BT-53 Postal zone
-      # @return [String] BT-40/BT-55 Country code
+      # @return [String, nil] BT-35/BT-50/BT-75 Street name
+      # @return [String, nil] BT-37/BT-52/BT-77 City name
+      # @return [String, nil] BT-38/BT-53/BT-78 Postal zone
+      # @return [String] BT-40/BT-55/BT-80 Country code
       attr_accessor :street_name, :city_name, :postal_zone, :country_code
 
-      # @param country_code [String] BT-40/BT-55 Country code (ISO 3166-1 alpha-2)
+      # @param country_code [String] BT-40/BT-55/BT-80 Country code (ISO 3166-1 alpha-2)
       # @param rest [Hash] additional attributes set via accessors
       def initialize(country_code:, **rest)
         @country_code = country_code

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

@@ -32,6 +32,8 @@ module Zugpferd
       # Delivery (BG-13)
       DELIVERY = "cac:Delivery"
       DELIVERY_DATE = "cbc:ActualDeliveryDate"
+      # Deliver to address (BG-15), fields as in ADDRESS
+      DELIVER_TO_ADDRESS = "cac:DeliveryLocation/cac:Address"
 
       # Invoicing period (BG-14)
       INVOICE_PERIOD = "cac:InvoicePeriod"
@@ -63,6 +65,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
 

data/lib/zugpferd/ubl/reader.rb

@@ -42,6 +42,7 @@ module Zugpferd
           issue_date: parse_date(text(root, INVOICE[:issue_date])),
           due_date: parse_date(text(root, due_date_element)),
           delivery_date: delivery_node ? parse_date(text(delivery_node, DELIVERY_DATE)) : nil,
+          deliver_to_address: build_deliver_to_address(delivery_node),
           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),
@@ -51,7 +52,7 @@ 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) },
@@ -62,7 +63,8 @@ module Zugpferd
         )
       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(
@@ -70,8 +72,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]),
         )
 
@@ -96,6 +99,11 @@ module Zugpferd
         )
       end
 
+      def build_deliver_to_address(delivery_node)
+        addr_node = delivery_node&.at_xpath(DELIVER_TO_ADDRESS, @ns)
+        build_postal_address(addr_node) if addr_node
+      end
+
       def build_contact(node)
         Model::Contact.new(
           name: text(node, CONTACT_FIELDS[:name]),

data/lib/zugpferd/ubl/writer.rb

@@ -56,7 +56,7 @@ module Zugpferd
 
         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_delivery(xml, doc) if doc.delivery_date || doc.deliver_to_address
         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) }
@@ -68,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
 
@@ -78,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 = {}
@@ -115,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
@@ -127,12 +137,16 @@ module Zugpferd
 
       def build_postal_address(xml, addr)
         xml["cac"].PostalAddress do
-          xml["cbc"].StreetName addr.street_name if addr.street_name
-          xml["cbc"].CityName addr.city_name if addr.city_name
-          xml["cbc"].PostalZone addr.postal_zone if addr.postal_zone
-          xml["cac"].Country do
-            xml["cbc"].IdentificationCode addr.country_code
-          end
+          build_address_fields(xml, addr)
+        end
+      end
+
+      def build_address_fields(xml, addr)
+        xml["cbc"].StreetName addr.street_name if addr.street_name
+        xml["cbc"].CityName addr.city_name if addr.city_name
+        xml["cbc"].PostalZone addr.postal_zone if addr.postal_zone
+        xml["cac"].Country do
+          xml["cbc"].IdentificationCode addr.country_code
         end
       end
 
@@ -168,7 +182,14 @@ module Zugpferd
 
       def build_delivery(xml, doc)
         xml["cac"].Delivery do
-          xml["cbc"].ActualDeliveryDate doc.delivery_date.to_s
+          xml["cbc"].ActualDeliveryDate doc.delivery_date.to_s if doc.delivery_date
+          if doc.deliver_to_address
+            xml["cac"].DeliveryLocation do
+              xml["cac"].Address do
+                build_address_fields(xml, doc.deliver_to_address)
+              end
+            end
+          end
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zugpferd
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Alexander Zeitler