zugpferd 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bafe4631b8105289e0f6c6efba696b91e0502cfbf99173918dc0d57de096263
-  data.tar.gz: 3afe5b0d992a4622f3eadfabfbc1b4495ff5deca092f15eb659b5a8b4b529f23
+  metadata.gz: 132674bb432d021ca01155c3289c34abd9a0f9444242e74b79871aaa155e5dac
+  data.tar.gz: 0e03c97fedb053a5a3fce52216c92a64bfbd5671a9bc354fb629c1eae644fc23
 SHA512:
-  metadata.gz: 8c50bedc1c561b09d28fb69c808dcc4b0e80b655e9a2c69a138229f05752ff4898ac64fd6bf144a4eb3d0cfdcfa84742576a64565097a7ae9f4e666c686fb06e
-  data.tar.gz: ad2b0b0bc923f4debd510f40a9e1b296212af4fcbff0df9af0df5c295b2608e01430c80993000257de81d8d247c30939143567d9a8efa80805f02028dd36c99e
+  metadata.gz: f9f3e87cd9e52a517724829498ed4063aba54b97c9ea78c5e305e99d6ae9a6cd5a7f393836e2c73aa4a1369dbd35b32ff5a7ad053723b616282f207f62447d30
+  data.tar.gz: bfa2cd8c8ef42b94f89b21c8482418284682217be802312a659bc4672413cb1a8032e40b163ad874caae5a6da63410f201ee5467ec66a29bafc2011b101ea24d

data/lib/zugpferd/cii/reader.rb

@@ -5,17 +5,25 @@ require_relative "mapping"
 
 module Zugpferd
   module CII
-    # Reads UN/CEFACT CII CrossIndustryInvoice XML into {Model::Invoice}.
+    # Reads UN/CEFACT CII CrossIndustryInvoice XML into the appropriate model class.
     #
     # @example
-    #   invoice = Zugpferd::CII::Reader.new.read(File.read("invoice.xml"))
+    #   doc = Zugpferd::CII::Reader.new.read(File.read("invoice.xml"))
     class Reader
       include Mapping
 
+      TYPE_CODE_MAP = {
+        "381" => Model::CreditNote,
+        "384" => Model::CorrectedInvoice,
+        "389" => Model::SelfBilledInvoice,
+        "326" => Model::PartialInvoice,
+        "386" => Model::PrepaymentInvoice,
+      }.freeze
+
       # Parses a CII CrossIndustryInvoice XML string.
       #
       # @param xml_string [String] valid CII D16B XML
-      # @return [Model::Invoice]
+      # @return [Model::BillingDocument]
       # @raise [Nokogiri::XML::SyntaxError] if the XML is malformed
       def read(xml_string)
         doc = Nokogiri::XML(xml_string) { |config| config.strict }
@@ -27,7 +35,10 @@ module Zugpferd
 
       def build_invoice(root)
         settlement = root.at_xpath(SETTLEMENT, NS)
