zipdatev 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93a524d3a6c114e4ba449add730c39e4db83007ff043ef1b0e734786b4f56c1f
-  data.tar.gz: be5eb61e54fb13aca8fc308286c6ca02b5302f1663217b5470770e4e7fe786be
+  metadata.gz: 16ae34c9ade5ebebaf3ec979f10d8816b5ab871f68aa06070051ca9b41d2b4c0
+  data.tar.gz: ef6f9b9345a13d8b2fc1aff5a0e67d7d932a4a244cdbc384a2b79fceb25267f8
 SHA512:
-  metadata.gz: 3637481aa9773fcdc5458ecbdced141d9fa817fc6098df825b6e395fcee5fa0f92ce33ab18d6bef5d8d499f037a19f691f5f4873b44bee233c4280393c6c973b
-  data.tar.gz: 87d7e721150ac9771e7ec9bc20d1c7a2569a2c9736cd30ff9b8b071e269571b30f8c8dda538436155b06f54d0eb1889523fb09ed8adbd85d06cadb8fa806148e
+  metadata.gz: b47bb6b5874e07f1a0a85e3a0f6ad4b28e39124bdf78c322e3772584ea04f3c6f924c5ea5f5b2c3f9ca206245de1fcb86e126188021806b9808ec0dc6a64819d
+  data.tar.gz: d691a9ee6263c1cbb54aa8679df7caac69e70c4b7e53db18b3831b5a0395fdecc134f4b6ac0f10bbb26319b37ec6ab61f9bdceb0296953f030916bca1c492c1a

data/lib/zipdatev/constants.rb

@@ -71,6 +71,10 @@ module ZipDatev
       ZA ZM ZW
     ].freeze
 
+    # Pattern for GUID/UUID: 8-4-4-4-12 hex digits (RFC 4122)
+    # From XSD p10037: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}
+    GUID_PATTERN = /\A[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}\z/
+
     # Pattern for invoice ID: alphanumeric + $%&*+-/
     # From XSD p10040: [a-zA-Z0-9$%&*+-/]{0,36}
     INVOICE_ID_PATTERN = %r{\A[a-zA-Z0-9$%&*+\-/]{0,36}\z}
@@ -105,6 +109,11 @@ module ZipDatev
     MIN_AMOUNT = BigDecimal("-9999999999.99")
     MAX_AMOUNT = BigDecimal("9999999999.99")
 
+    # Cost amount (KOST-Menge) constraints
+    # From XSD p37: 12 integer + 4 fraction digits, min 0.0001
+    MIN_COST_AMOUNT = BigDecimal("0.0001")
+    MAX_COST_AMOUNT = BigDecimal("999999999999.9999")
+
     # Tax percentage constraints
     # From XSD p33: 0.00 to 99.99
     MIN_TAX = BigDecimal("0.00")
@@ -143,6 +152,14 @@ module ZipDatev
     # String length constraints
     INVOICE_ID_MAX_LENGTH = 36
     INTERNAL_INVOICE_ID_MAX_LENGTH = 12
+    TYPE_OF_RECEIVABLE_MAX_LENGTH = 10
+
+    # Document metadata length constraints (from Document_types_v060.xsd)
+    DOCUMENT_DESCRIPTION_MAX_LENGTH = 40 # p10052: Bemerkung 040
+    DOCUMENT_KEYWORDS_MAX_LENGTH = 255       # p10051: Bemerkung 255
+    DOCUMENT_PROPERTY_MAX_LENGTH = 255       # p20: Dateiname/property value max 255
+    HEADER_DESCRIPTION_MAX_LENGTH = 255      # p10051: Bemerkung 255
+    CLIENT_NAME_MAX_LENGTH = 36              # p17: Name Mandant
     ORDER_ID_MAX_LENGTH = 30
     BOOKING_TEXT_MAX_LENGTH = 60
     INFORMATION_MAX_LENGTH = 120

data/lib/zipdatev/document.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_model"
+require_relative "constants"
 
 module ZipDatev
   # Represents a document entry in the DATEV package.
@@ -16,23 +17,66 @@ module ZipDatev
   #     invoice_month: "2023-01",
   #     folder_name: "Eingangsrechnungen"
   #   )
