xrechnung 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaeaf454239e2b041ce88d3a72425f4f1ebda1d59d94841c7a671348cccf951b
-  data.tar.gz: 7ae97721b0273ec83cb32374d33460ea15417f1d773827a2f775898bd5d04aa8
+  metadata.gz: 78c300f8df950e3c2c73b875bc6976833fea6d85b75f8a9702972f6833d8a1ad
+  data.tar.gz: b7104e08877570bf376a8adc108965729d641f8fb73c49962a80b891570d3900
 SHA512:
-  metadata.gz: f4b6a5ef7f761911a6338ac812a9ca93d098800967348b38ab14dc0aa056085a98ec2ac8bc5ce4e63f5056aa4e969d2b2bbd0d5c9832eeae14636dba9c6b4d4e
-  data.tar.gz: f13a513b06fa1953254e37a11eaffb8d4b236d4c021e7f614c47df9d3a422e4fb0b5648c26df299321d69c343abae6cc29d2e6b64c19cf5407699e733d0117fe
+  metadata.gz: 6b68cacfa965ff9b830c5b635f6e866043e8a91756bae106c044475c0f5a69ce6a5759d9570361788ec80f45b04dc7c5279ce9930f3f3f4f496f1fad0b590168
+  data.tar.gz: b9604f5e4669e5284c50da9328587a6c0c64b1c04854276e2ceb0c5e2c3039ab22ec0c51662c775d95ab38cbe78fd13c2a64596ef1c78a5f0f2d7c4587c12275

data/Gemfile.lock

@@ -1,14 +1,13 @@
 PATH
   remote: .
   specs:
-    xrechnung (0.3.0)
+    xrechnung (0.6.0)
       builder (~> 3.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    bigdecimal (3.1.8)
     builder (3.3.0)
     csv (3.3.0)
     diff-lcs (1.5.1)

data/lib/xrechnung/additional_document_reference.rb

@@ -0,0 +1,34 @@
+require "xrechnung/attachment"
+
+module Xrechnung
+  class AdditionalDocumentReference
+    include MemberContainer
+
+    # @!attribute id
+    #   @return [String]
+    member :id, type: String
+
+    # @!attribute document_type
+    #   @return [String]
+    member :document_type, type: String, optional: true
+
+    # @!attribute document_description
+    #   @return [String]
+    member :document_description, type: String, optional: true
+
+    # @!attribute attachment
+    #   @return [Xrechnung::Attachment]
+    member :attachment, type: Xrechnung::Attachment, optional: true
+
+    # noinspection RubyResolve
+    def to_xml(xml)
+      xml.cac :AdditionalDocumentReference do
+        xml.cbc :ID, id
+        xml.cbc :DocumentType, document_type
+        xml.cbc :DocumentDescription, document_description
+
+        attachment&.to_xml(xml)
+      end
+    end
+  end
+end

data/lib/xrechnung/allowance_charge.rb

@@ -24,7 +24,7 @@ module Xrechnung
 
     # @!attribute base_amount
     #   @return [Xrechnung::Currency]
-    member :base_amount, type: Xrechnung::Currency
+    member :base_amount, type: Xrechnung::Currency, optional: true
 
     # @!attribute tax_category
     #   @return [Xrechnung::TaxCategory]
@@ -35,7 +35,7 @@ module Xrechnung
         kwargs[:amount] = Currency::EUR(kwargs[:amount])
       end
 
-      unless kwargs[:base_amount].is_a?(Currency)
+      unless kwargs[:base_amount].is_a?(Currency) || kwargs[:base_amount].nil?
         kwargs[:base_amount] = Currency::EUR(kwargs[:base_amount])
       end
 
@@ -60,7 +60,10 @@ module Xrechnung
         end
 
         xml.cbc :Amount, *amount.xml_args
-        xml.cbc :BaseAmount, *base_amount.xml_args
+
+        if base_amount
+          xml.cbc :BaseAmount, *base_amount.xml_args
+        end
 
         tax_category&.to_xml(xml)
       end

data/lib/xrechnung/attachment.rb

@@ -0,0 +1,27 @@
+require "base64"
+
+module Xrechnung
+  class Attachment
+    include MemberContainer
+
+    # @!attribute mime_code
+    #   @return [String]
+    member :mime_code, type: String
+
+    # @!attribute filename
+    #   @return [String]
+    member :filename, type: String
+
+    member :payload
+
+    # noinspection RubyResolve
+    def to_xml(xml)
+      xml.cac :Attachment do
+        xml.cbc :EmbeddedDocumentBinaryObject,
+          Base64.strict_encode64(payload),
+          mimeCode: mime_code,
+          filename: filename
+      end
+    end
+  end
+end

data/lib/xrechnung/invoice_line.rb

@@ -28,6 +28,10 @@ module Xrechnung
     #   @return [Xrechnung::Price]
     member :price, type: Xrechnung::Price
 
+    # @!attribute allowance_charges
+    #   @return [Array<Xrechnung::AllowanceCharge>]
+    member :allowance_charges, type: Array, default: []
+
     def initialize(**kwargs)
       unless kwargs[:line_extension_amount].is_a?(Currency)
         kwargs[:line_extension_amount] = Currency::EUR(kwargs[:line_extension_amount])
@@ -43,6 +47,9 @@ module Xrechnung
         xml.cbc :LineExtensionAmount, *line_extension_amount.xml_args
 
         invoice_period&.to_xml(xml) unless self.class.members[:invoice_period].optional && invoice_period.nil?
+        allowance_charges.each do |allowance_charge|
+          allowance_charge.to_xml(xml)
+        end
         item&.to_xml(xml)
         price&.to_xml(xml)
       end

data/lib/xrechnung/party_identification.rb

@@ -6,10 +6,18 @@ module Xrechnung
     #   @return [String]
     member :id, type: String
 
+    # @!attribute scheme_id
+    #   @return [String]
+    member :scheme_id, type: String, optional: true
+
     # noinspection RubyResolve
     def to_xml(xml)
       xml.cac :PartyIdentification do
-        xml.cbc :ID, id
+        if scheme_id
+          xml.cbc :ID, id, schemeID: scheme_id
+        else
+          xml.cbc :ID, id
+        end
       end
     end
   end

data/lib/xrechnung/payee_party.rb

@@ -0,0 +1,36 @@
+module Xrechnung
+  # <cac:PayeeParty>
+  #   <cac:PartyIdentification>
+  #     <cbc:ID schemeID="SEPA">FR932874294</cbc:ID>
+  #   </cac:PartyIdentification>
+  #   <cac:PartyName>
+  #     <cbc:Name>Payee Name Ltd</cbc:Name>
+  #   </cac:PartyName>
+  # </cac:PayeeParty>
+  class PayeeParty
+    include MemberContainer
+
+    # @!attribute id
+    #   @return [String]
+    member :id, type: String
+
+    # @!attribute name
+    #   @return [String]
+    member :name, type: String, optional: true
+
+    # noinspection RubyResolve
+    def to_xml(xml)
+      xml.cac :PayeeParty do
+        xml.cac :PartyIdentification do
+          xml.cbc :ID, id, schemeID: "SEPA"
+        end
+
+        if name
+          xml.cac :PartyName do
+            xml.cbc :Name, name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/xrechnung/payment_mandate.rb

@@ -0,0 +1,29 @@
+module Xrechnung
+  # <cac:PaymentMandate>
+  #    <cbc:ID>SEPA-MANDAT-123</cbc:ID>
+  #    <cac:PayerFinancialAccount>
+  #      <cbc:ID>DE02500105170137075030</cbc:ID>
+  #    </cac:PayerFinancialAccount>
+  # </cac:PaymentMandate>
+  class PaymentMandate
+    include MemberContainer
+
+    # @!attribute id
+    #   @return [String]
+    member :id, type: String
+
+    # @!attribute payer_financial_account_id
+    #   @return [String]
+    member :payer_financial_account_id, type: String
+
+    # noinspection RubyResolve
+    def to_xml(xml)
+      xml.cac :PaymentMandate do
+        xml.cbc :ID, id
+        xml.cac :PayerFinancialAccount do
+          xml.cbc :ID, payer_financial_account_id
+        end
+      end
+    end
+  end
+end

data/lib/xrechnung/payment_means.rb

@@ -20,10 +20,16 @@ module Xrechnung
     #   @return [Xrechnung::PayeeFinancialAccount]
     member :payee_financial_account, type: Xrechnung::PayeeFinancialAccount
 
+    # @!attribute payment_mandate
+    #   @return [Xrechnung::PaymentMandate]
+    member :payment_mandate, type: Xrechnung::PaymentMandate, optional: true
+
     # noinspection RubyResolve
     def to_xml(xml)
       xml.cbc :PaymentMeansCode, payment_means_code
       payee_financial_account&.to_xml(xml)
+      payment_mandate&.to_xml(xml)
+      xml.target!
     end
   end
 end

data/lib/xrechnung/tax_category.rb

@@ -23,7 +23,7 @@ module Xrechnung
 
     # @!attribute percent
     #   @return [BigDecimal]
-    member :percent, type: BigDecimal, transform_value: ->(v) { BigDecimal(v, 0) }
+    member :percent, type: BigDecimal, transform_value: ->(v) { v.nil? ? nil : BigDecimal(v, 0) }
 
     # @!attribute tax_scheme_id
     #   @return [String]
@@ -41,15 +41,16 @@ module Xrechnung
     def to_xml(xml, root_tag_name: :TaxCategory)
       xml.cac root_tag_name do
         xml.cbc :ID, id
-        xml.cbc :Percent, format("%.2f", percent)
-        xml.cac :TaxScheme do
-          xml.cbc :ID, tax_scheme_id
-        end
+        xml.cbc :Percent, format("%.2f", percent) unless percent.nil?
 
         unless tax_exemption_reason_code.nil?
           xml.cbc :TaxExemptionReasonCode, tax_exemption_reason_code
           xml.cbc :TaxExemptionReason, tax_exemption_reason
         end
+
+        xml.cac :TaxScheme do
+          xml.cbc :ID, tax_scheme_id
+        end
       end
     end
   end

data/lib/xrechnung/version.rb

@@ -1,3 +1,3 @@
 module Xrechnung
-  VERSION = "0.4.0".freeze
+  VERSION = "0.6.0".freeze
 end

data/lib/xrechnung.rb

@@ -4,6 +4,7 @@ require "xrechnung/currency"
 require "xrechnung/quantity"
 require "xrechnung/id"
 require "xrechnung/member_container"
+require "xrechnung/additional_document_reference"
 require "xrechnung/contact"
 require "xrechnung/party_identification"
 require "xrechnung/party_legal_entity"
@@ -11,6 +12,8 @@ require "xrechnung/party_tax_scheme"
 require "xrechnung/postal_address"
 require "xrechnung/party"
 require "xrechnung/payee_financial_account"
+require "xrechnung/payment_mandate"
+require "xrechnung/payee_party"
 require "xrechnung/payment_means"
 require "xrechnung/tax_total"
 require "xrechnung/tax_category"
@@ -32,7 +35,7 @@ module Xrechnung
 
     # Default customization specs
     DEFAULT_CUSTOMIZATION_ID = "urn:cen.eu:en16931:2017#compliant#urn:xeinkauf.de:kosit:xrechnung_3.0"
-    DEFAULT_PROFILE_ID = "urn:fdc:peppol.eu:2017:poacc:billing:01:1.0"
+    DEFAULT_PROFILE_ID       = "urn:fdc:peppol.eu:2017:poacc:billing:01:1.0"
 
     # Document customization identifier
     #
@@ -117,7 +120,7 @@ module Xrechnung
     #
     # @!attribute purchase_order_reference
     #   @return [String]
-    member :purchase_order_reference, type: String
+    member :purchase_order_reference, type: String, optional: true
 
     # Sales order reference BT-14
     #
@@ -185,6 +188,11 @@ module Xrechnung
     #   @return [Xrechnung::InvoiceDocumentReference]
     member :billing_reference, type: Xrechnung::InvoiceDocumentReference, optional: true
 
+    # Additional supporting documents BG-24
+    # @!attribute additional_document_references
+    #   @return [Array]
+    member :additional_document_references, type: Array, default: []
+
     # @!attribute invoice_period
     #   @return [Xrechnung::InvoicePeriod]
     member :invoice_period, type: Xrechnung::InvoicePeriod, optional: true
@@ -195,7 +203,7 @@ module Xrechnung
     #
     # @!attribute contract_document_reference_id
     #   @return [String]
-    member :contract_document_reference_id, type: String
+    member :contract_document_reference_id, type: String, optional: true
 
     # Project reference BT-11
     #
@@ -203,7 +211,7 @@ module Xrechnung
     #
     # @!attribute project_reference_id
     #   @return [String]
-    member :project_reference_id, type: String
+    member :project_reference_id, type: String, optional: true
 
     # SELLER TAX REPRESENTATIVE PARTY BG-11
     #
@@ -223,6 +231,15 @@ module Xrechnung
     #   @return [Xrechnung::PaymentMeans]
     member :payment_means, type: Xrechnung::PaymentMeans
 
+    # PAYEE PARTY BG-10
+    #
+    # A group of business terms providing information about the Payee, i.e. the role that receives
+    # the payment. Shall be used when the Payee is different from the Seller.
+    #
+    # @!attribute payee_party
+    #   @return [Xrechnung::PayeeParty]
+    member :payee_party, type: Xrechnung::PayeeParty, optional: true
+
     # Payment terms BT-20
     #
     # Eine Textbeschreibung der Zahlungsbedingungen, die für den fälligen Zahlungsbetrag gelten (einschließlich
@@ -300,10 +317,15 @@ module Xrechnung
 
         invoice_period&.to_xml(xml) unless self.class.members[:invoice_period].optional && invoice_period.nil?
 
-        xml.cac :OrderReference do
-          xml.cbc :ID, purchase_order_reference
-          unless self.class.members[:sales_order_reference].optional && sales_order_reference.nil?
-            xml.cbc :SalesOrderID, sales_order_reference
+        unless self.class.members[:purchase_order_reference].optional && purchase_order_reference.nil? &&
+               self.class.members[:sales_order_reference].optional && sales_order_reference.nil?
+          xml.cac :OrderReference do
+            unless self.class.members[:purchase_order_reference].optional && purchase_order_reference.nil?
+              xml.cbc :ID, purchase_order_reference
+            end
+            unless self.class.members[:sales_order_reference].optional && sales_order_reference.nil?
+              xml.cbc :SalesOrderID, sales_order_reference
+            end
           end
         end
 
@@ -313,14 +335,20 @@ module Xrechnung
           end
         end
 
-        xml.cac :ContractDocumentReference do
-          xml.cbc :ID, contract_document_reference_id
+        unless self.class.members[:contract_document_reference_id].optional && contract_document_reference_id.nil?
+          xml.cac :ContractDocumentReference do
+            xml.cbc :ID, contract_document_reference_id
+          end
         end
 
-        xml.cac :ProjectReference do
-          xml.cbc :ID, project_reference_id
+        unless self.class.members[:project_reference_id].optional && project_reference_id.nil?
+          xml.cac :ProjectReference do
+            xml.cbc :ID, project_reference_id
+          end
         end
 
+        additional_document_references.each { _1.to_xml(xml) }
+
         xml.cac :AccountingSupplierParty do
           accounting_supplier_party&.to_xml(xml)
         end
@@ -339,13 +367,13 @@ module Xrechnung
           payment_means&.to_xml(xml)
         end
 
+        payee_party&.to_xml(xml) unless self.class.members[:payee_party].optional && payee_party.nil?
+
         xml.cac :PaymentTerms do
           xml.cbc :Note, payment_terms_note
         end
 
-        allowance_charges.each do |allowance_charge|
-          allowance_charge&.to_xml(xml)
-        end
+        allowance_charges.each { _1.to_xml(xml) }
 
         xml.cac :TaxTotal do
           tax_total&.to_xml(xml)
@@ -355,9 +383,7 @@ module Xrechnung
           legal_monetary_total&.to_xml(xml)
         end
 
-        invoice_lines.each do |invoice_line|
-          invoice_line&.to_xml(xml)
-        end
+        invoice_lines.each { _1.to_xml(xml) }
       end
 
       target

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xrechnung
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Julian Kornberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2025-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -73,7 +73,9 @@ files:
 - bin/console
 - bin/setup
 - lib/xrechnung.rb
+- lib/xrechnung/additional_document_reference.rb
 - lib/xrechnung/allowance_charge.rb
+- lib/xrechnung/attachment.rb
 - lib/xrechnung/contact.rb
 - lib/xrechnung/currency.rb
 - lib/xrechnung/id.rb
@@ -88,6 +90,8 @@ files:
 - lib/xrechnung/party_legal_entity.rb
 - lib/xrechnung/party_tax_scheme.rb
 - lib/xrechnung/payee_financial_account.rb
+- lib/xrechnung/payee_party.rb
+- lib/xrechnung/payment_mandate.rb
 - lib/xrechnung/payment_means.rb
 - lib/xrechnung/postal_address.rb
 - lib/xrechnung/price.rb