-        Model::Invoice.new(
+        type_code = text(root, INVOICE[:type_code])
+        model_class = TYPE_CODE_MAP.fetch(type_code, Model::Invoice)
+
+        model_class.new(
           number: text(root, INVOICE[:number]),
           issue_date: parse_cii_date(text(root, INVOICE[:issue_date])),
           due_date: parse_cii_date(settlement ? text(settlement, PAYMENT_TERMS_DUE_DATE) : nil),

data/lib/zugpferd/cii/writer.rb

@@ -3,18 +3,18 @@ require_relative "mapping"
 
 module Zugpferd
   module CII
-    # Writes {Model::Invoice} to UN/CEFACT CII CrossIndustryInvoice XML.
+    # Writes a billing document to UN/CEFACT CII CrossIndustryInvoice XML.
     #
     # @example
-    #   xml = Zugpferd::CII::Writer.new.write(invoice)
+    #   xml = Zugpferd::CII::Writer.new.write(document)
     class Writer
       include Mapping
 
-      # Serializes an invoice to CII D16B XML.
+      # Serializes a billing document to CII D16B XML.
       #
-      # @param invoice [Model::Invoice] the invoice to serialize
+      # @param document [Model::BillingDocument] the document to serialize
       # @return [String] UTF-8 encoded XML string
-      def write(invoice)
+      def write(document)
         builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
           xml["rsm"].CrossIndustryInvoice(
             "xmlns:rsm" => NS["rsm"],
@@ -22,9 +22,9 @@ module Zugpferd
             "xmlns:qdt" => NS["qdt"],
             "xmlns:udt" => NS["udt"]
           ) do
-            build_document_context(xml, invoice)
-            build_exchanged_document(xml, invoice)
-            build_transaction(xml, invoice)
+            build_document_context(xml, document)
+            build_exchanged_document(xml, document)
+            build_transaction(xml, document)
           end
         end
         builder.to_xml
@@ -32,50 +32,50 @@ module Zugpferd
 
       private
 
-      def build_document_context(xml, inv)
+      def build_document_context(xml, doc)
         xml["rsm"].ExchangedDocumentContext do
-          if inv.profile_id
+          if doc.profile_id
             xml["ram"].BusinessProcessSpecifiedDocumentContextParameter do
-              xml["ram"].ID inv.profile_id
+              xml["ram"].ID doc.profile_id
             end
           end
-          if inv.customization_id
+          if doc.customization_id
             xml["ram"].GuidelineSpecifiedDocumentContextParameter do
-              xml["ram"].ID inv.customization_id
+              xml["ram"].ID doc.customization_id
             end
           end
         end
       end
 
-      def build_exchanged_document(xml, inv)
+      def build_exchanged_document(xml, doc)
         xml["rsm"].ExchangedDocument do
-          xml["ram"].ID inv.number
-          xml["ram"].TypeCode inv.type_code
+          xml["ram"].ID doc.number
+          xml["ram"].TypeCode doc.type_code
           xml["ram"].IssueDateTime do
-            xml["udt"].DateTimeString(format_cii_date(inv.issue_date), format: "102")
+            xml["udt"].DateTimeString(format_cii_date(doc.issue_date), format: "102")
           end
-          if inv.note
+          if doc.note
             xml["ram"].IncludedNote do
-              xml["ram"].Content inv.note
+              xml["ram"].Content doc.note
             end
           end
         end
       end
 
-      def build_transaction(xml, inv)
+      def build_transaction(xml, doc)
         xml["rsm"].SupplyChainTradeTransaction do
-          inv.line_items.each { |li| build_line_item(xml, li) }
-          build_agreement(xml, inv)
+          doc.line_items.each { |li| build_line_item(xml, li) }
+          build_agreement(xml, doc)
           xml["ram"].ApplicableHeaderTradeDelivery
-          build_settlement(xml, inv)
+          build_settlement(xml, doc)
         end
       end
 
-      def build_agreement(xml, inv)
+      def build_agreement(xml, doc)
         xml["ram"].ApplicableHeaderTradeAgreement do
-          xml["ram"].BuyerReference inv.buyer_reference if inv.buyer_reference
-          build_party(xml, "SellerTradeParty", inv.seller) if inv.seller
-          build_party(xml, "BuyerTradeParty", inv.buyer) if inv.buyer
+          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
         end
       end
 
@@ -141,41 +141,41 @@ module Zugpferd
         end
       end
 
-      def build_settlement(xml, inv)
+      def build_settlement(xml, doc)
         xml["ram"].ApplicableHeaderTradeSettlement do
-          if inv.payment_instructions&.creditor_reference_id
-            xml["ram"].CreditorReferenceID inv.payment_instructions.creditor_reference_id
+          if doc.payment_instructions&.creditor_reference_id
+            xml["ram"].CreditorReferenceID doc.payment_instructions.creditor_reference_id
           end
 
-          if inv.payment_instructions&.payment_id
-            xml["ram"].PaymentReference inv.payment_instructions.payment_id
+          if doc.payment_instructions&.payment_id
+            xml["ram"].PaymentReference doc.payment_instructions.payment_id
           end
 
-          xml["ram"].InvoiceCurrencyCode inv.currency_code
+          xml["ram"].InvoiceCurrencyCode doc.currency_code
 
-          build_payment_means(xml, inv.payment_instructions) if inv.payment_instructions
+          build_payment_means(xml, doc.payment_instructions) if doc.payment_instructions
 
-          if inv.tax_breakdown
-            inv.tax_breakdown.subtotals.each do |sub|
+          if doc.tax_breakdown
+            doc.tax_breakdown.subtotals.each do |sub|
               build_tax_subtotal(xml, sub)
             end
           end
 
-          inv.allowance_charges.each { |ac| build_allowance_charge(xml, ac) }
+          doc.allowance_charges.each { |ac| build_allowance_charge(xml, ac) }
 
-          if inv.payment_instructions&.note || inv.due_date || inv.payment_instructions&.mandate_reference
+          if doc.payment_instructions&.note || doc.due_date || doc.payment_instructions&.mandate_reference
             xml["ram"].SpecifiedTradePaymentTerms do
-              xml["ram"].Description inv.payment_instructions.note if inv.payment_instructions&.note
-              if inv.due_date
+              xml["ram"].Description doc.payment_instructions.note if doc.payment_instructions&.note
+              if doc.due_date
                 xml["ram"].DueDateDateTime do
-                  xml["udt"].DateTimeString(format_cii_date(inv.due_date), format: "102")
+                  xml["udt"].DateTimeString(format_cii_date(doc.due_date), format: "102")
                 end
               end
-              xml["ram"].DirectDebitMandateID inv.payment_instructions.mandate_reference if inv.payment_instructions&.mandate_reference
+              xml["ram"].DirectDebitMandateID doc.payment_instructions.mandate_reference if doc.payment_instructions&.mandate_reference
             end
           end
 
-          build_monetary_total(xml, inv.monetary_totals, inv.tax_breakdown) if inv.monetary_totals
+          build_monetary_total(xml, doc.monetary_totals, doc.tax_breakdown) if doc.monetary_totals
         end
       end
 

data/lib/zugpferd/model/billing_document.rb

@@ -0,0 +1,56 @@
+require "bigdecimal"
+
+module Zugpferd
+  module Model
+    # Shared behaviour for all billing document types (BG-0).
+    #
+    # Each including class must define a +TYPE_CODE+ constant that serves as
+    # the default value for +type_code+.
+    #
+    # @example
+    #   class Invoice
+    #     include BillingDocument
+    #     TYPE_CODE = "380"
+    #   end
+    module BillingDocument
+      # @return [String] BT-1 Invoice number
+      # @return [Date] BT-2 Issue date
+      # @return [Date, nil] BT-9 Payment due date
+      # @return [String] BT-3 Invoice type code
+      # @return [String] BT-5 Document currency code (default: "EUR")
+      # @return [String, nil] BT-10 Buyer reference
+      # @return [String, nil] BT-24 Specification identifier
+      # @return [String, nil] BT-23 Business process type
+      # @return [String, nil] BT-22 Invoice note
+      # @return [TradeParty, nil] BG-4 Seller party
+      # @return [TradeParty, nil] BG-7 Buyer party
+      # @return [Array<LineItem>] BG-25 Invoice lines
+      # @return [TaxBreakdown, nil] BG-23 VAT breakdown
+      # @return [MonetaryTotals, nil] BG-22 Document totals
+      # @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, :buyer_reference, :customization_id,
+                    :profile_id, :note, :seller, :buyer, :line_items,
+                    :tax_breakdown, :monetary_totals, :payment_instructions,
+                    :allowance_charges
+
+      # @param number [String] BT-1 Invoice number
+      # @param issue_date [Date] BT-2 Issue date
+      # @param type_code [String] BT-3 Invoice type code (defaults to the class's TYPE_CODE)
+      # @param currency_code [String] BT-5 Document currency code
+      # @param rest [Hash] additional attributes set via accessors
+      def initialize(number:, issue_date:, type_code: self.class::TYPE_CODE,
+                     currency_code: "EUR", **rest)
+        @number = number
+        @issue_date = issue_date
+        @type_code = type_code
+        @currency_code = currency_code
+        @line_items = []
+        @allowance_charges = []
+        @tax_breakdown = nil
+        rest.each { |k, v| public_send(:"#{k}=", v) }
+      end
+    end
+  end
+end

data/lib/zugpferd/model/corrected_invoice.rb

@@ -0,0 +1,13 @@
+module Zugpferd
+  module Model
+    # Corrected Invoice (BG-0), type code 384.
+    #
+    # @example
+    #   inv = CorrectedInvoice.new(number: "C-001", issue_date: Date.today)
+    class CorrectedInvoice
+      include BillingDocument
+
+      TYPE_CODE = "384"
+    end
+  end
+end

data/lib/zugpferd/model/credit_note.rb

@@ -0,0 +1,13 @@
+module Zugpferd
+  module Model
+    # Credit Note (BG-0), type code 381.
+    #
+    # @example
+    #   cn = CreditNote.new(number: "CN-001", issue_date: Date.today)
+    class CreditNote
+      include BillingDocument
+
+      TYPE_CODE = "381"
+    end
+  end
+end

data/lib/zugpferd/model/invoice.rb

@@ -1,51 +1,14 @@
-require "bigdecimal"
-
 module Zugpferd
   module Model
-    # The root invoice document (BG-0).
+    # Commercial Invoice (BG-0), type code 380.
     #
     # @example
     #   invoice = Invoice.new(number: "INV-001", issue_date: Date.today)
     #   invoice.seller = TradeParty.new(name: "Seller GmbH")
     class Invoice
-      # @return [String] BT-1 Invoice number
-      # @return [Date] BT-2 Issue date
-      # @return [Date, nil] BT-9 Payment due date
-      # @return [String] BT-3 Invoice type code (default: "380")
-      # @return [String] BT-5 Document currency code (default: "EUR")
-      # @return [String, nil] BT-10 Buyer reference
-      # @return [String, nil] BT-24 Specification identifier
-      # @return [String, nil] BT-23 Business process type
-      # @return [String, nil] BT-22 Invoice note
-      # @return [TradeParty, nil] BG-4 Seller party
-      # @return [TradeParty, nil] BG-7 Buyer party
-      # @return [Array<LineItem>] BG-25 Invoice lines
-      # @return [TaxBreakdown, nil] BG-23 VAT breakdown
-      # @return [MonetaryTotals, nil] BG-22 Document totals
-      # @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, :buyer_reference, :customization_id,
-                    :profile_id, :note, :seller, :buyer, :line_items,
-                    :tax_breakdown, :monetary_totals, :payment_instructions,
-                    :allowance_charges
+      include BillingDocument
 
-      # @param number [String] BT-1 Invoice number
-      # @param issue_date [Date] BT-2 Issue date
-      # @param type_code [String] BT-3 Invoice type code
-      # @param currency_code [String] BT-5 Document currency code
-      # @param rest [Hash] additional attributes set via accessors
-      def initialize(number:, issue_date:, type_code: "380",
-                     currency_code: "EUR", **rest)
-        @number = number
-        @issue_date = issue_date
-        @type_code = type_code
-        @currency_code = currency_code
-        @line_items = []
-        @allowance_charges = []
-        @tax_breakdown = nil
-        rest.each { |k, v| public_send(:"#{k}=", v) }
-      end
+      TYPE_CODE = "380"
     end
   end
 end

data/lib/zugpferd/model/partial_invoice.rb

@@ -0,0 +1,13 @@
+module Zugpferd
+  module Model
+    # Partial Invoice (BG-0), type code 326.
+    #
+    # @example
+    #   inv = PartialInvoice.new(number: "P-001", issue_date: Date.today)
+    class PartialInvoice
+      include BillingDocument
+
+      TYPE_CODE = "326"
+    end
+  end
+end

data/lib/zugpferd/model/prepayment_invoice.rb

@@ -0,0 +1,13 @@
+module Zugpferd
+  module Model
+    # Prepayment Invoice (BG-0), type code 386.
+    #
+    # @example
+    #   inv = PrepaymentInvoice.new(number: "PP-001", issue_date: Date.today)
+    class PrepaymentInvoice
+      include BillingDocument
+
+      TYPE_CODE = "386"
+    end
+  end
+end

data/lib/zugpferd/model/self_billed_invoice.rb

@@ -0,0 +1,13 @@
+module Zugpferd
+  module Model
+    # Self-billed Invoice (BG-0), type code 389.
+    #
+    # @example
+    #   inv = SelfBilledInvoice.new(number: "SB-001", issue_date: Date.today)
+    class SelfBilledInvoice
+      include BillingDocument
+
+      TYPE_CODE = "389"
+    end
+  end
+end

data/lib/zugpferd/ubl/mapping.rb

@@ -7,6 +7,12 @@ module Zugpferd
         "cbc" => "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2",
       }.freeze
 
+      CN_NS = {
+        "cn" => "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2",
+        "cac" => "urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2",
+        "cbc" => "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2",
+      }.freeze
+
       # Invoice (BG-0)
       INVOICE = {
         number:             "cbc:ID",

data/lib/zugpferd/ubl/reader.rb

@@ -5,43 +5,50 @@ require_relative "mapping"
 
 module Zugpferd
   module UBL
-    # Reads UBL 2.1 Invoice XML into {Model::Invoice}.
+    # Reads UBL 2.1 Invoice or Credit Note XML into the appropriate model class.
     #
     # @example
-    #   invoice = Zugpferd::UBL::Reader.new.read(File.read("invoice.xml"))
+    #   doc = Zugpferd::UBL::Reader.new.read(File.read("invoice.xml"))
     class Reader
       include Mapping
 
-      # Parses a UBL 2.1 Invoice XML string.
+      # Parses a UBL 2.1 Invoice or Credit Note XML string.
       #
-      # @param xml_string [String] valid UBL 2.1 Invoice XML
-      # @return [Model::Invoice]
+      # @param xml_string [String] valid UBL 2.1 Invoice or Credit Note XML
+      # @return [Model::BillingDocument]
       # @raise [Nokogiri::XML::SyntaxError] if the XML is malformed
       def read(xml_string)
         doc = Nokogiri::XML(xml_string) { |config| config.strict }
         root = doc.root
+        @credit_note = root.name == "CreditNote"
+        @ns = @credit_note ? CN_NS : NS
         build_invoice(root)
       end
 
       private
 
       def build_invoice(root)
-        Model::Invoice.new(
+        type_code_element = @credit_note ? "cbc:CreditNoteTypeCode" : INVOICE[:type_code]
+        line_element = @credit_note ? "cac:CreditNoteLine" : INVOICE_LINE
+
+        model_class = @credit_note ? Model::CreditNote : Model::Invoice
+
+        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])),
-          type_code: text(root, INVOICE[:type_code]),
+          type_code: text(root, type_code_element),
           currency_code: text(root, INVOICE[:currency_code]),
           buyer_reference: text(root, INVOICE[:buyer_reference]),
           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)),