+  #
+  # @example Creating a document with type, processID, description, and keywords
+  #   document = ZipDatev::Document.new(
+  #     invoice: invoice,
+  #     type: 1,
+  #     process_id: 2,
+  #     description: "January invoice",
+  #     keywords: "supplier; january; 2023"
+  #   )
+  #
+  # @example Creating a document with documentintern properties
+  #   document = ZipDatev::Document.new(
+  #     invoice: invoice,
+  #     properties: [{ key: "CustomField", value: "MyValue" }]
+  #   )
   class Document
     include ActiveModel::Model
     include ActiveModel::Validations
 
-    attr_accessor :invoice, :attachments, :invoice_month, :folder_name, :repository
+    attr_accessor :invoice, :attachments, :invoice_month, :folder_name, :repository, :guid,
+                  :type, :process_id, :description, :keywords, :properties
 
     # Validations
     validates :invoice, presence: true
+    validates :type, inclusion: { in: [1, 2] }, allow_nil: true
+    validates :process_id, inclusion: { in: [1, 2] }, allow_nil: true
+    validates :description, length: { maximum: Constants::DOCUMENT_DESCRIPTION_MAX_LENGTH }, allow_nil: true
+    validates :keywords, length: { maximum: Constants::DOCUMENT_KEYWORDS_MAX_LENGTH }, allow_nil: true
     validate :invoice_must_be_valid
     validate :attachments_must_exist
+    validate :guid_must_be_valid_format
+    validate :properties_must_be_valid
 
-    def initialize(invoice: nil, attachments: [], invoice_month: nil, folder_name: nil, repository: nil)
+    # @param invoice [Invoice] The invoice (required)
+    # @param attachments [Array<String>] Paths to attachment files
+    # @param invoice_month [String] Invoice month in "YYYY-MM" format
+    # @param folder_name [String] Folder name for the accountsPayableLedger extension
+    # @param repository [Repository, nil] Optional filing structure for this document
+    # @param guid [String, nil] Optional GUID for the document element (RFC 4122)
+    # @param type [Integer, nil] Document type: 1 = incoming invoice, 2 = outgoing invoice
+    # @param process_id [Integer, nil] Processing flag: 1 = booking-relevant, 2 = archiving-relevant
+    # @param description [String, nil] Document description (max 40 chars)
+    # @param keywords [String, nil] Keywords/notes for the document (max 255 chars)
+    # @param properties [Array<Hash>, nil] Array of {key:, value:} pairs for documentintern element
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(invoice: nil, attachments: [], invoice_month: nil, folder_name: nil,
+                   repository: nil, guid: nil, type: nil, process_id: nil,
+                   description: nil, keywords: nil, properties: nil)
+      # rubocop:enable Metrics/ParameterLists
       @invoice = invoice
       @attachments = attachments || []
       @invoice_month = invoice_month
       @folder_name = folder_name
       @repository = repository
+      @guid = guid
+      @type = type
+      @process_id = process_id
+      @description = description
+      @keywords = keywords
+      @properties = properties || []
     end
 
     private
@@ -56,5 +100,33 @@ module ZipDatev
         errors.add(:attachments, "file not found: #{path}")
       end
     end
+
+    def guid_must_be_valid_format
+      return if guid.blank?
+      return if guid.match?(Constants::GUID_PATTERN)
+
+      errors.add(:guid, "must be a valid GUID (RFC 4122 format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)")
+    end
+
+    def properties_must_be_valid
+      return if properties.blank?
+
+      properties.each_with_index { |prop, idx| validate_property_entry(prop, idx) }
+    end
+
+    def validate_property_entry(prop, idx)
+      unless prop.is_a?(Hash) && prop[:key].present? && prop[:value].present?
+        errors.add(:properties, "entry #{idx + 1} must have :key and :value")
+        return
+      end
+
+      validate_property_lengths(prop, idx)
+    end
+
+    def validate_property_lengths(prop, idx)
+      max = Constants::DOCUMENT_PROPERTY_MAX_LENGTH
+      errors.add(:properties, "entry #{idx + 1} key exceeds #{max} chars") if prop[:key].to_s.length > max
+      errors.add(:properties, "entry #{idx + 1} value exceeds #{max} chars") if prop[:value].to_s.length > max
+    end
   end
 end

data/lib/zipdatev/generators/base.rb

