ubl 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1778b4c23b585bf9a2bb5b783aee65d9104d1f9ade0ba7a20fdab7c18aced7de
+  data.tar.gz: 7d6c635cc5a0e6fe6e64c9f103705611d6edf9bc7cbebb04222c0c7c37176f02
+SHA512:
+  metadata.gz: f6a1306eddf09c6a7003f10c394e8702b95e28af953c4a826ae33dbaac0a33492d07033881898e5b1d9f59577db158802bf466b494c9e4e5bd5bbd82a8ac4ae6
+  data.tar.gz: 5b5dcb7717fbacc50e2e1101c786a1d270c1358af163c4ebb694336c0ca3cf05496c49134bbdc88b975f91f738f476477715e0ca792f867955f222f603d7e251

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 roel4d
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# Ubl
+
+Generate UBL invoices and credit notes for Peppol
+
+## installation
+
+install the gem and add to the application's gemfile by executing:
+
+```bash
+bundle add ubl
+```
+
+if bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install ubl
+```
+
+## usage
+
+todo: write usage instructions here
+
+## development
+
+after checking out the repo, run `bin/setup` to install dependencies. then, run `rake test` to run the tests. you can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+to install this gem onto your local machine, run `bundle exec rake install`. to release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## contributing
+
+bug reports and pull requests are welcome on github at https://github.com/roel4d/ubl.
+
+## license
+
+the gem is available as open source under the terms of the [mit license](https://opensource.org/licenses/mit).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/credit_note.rb

@@ -0,0 +1,29 @@
+require_relative "ubl/builder"
+
+module Ubl
+  class CreditNote < UblBuilder
+    def initialize(ubl_be)
+      super
+    end
+
+    def build
+      builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+        xml.CreditNote(namespaces.merge("xmlns" => "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2")) do
+          build_header(xml) do |xml|
+            xml["cbc"].CreditNoteTypeCode "381"
+          end
+
+          build_document_reference(xml, "CreditNote")
+
+          build_party(xml, @supplier, "AccountingSupplierParty")
+          build_party(xml, @customer, "AccountingCustomerParty")
+
+          build_tax_total(xml)
+          build_monetary_total(xml)
+          build_invoice_lines(xml)
+        end
+      end
+      builder.to_xml
+    end
+  end
+end

data/lib/invoice.rb

@@ -0,0 +1,29 @@
+require_relative "ubl/builder"
+
+module Ubl
+  class Invoice < UblBuilder
+    def initialize(ubl_be)
+      super
+    end
+
+    def build
+      builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+        xml.Invoice(namespaces) do
+          build_header(xml) do |xml|
+            xml["cbc"].InvoiceTypeCode "380"
+          end
+
+          build_document_reference(xml, "CommercialInvoice")
+
+          build_party(xml, @supplier, "AccountingSupplierParty")
+          build_party(xml, @customer, "AccountingCustomerParty")
+
+          build_tax_total(xml)
+          build_monetary_total(xml)
+          build_invoice_lines(xml)
+        end
+      end
+      builder.to_xml
+    end
+  end
+end

data/lib/ubl/builder.rb

@@ -0,0 +1,261 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+require "date"
+require "base64"
+
+module Ubl
+  class Error < StandardError; end
+
+  class UblBuilder
+    attr_accessor :invoice_nr, :issue_date, :due_date, :currency, :supplier,
+      :customer, :invoice_lines, :tax_total, :legal_monetary_total, :pdffile
+
+    CUSTOMIZATION_ID = "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0"
+    CUSTOMIZATION_UBL_BE = "urn:cen.eu:en16931:2017#conformant#urn:UBL.BE:1.0.0.20180214"
+    PROFILE_ID = "urn:fdc:peppol.eu:2017:poacc:billing:01:1.0"
+
+    def initialize(ubl_be = false)
+      @ubl_be = ubl_be
+      @issue_date = Date.today
+      @due_date = @issue_date + 30
+      @currency = "EUR"
+      @attachments = []
+      @invoice_lines = []
+      @tax_total = 0
+      @legal_monetary_total = 0
+    end
+
+    def namespaces
+      {
+        "xmlns" => "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2",
+        "xmlns:cac" => "urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2",
+        "xmlns:cbc" => "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2"
+      }
+    end
+
+    def add_supplier(name:, country:, vat_id: nil, address: nil, city: nil, postal_code: nil)
+      @supplier = {
+        name: name,
+        country: country,
+        vat_id: vat_id,
+        address: address,
+        city: city,
+        postal_code: postal_code
+      }
+    end
+
+    def add_customer(name:, country:, vat_id: nil, address: nil, city: nil, postal_code: nil)
+      @customer = {
+        name: name,
+        country: country,
+        vat_id: vat_id,
+        address: address,
+        city: city,
+        postal_code: postal_code
+      }
+    end
+
+    def add_line(name:, quantity:, unit_price:, tax_rate: 21.0, unit: "ZZ")
+      line_extension_amount = (quantity * unit_price).round(2)
+      tax_amount = (line_extension_amount * (tax_rate / 100.0)).round(2)
+
+      @invoice_lines << {
+        id: (@invoice_lines.length + 1).to_s,
+        name: name,
+        quantity: quantity,
+        unit: unit,
+        unit_price: unit_price,
+        line_extension_amount: line_extension_amount,
+        tax_rate: tax_rate,
+        tax_amount: tax_amount
+      }
+
+      calculate_totals
+    end
+
+    private
+
+    def calculate_totals
+      line_extension_amount = @invoice_lines.sum { |line| line[:line_extension_amount] }
+      @tax_total = @invoice_lines.sum { |line| line[:tax_amount] }
+      @legal_monetary_total = line_extension_amount + @tax_total
+    end
+
+    def build_header(xml)
+      xml["cbc"].CustomizationID @ubl_be ? CUSTOMIZATION_UBL_BE : CUSTOMIZATION_ID
+      xml["cbc"].ProfileID PROFILE_ID
+      xml["cbc"].ID @invoice_nr
+      xml["cbc"].IssueDate @issue_date.to_s
+      xml["cbc"].DueDate @due_date.to_s
+      yield xml
+      xml["cbc"].DocumentCurrencyCode @currency
+      xml["cac"].OrderReference do
+        xml["cbc"].ID @invoice_nr
+      end
+    end
+
+    def build_document_reference(xml, description)
+      if @ubl_be
+        xml["cac"].AdditionalDocumentReference do
+          xml["cbc"].ID "UBL.BE"
+          xml["cbc"].DocumentDescription description
+        end
+      end
+
+      if @pdffile
+        content = Base64.strict_encode64(File.binread(@pdffile))
+
+        xml["cac"].AdditionalDocumentReference do
+          xml["cbc"].ID @invoice_nr
+          xml["cbc"].DocumentDescription "PDF"
+          xml["cac"].Attachment do
+            xml["cbc"].EmbeddedDocumentBinaryObject(mimeCode: "application/pdf", filename: File.basename(@pdffile)) { xml.text content }
+          end
+        end
+      end
+    end
+
+    def add_attachment(id, filename)
+      @attachments << {id: id, content:}
+    end
+
+    def build_party(xml, party_data, party_type)
+      return unless party_data
+
+      xml["cac"].send(party_type) do
+        xml["cac"].Party do
+          xml["cbc"].EndpointID(schemeID: "0208") { xml.text party_data[:vat_id].gsub(/^[A-Za-z]+/, "") }
+
+          if party_data[:address]
+            xml["cac"].PostalAddress do
+              xml["cbc"].StreetName party_data[:address] if party_data[:address]
+              xml["cbc"].CityName party_data[:city] if party_data[:city]
+              xml["cbc"].PostalZone party_data[:postal_code] if party_data[:postal_code]
+              xml["cac"].Country do
+                xml["cbc"].IdentificationCode party_data[:country]
+              end
+            end
+          end
+
+          if party_data[:vat_id]
+            xml["cac"].PartyTaxScheme do
+              xml["cbc"].CompanyID party_data[:vat_id]
+              xml["cac"].TaxScheme do
+                xml["cbc"].ID "VAT"
+              end
+            end
+          end
+
+          xml["cac"].PartyLegalEntity do
+            xml["cbc"].RegistrationName party_data[:name]
+          end
+        end
+      end
+    end
+
+    def build_invoice_lines(xml)
+      @invoice_lines.each do |line|
+        xml["cac"].InvoiceLine do
+          xml["cbc"].ID line[:id]
+          xml["cbc"].InvoicedQuantity(unitCode: line[:unit]) { xml.text line[:quantity] }
+          xml["cbc"].LineExtensionAmount(currencyID: @currency) { xml.text sprintf("%.2f", line[:line_extension_amount]) }
+
+          if @ubl_be
+            xml["cac"].TaxTotal do
+              xml["cbc"].TaxAmount(currencyID: @currency) { xml.text line[:tax_amount] }
+            end
+          end
+
+          xml["cac"].Item do
+            xml["cbc"].Name line[:name]
+            xml["cac"].ClassifiedTaxCategory do
+              xml["cbc"].ID get_tax_category_id(line[:tax_rate])
+              xml["cbc"].Name get_tax_category_name(line[:tax_rate]) if @ubl_be
+              xml["cbc"].Percent line[:tax_rate]
+              xml["cac"].TaxScheme do
+                xml["cbc"].ID "VAT"
+              end
+            end
+          end
+
+          xml["cac"].Price do
+            xml["cbc"].PriceAmount(currencyID: @currency) { xml.text sprintf("%.2f", line[:unit_price]) }
+          end
+        end
+      end
+    end
+
+    def get_tax_category_name(tax_rate)
+      case tax_rate
+      when 0, "0%"
+        "00"
+      when 6, "6%"
+        "01"
+      when 12, "12%"
+        "02"
+      when 21, "21%"
+        "03"
+      else
+        "00" # Default to 0% category
+      end
+    end
+
+    def get_tax_category_id(tax_rate)
+      case tax_rate
+      when 0, "0%"
+        "Z"
+      when 6, "6%"
+        "S"
+      when 12, "12%"
+        "S"
+      when 21, "21%"
+        "S"
+      else
+        "Z" # Default to 0% category
+      end
+    end
+
+    def build_tax_total(xml)
+      return if @invoice_lines.empty?
+
+      xml["cac"].TaxTotal do
+        xml["cbc"].TaxAmount(currencyID: @currency) { xml.text sprintf("%.2f", @tax_total) }
+
+        # Group by tax rate
+        tax_groups = @invoice_lines.group_by { |line| line[:tax_rate] }
+
+        tax_groups.each do |tax_rate, lines|
+          taxable_amount = lines.sum { |line| line[:line_extension_amount] }
+          tax_amount = lines.sum { |line| line[:tax_amount] }
+
+          xml["cac"].TaxSubtotal do
+            xml["cbc"].TaxableAmount(currencyID: @currency) { xml.text sprintf("%.2f", taxable_amount) }
+            xml["cbc"].TaxAmount(currencyID: @currency) { xml.text sprintf("%.2f", tax_amount) }
+            xml["cac"].TaxCategory do
+              xml["cbc"].ID get_tax_category_id(tax_rate)
+              xml["cbc"].Name get_tax_category_name(tax_rate) if @ubl_be
+              xml["cbc"].Percent tax_rate
+              xml["cac"].TaxScheme do
+                xml["cbc"].ID "VAT"
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def build_monetary_total(xml)
+      return if @invoice_lines.empty?
+
+      line_extension_amount = @invoice_lines.sum { |line| line[:line_extension_amount] }
+
+      xml["cac"].LegalMonetaryTotal do
+        xml["cbc"].LineExtensionAmount(currencyID: @currency) { xml.text sprintf("%.2f", line_extension_amount) }
+        xml["cbc"].TaxExclusiveAmount(currencyID: @currency) { xml.text sprintf("%.2f", line_extension_amount) }
+        xml["cbc"].TaxInclusiveAmount(currencyID: @currency) { xml.text sprintf("%.2f", @legal_monetary_total) }
+        xml["cbc"].PayableAmount(currencyID: @currency) { xml.text sprintf("%.2f", @legal_monetary_total) }
+      end
+    end
+  end
+end

data/lib/ubl/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ubl
+  VERSION = "0.0.1"
+end

data/sig/ubl.rbs

@@ -0,0 +1,4 @@
+module Ubl
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: ubl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- roel4d
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+description: Generate UBL documents for Peppol
+email:
+- roel4d@webding.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/credit_note.rb
+- lib/invoice.rb
+- lib/ubl/builder.rb
+- lib/ubl/version.rb
+- sig/ubl.rbs
+homepage: https://github.com/roel4d/ubl
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/roel4d/ubl
+  source_code_uri: https://github.com/roel4d/invoice
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Generate UBL documents
+test_files: []