-          buyer: build_party(root.at_xpath(BUYER, NS)),
-          line_items: root.xpath(INVOICE_LINE, NS).map { |n| build_line_item(n) },
-          allowance_charges: root.xpath(ALLOWANCE_CHARGE, NS).map { |n| build_allowance_charge(n) },
-          tax_breakdown: build_tax_breakdown(root.at_xpath(TAX_TOTAL, NS)),
-          monetary_totals: build_monetary_totals(root.at_xpath(MONETARY_TOTAL, NS)),
+          seller: build_party(root.at_xpath(SELLER, @ns)),
+          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) },
+          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
@@ -59,13 +66,13 @@ module Zugpferd
           electronic_address: text(node, PARTY[:electronic_address]),
         )
 
-        endpoint = node.at_xpath(PARTY[:electronic_address], NS)
+        endpoint = node.at_xpath(PARTY[:electronic_address], @ns)
         party.electronic_address_scheme = endpoint["schemeID"] if endpoint
 
-        addr_node = node.at_xpath(POSTAL_ADDRESS, NS)
+        addr_node = node.at_xpath(POSTAL_ADDRESS, @ns)
         party.postal_address = build_postal_address(addr_node) if addr_node
 
-        contact_node = node.at_xpath(CONTACT, NS)
+        contact_node = node.at_xpath(CONTACT, @ns)
         party.contact = build_contact(contact_node) if contact_node
 
         party