@@ -43,10 +43,14 @@ module ZipDatev
 
       # Fields that should be formatted as decimals with 2 decimal places
       DECIMAL_FIELDS = %i[
-        amount discount_amount cost_amount tax discount_percentage
+        amount discount_amount tax discount_percentage
         discount_amount_2 discount_percentage_2
       ].freeze
 
+      # Fields that should be formatted as decimals with 4 decimal places
+      # cost_amount (KOST-Menge) uses p37 type: 12 integer + 4 fraction digits
+      COST_AMOUNT_FIELDS = %i[cost_amount].freeze
+
       # Fields that should be formatted as decimals with 6 decimal places
       EXCHANGE_RATE_FIELDS = %i[exchange_rate].freeze
 
@@ -131,6 +135,8 @@ module ZipDatev
           format_date(value)
         elsif DECIMAL_FIELDS.include?(field)
           format_decimal(value, precision: 2)
+        elsif COST_AMOUNT_FIELDS.include?(field)
+          format_decimal(value, precision: 4)
         elsif EXCHANGE_RATE_FIELDS.include?(field)
           format_decimal(value, precision: 6)
         elsif BOOLEAN_FIELDS.include?(field)

data/lib/zipdatev/generators/document_xml.rb

@@ -52,22 +52,33 @@ module ZipDatev
 
       # Attributes for the archive root element
       def archive_attributes
-        {
+        attrs = {
           "xmlns" => DOCUMENT_XMLNS,
           "xmlns:xsi" => XSI_XMLNS,
           "xsi:schemaLocation" => DOCUMENT_XSI_SCHEMA_LOCATION,
           "version" => Base::VERSION,
           "generatingSystem" => package.generating_system
         }
+        attrs["guid"] = package.archive_guid if package.archive_guid.present?
+        attrs
       end
 
       # Generate the header element
       def generate_header(xml)
         xml.header do
           xml.date format_datetime(created_at)
+          generate_header_optional_fields(xml)
         end
       end
 
+      # Generate optional header fields (description, consultant/client metadata)
+      def generate_header_optional_fields(xml)
+        xml.description package.description if package.description.present?
+        xml.consultantNumber package.consultant_number.to_s if package.consultant_number
+        xml.clientNumber package.client_number.to_s if package.client_number
+        xml.clientName package.client_name if package.client_name.present?
+      end
+
       # Generate the content element with all documents
       def generate_content(xml)
         xml.content do
@@ -79,20 +90,25 @@ module ZipDatev
 
       # Generate a document element for a single document
       def generate_document(xml, document)
-        xml.document do
-          # Generate ledger extension (accountsPayableLedger)
+        xml.document(build_document_attributes(document)) do
+          xml.description document.description if document.description.present?
+          xml.keywords document.keywords if document.keywords.present?
           generate_ledger_extension(xml, document)
-
-          # Generate file extensions for attachments
-          document.attachments.each do |attachment_path|
-            generate_file_extension(xml, attachment_path)
-          end
-
-          # Generate optional repository structure
+          document.attachments.each { |path| generate_file_extension(xml, path) }
           generate_repository(xml, document) if document.repository
+          generate_documentintern(xml, document) if document.properties.any?
         end
       end
 
+      # Build the attribute hash for a document element
+      def build_document_attributes(document)
+        attrs = {}
+        attrs["guid"] = document.guid if document.guid.present?
+        attrs["type"] = document.type.to_s if document.type
+        attrs["processID"] = document.process_id.to_s if document.process_id
+        attrs
+      end
+
       # Generate the accountsPayableLedger extension element
       def generate_ledger_extension(xml, document)
         datafile = ledger_filename(
@@ -138,6 +154,18 @@ module ZipDatev
           xml.level("id" => "3", "name" => repo.level3) if repo.level3
         end
       end
+
+      # Generate the documentintern element with property key/value pairs
+      #
+      # @param xml [Nokogiri::XML::Builder] The XML builder
+      # @param document [Document] The document with properties
+      def generate_documentintern(xml, document)
+        xml.documentintern do
+          document.properties.each do |prop|
+            xml.property("key" => prop[:key].to_s, "value" => prop[:value].to_s)
+          end
+        end
+      end
     end
   end
 end

data/lib/zipdatev/invoice.rb

@@ -45,6 +45,7 @@ module ZipDatev
   #     discount_payment_date_2: Date.new(2023, 1, 22),
   #     due_date: Date.new(2023, 1, 26)
   #   )
+  # rubocop:disable Metrics/ClassLength
   class Invoice
     include ActiveModel::Model
     include ActiveModel::Attributes
@@ -104,6 +105,10 @@ module ZipDatev
     validates :exchange_rate, decimal_precision: { places: 6 }, allow_nil: true
 
     # Cost amount validations
+    validates :cost_amount, numericality: {
+      greater_than_or_equal_to: Constants::MIN_COST_AMOUNT,
+      less_than_or_equal_to: Constants::MAX_COST_AMOUNT
+    }, allow_nil: true
     validates :cost_amount, decimal_precision: { places: 4 }, allow_nil: true
 
     # Account number validations
@@ -148,6 +153,8 @@ module ZipDatev
     validates :bank_account, length: { maximum: Constants::BANK_ACCOUNT_MAX_LENGTH }, allow_nil: true
     validates :cost_category_id, length: { maximum: Constants::COST_CATEGORY_ID_MAX_LENGTH }, allow_nil: true
     validates :cost_category_id2, length: { maximum: Constants::COST_CATEGORY_ID_MAX_LENGTH }, allow_nil: true
+    validates :own_vat_id, length: { maximum: Constants::VAT_ID_MAX_LENGTH }, allow_nil: true
+    validates :type_of_receivable, length: { maximum: Constants::TYPE_OF_RECEIVABLE_MAX_LENGTH }, allow_nil: true
 
     # Format validations (codes and patterns)
     validates :currency_code, inclusion: { in: Constants::CURRENCY_CODES }, allow_nil: true
@@ -160,6 +167,7 @@ module ZipDatev
     validates :iban, format: { with: Constants::IBAN_PATTERN }, allow_blank: true
     validates :swift_code, format: { with: Constants::SWIFT_PATTERN }, allow_blank: true
     validates :vat_id, format: { with: Constants::VAT_ID_PATTERN }, allow_blank: true
+    validates :own_vat_id, format: { with: Constants::VAT_ID_PATTERN }, allow_blank: true
 
     # Date range validations
     validates :date, date_range: true, allow_nil: true
@@ -336,4 +344,5 @@ module ZipDatev
       attributes.compact.transform_keys(&:to_sym)
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/zipdatev/line_item.rb

@@ -73,6 +73,10 @@ module ZipDatev
     validates :exchange_rate, decimal_precision: { places: 6 }, allow_nil: true
 
     # Cost amount validations
+    validates :cost_amount, numericality: {
+      greater_than_or_equal_to: Constants::MIN_COST_AMOUNT,
+      less_than_or_equal_to: Constants::MAX_COST_AMOUNT
+    }, allow_nil: true
     validates :cost_amount, decimal_precision: { places: 4 }, allow_nil: true
 
     # Account number validations
@@ -117,6 +121,8 @@ module ZipDatev
     validates :bank_account, length: { maximum: Constants::BANK_ACCOUNT_MAX_LENGTH }, allow_nil: true
     validates :cost_category_id, length: { maximum: Constants::COST_CATEGORY_ID_MAX_LENGTH }, allow_nil: true
     validates :cost_category_id2, length: { maximum: Constants::COST_CATEGORY_ID_MAX_LENGTH }, allow_nil: true
+    validates :own_vat_id, length: { maximum: Constants::VAT_ID_MAX_LENGTH }, allow_nil: true
+    validates :type_of_receivable, length: { maximum: Constants::TYPE_OF_RECEIVABLE_MAX_LENGTH }, allow_nil: true
 
     # Format validations (codes and patterns)
     validates :currency_code, inclusion: { in: Constants::CURRENCY_CODES }, allow_nil: true
@@ -129,6 +135,7 @@ module ZipDatev
     validates :iban, format: { with: Constants::IBAN_PATTERN }, allow_blank: true
     validates :swift_code, format: { with: Constants::SWIFT_PATTERN }, allow_blank: true
     validates :vat_id, format: { with: Constants::VAT_ID_PATTERN }, allow_blank: true
+    validates :own_vat_id, format: { with: Constants::VAT_ID_PATTERN }, allow_blank: true
 
     # Date range validations
     validates :date, date_range: true, allow_nil: true

data/lib/zipdatev/package.rb

@@ -27,16 +27,33 @@ module ZipDatev
     # Size limits as specified in DATEV documentation
     MAX_PACKAGE_SIZE = 465 * 1024 * 1024  # 465 MB
     MAX_FILE_SIZE = 20 * 1024 * 1024      # 20 MB
-    MAX_DOCUMENTS = 5000
+    # XSD Document_v060.xsd specifies maxOccurs="4999" for content/document elements
+    MAX_DOCUMENTS = 4999
 
     # Pattern for valid ASCII filenames (no special characters that cause issues)
     ASCII_FILENAME_PATTERN = /\A[\x20-\x7E]+\z/
 
-    attr_reader :generator_info, :generating_system, :documents
-
-    def initialize(generator_info:, generating_system:)
+    attr_reader :generator_info, :generating_system, :documents,
+                :archive_guid, :description, :consultant_number, :client_number, :client_name
+
+    # @param generator_info [String] Name of company/system creating the data (required)
+    # @param generating_system [String] Software system identifier (required)
+    # @param archive_guid [String, nil] Optional GUID for the archive element (RFC 4122)
+    # @param description [String, nil] Optional description for the archive header (max 255 chars)
+    # @param consultant_number [Integer, nil] Optional DATEV Beraternummer (1000–9999999)
+    # @param client_number [Integer, nil] Optional DATEV Mandantennummer (0–99999)
+    # @param client_name [String, nil] Optional client/company name (max 36 chars)
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(generator_info:, generating_system:, archive_guid: nil,
+                   description: nil, consultant_number: nil, client_number: nil, client_name: nil)
+      # rubocop:enable Metrics/ParameterLists
       @generator_info = generator_info
       @generating_system = generating_system
+      @archive_guid = archive_guid
+      @description = description
+      @consultant_number = consultant_number
+      @client_number = client_number
+      @client_name = client_name
       @documents = []
     end
 
@@ -45,16 +62,32 @@ module ZipDatev
     # @param invoice [Invoice] The invoice data
     # @param attachments [Array<String>] Paths to attachment files
     # @param invoice_month [String] Invoice month in "YYYY-MM" format
-    # @param folder_name [String] Folder name for filing
-    # @param repository [Repository, nil] Optional repository structure
+    # @param folder_name [String] Folder name for the accountsPayableLedger extension
+    # @param repository [Repository, nil] Optional filing structure for the document
+    # @param guid [String, nil] Optional GUID (RFC 4122) for the document element
+    # @param type [Integer, nil] Document type: 1 = incoming invoice, 2 = outgoing invoice
+    # @param process_id [Integer, nil] Processing flag: 1 = booking-relevant, 2 = archiving-relevant
+    # @param description [String, nil] Document description (max 40 chars)
+    # @param keywords [String, nil] Keywords/notes (max 255 chars)
+    # @param properties [Array<Hash>, nil] documentintern key/value pairs
     # @return [Document] The created document
-    def add_document(invoice:, attachments: [], invoice_month: nil, folder_name: nil, repository: nil)
+    # rubocop:disable Metrics/ParameterLists
+    def add_document(invoice:, attachments: [], invoice_month: nil, folder_name: nil,
+                     repository: nil, guid: nil, type: nil, process_id: nil,
+                     description: nil, keywords: nil, properties: nil)
+      # rubocop:enable Metrics/ParameterLists
       document = Document.new(
         invoice: invoice,
         attachments: attachments,
         invoice_month: invoice_month,
         folder_name: folder_name,
-        repository: repository
+        repository: repository,
+        guid: guid,
+        type: type,
+        process_id: process_id,
+        description: description,
+        keywords: keywords,
+        properties: properties
       )
       @documents << document
       document

data/lib/zipdatev/validators/consolidation_validator.rb

@@ -62,7 +62,7 @@ module ZipDatev
 
         record.errors.add(
           :base,
-          "All line items must have the same date, found: #{dates.map(&:to_s).join(", ")}"
+          "All line items must have the same date, found: #{dates.join(", ")}"
         )
       end
     end

data/lib/zipdatev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZipDatev
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipdatev
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Dexter Team