@@ -89,12 +96,12 @@ module Zugpferd
       end
 
       def build_payment_instructions(root)
-        means_node = root.at_xpath(PAYMENT_MEANS, NS)
+        means_node = root.at_xpath(PAYMENT_MEANS, @ns)
         return nil unless means_node
 
         # BT-90: In UBL, creditor reference is a PartyIdentification with schemeID="SEPA" on the seller
         creditor_ref = root.at_xpath(
-          "#{SELLER}/cac:PartyIdentification/cbc:ID[@schemeID='SEPA']", NS
+          "#{SELLER}/cac:PartyIdentification/cbc:ID[@schemeID='SEPA']", @ns
         )&.text
 
         Model::PaymentInstructions.new(
@@ -114,15 +121,15 @@ module Zugpferd
       def build_tax_breakdown(node)
         return nil unless node
 
-        currency = node.at_xpath("cbc:TaxAmount/@currencyID", NS)&.text
+        currency = node.at_xpath("cbc:TaxAmount/@currencyID", @ns)&.text
 
         breakdown = Model::TaxBreakdown.new(
           tax_amount: text(node, "cbc:TaxAmount"),
           currency_code: currency,
         )
 
-        breakdown.subtotals = node.xpath(TAX_SUBTOTAL, NS).map do |sub|
-          sub_currency = sub.at_xpath("cbc:TaxableAmount/@currencyID", NS)&.text
+        breakdown.subtotals = node.xpath(TAX_SUBTOTAL, @ns).map do |sub|
+          sub_currency = sub.at_xpath("cbc:TaxableAmount/@currencyID", @ns)&.text
           Model::TaxSubtotal.new(
             taxable_amount: text(sub, TAX[:taxable_amount]),
             tax_amount: text(sub, TAX[:tax_amount]),
@@ -153,13 +160,16 @@ module Zugpferd
       end
 
       def build_line_item(node)
-        item_node = node.at_xpath(ITEM, NS)
-        price_node = node.at_xpath(PRICE, NS)
+        item_node = node.at_xpath(ITEM, @ns)
+        price_node = node.at_xpath(PRICE, @ns)
+
+        quantity_element = @credit_note ? "cbc:CreditedQuantity" : LINE[:invoiced_quantity]
+        unit_code_element = @credit_note ? "cbc:CreditedQuantity/@unitCode" : LINE[:unit_code]
 
         Model::LineItem.new(
           id: text(node, LINE[:id]),
-          invoiced_quantity: text(node, LINE[:invoiced_quantity]),
-          unit_code: node.at_xpath(LINE[:unit_code], NS)&.text,
+          invoiced_quantity: text(node, quantity_element),
+          unit_code: node.at_xpath(unit_code_element, @ns)&.text,
           line_extension_amount: text(node, LINE[:line_extension_amount]),
           note: text(node, LINE[:note]),
           item: build_item(item_node),
@@ -188,7 +198,7 @@ module Zugpferd
       end
 
       def build_allowance_charge(node)
-        currency = node.at_xpath("cbc:Amount/@currencyID", NS)&.text
+        currency = node.at_xpath("cbc:Amount/@currencyID", @ns)&.text
         Model::AllowanceCharge.new(
           charge_indicator: text(node, ALLOWANCE_CHARGE_FIELDS[:charge_indicator]) == "true",
           reason: text(node, ALLOWANCE_CHARGE_FIELDS[:reason]),
@@ -203,7 +213,7 @@ module Zugpferd
       end
 
       def text(node, xpath)
-        node.at_xpath(xpath, NS)&.text
+        node.at_xpath(xpath, @ns)&.text
       end
 
       def parse_date(str)

data/lib/zugpferd/ubl/writer.rb

@@ -3,23 +3,32 @@ require_relative "mapping"
 
 module Zugpferd
   module UBL
-    # Writes {Model::Invoice} to UBL 2.1 Invoice XML.
+    # Writes a billing document to UBL 2.1 Invoice or Credit Note XML.
     #
     # @example
-    #   xml = Zugpferd::UBL::Writer.new.write(invoice)
+    #   xml = Zugpferd::UBL::Writer.new.write(document)
     class Writer
       include Mapping
 
-      # Serializes an invoice to UBL 2.1 XML.
+      # Serializes a billing document to UBL 2.1 XML.
       #
-      # @param invoice [Model::Invoice] the invoice to serialize
+      # @param document [Model::BillingDocument] the document to serialize
       # @return [String] UTF-8 encoded XML string
-      def write(invoice)
+      def write(document)
+        @credit_note = document.type_code == "381"
         builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
-          xml.Invoice(xmlns: NS["ubl"],
-                      "xmlns:cac" => NS["cac"],
-                      "xmlns:cbc" => NS["cbc"]) do
-            build_invoice(xml, invoice)
+          if @credit_note
+            xml.CreditNote(xmlns: CN_NS["cn"],
+                           "xmlns:cac" => CN_NS["cac"],
+                           "xmlns:cbc" => CN_NS["cbc"]) do
+              build_document(xml, document)
+            end
+          else
+            xml.Invoice(xmlns: NS["ubl"],
+                        "xmlns:cac" => NS["cac"],
+                        "xmlns:cbc" => NS["cbc"]) do
+              build_document(xml, document)
+            end
           end
         end
         builder.to_xml
@@ -27,25 +36,29 @@ module Zugpferd
 
       private
 
-      def build_invoice(xml, inv)
-        xml["cbc"].CustomizationID inv.customization_id if inv.customization_id
-        xml["cbc"].ProfileID inv.profile_id if inv.profile_id
-        xml["cbc"].ID inv.number
-        xml["cbc"].IssueDate inv.issue_date.to_s
-        xml["cbc"].DueDate inv.due_date.to_s if inv.due_date
-        xml["cbc"].InvoiceTypeCode inv.type_code
-        xml["cbc"].Note inv.note if inv.note
-        xml["cbc"].DocumentCurrencyCode inv.currency_code
-        xml["cbc"].BuyerReference inv.buyer_reference if inv.buyer_reference
+      def build_document(xml, doc)
+        xml["cbc"].CustomizationID doc.customization_id if doc.customization_id
+        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
+        if @credit_note
+          xml["cbc"].CreditNoteTypeCode doc.type_code
+        else
+          xml["cbc"].InvoiceTypeCode doc.type_code
+        end
+        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_supplier(xml, inv.seller, inv.payment_instructions) if inv.seller
-        build_customer(xml, inv.buyer) if inv.buyer
-        build_payment_means(xml, inv.payment_instructions) if inv.payment_instructions
-        build_payment_terms(xml, inv.payment_instructions) if inv.payment_instructions&.note
-        inv.allowance_charges.each { |ac| build_allowance_charge(xml, ac, inv.currency_code) }
-        build_tax_total(xml, inv.tax_breakdown) if inv.tax_breakdown
-        build_monetary_total(xml, inv.monetary_totals, inv.currency_code) if inv.monetary_totals
-        inv.line_items.each { |li| build_invoice_line(xml, li, inv.currency_code) }
+        build_supplier(xml, doc.seller, doc.payment_instructions) if doc.seller
+        build_customer(xml, doc.buyer) if doc.buyer
+        build_payment_means(xml, doc.payment_instructions) 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
+        build_monetary_total(xml, doc.monetary_totals, doc.currency_code) if doc.monetary_totals
+        doc.line_items.each { |li| build_line(xml, li, doc.currency_code) }
       end
 
       def build_supplier(xml, party, payment_instructions = nil)
@@ -235,12 +248,15 @@ module Zugpferd
         end
       end
 
-      def build_invoice_line(xml, line, currency_code)
-        xml["cac"].InvoiceLine do
+      def build_line(xml, line, currency_code)
+        line_method = @credit_note ? :CreditNoteLine : :InvoiceLine
+        quantity_method = @credit_note ? :CreditedQuantity : :InvoicedQuantity
+
+        xml["cac"].send(line_method) do
           xml["cbc"].ID line.id
           xml["cbc"].Note line.note if line.note
-          xml["cbc"].InvoicedQuantity(format_decimal(line.invoiced_quantity),
-                                      unitCode: line.unit_code)
+          xml["cbc"].send(quantity_method, format_decimal(line.invoiced_quantity),
+                          unitCode: line.unit_code)
           xml["cbc"].LineExtensionAmount(format_decimal(line.line_extension_amount),
                                          currencyID: currency_code)
           build_item(xml, line.item) if line.item

data/lib/zugpferd.rb

@@ -1,4 +1,10 @@
+require_relative "zugpferd/model/billing_document"
 require_relative "zugpferd/model/invoice"
+require_relative "zugpferd/model/credit_note"
+require_relative "zugpferd/model/corrected_invoice"
+require_relative "zugpferd/model/self_billed_invoice"
+require_relative "zugpferd/model/partial_invoice"
+require_relative "zugpferd/model/prepayment_invoice"
 require_relative "zugpferd/model/trade_party"
 require_relative "zugpferd/model/postal_address"
 require_relative "zugpferd/model/contact"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zugpferd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexander Zeitler
@@ -77,14 +77,20 @@ files:
 - lib/zugpferd/cii/reader.rb
 - lib/zugpferd/cii/writer.rb
 - lib/zugpferd/model/allowance_charge.rb
+- lib/zugpferd/model/billing_document.rb
 - lib/zugpferd/model/contact.rb
+- lib/zugpferd/model/corrected_invoice.rb
+- lib/zugpferd/model/credit_note.rb
 - lib/zugpferd/model/invoice.rb
 - lib/zugpferd/model/item.rb
 - lib/zugpferd/model/line_item.rb
 - lib/zugpferd/model/monetary_totals.rb
+- lib/zugpferd/model/partial_invoice.rb
 - lib/zugpferd/model/payment_instructions.rb
 - lib/zugpferd/model/postal_address.rb
+- lib/zugpferd/model/prepayment_invoice.rb
 - lib/zugpferd/model/price.rb
+- lib/zugpferd/model/self_billed_invoice.rb
 - lib/zugpferd/model/tax_breakdown.rb
 - lib/zugpferd/model/tax_subtotal.rb
 - lib/zugpferd/model/trade_party.rb