e-invoice-api 0.29.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 338628785cf857da4ad086ccff3882098b0792afc39dc369e71e9f1ac17490cb
-  data.tar.gz: cd3f20e5d19d1ae3b5123467d63be8420fcede349cd436a9229ba1b18566e0a3
+  metadata.gz: 944e77d94844bca83b4632b605a4e3e2aa52fa45fd463598990998143fcb10c6
+  data.tar.gz: 06ada41bd76346b16b4a762b9ec6f98ea95339e77bc270942c35c20d7e3fb906
 SHA512:
-  metadata.gz: 9eb86eeb920d41d1f14b36de3187b18fa49b23f432c867636d0d3fbf55e9cfa21e87e5de64853cdd466159b6436fbd391868a4f58b56268063b45e8eb49371e8
-  data.tar.gz: 30bd136e0b1de720818dd6bad6a1a872a3191c536d96a7972301398de8dfbcaf5733c477192ead1bf1a896ba34c8b06c4aa8b4df8d21d0dc66762b825e2b8212
+  metadata.gz: 416f1899158d12cf7b713e165d70b8a50ec12f21bdf917fa589ffcbb2378ab624309aedb29ddbfa55f90999801c7ea0179e561379794b206abc1e6c770456bd8
+  data.tar.gz: eaba15af19f415974f0ab6f72184f7acddace0da300a7c1b19d64f6a986c955b6a9591f9ed8fe0edbba0dc26db74ffd09b89cb1a398f9296161a054e64084c74

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.31.0 (2026-05-20)
+
+Full Changelog: [v0.30.0...v0.31.0](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.30.0...v0.31.0)
+
+### Features
+
+* **api:** api update ([e573579](https://github.com/e-invoice-be/e-invoice-rb/commit/e573579bfb81de4e29cf6af00307030e013441b3))
+
+## 0.30.0 (2026-05-20)
+
+Full Changelog: [v0.29.0...v0.30.0](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.29.0...v0.30.0)
+
+### Features
+
+* **api:** api update ([f78359a](https://github.com/e-invoice-be/e-invoice-rb/commit/f78359a02579a27e3aa505319e8ad3b1da4b969a))
+
 ## 0.29.0 (2026-05-20)
 
 Full Changelog: [v0.28.1...v0.29.0](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.28.1...v0.29.0)

data/README.md

@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "e-invoice-api", "~> 0.29.0"
+gem "e-invoice-api", "~> 0.31.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/e_invoice_api/models/document_create_from_pdf_response.rb

@@ -113,6 +113,18 @@ module EInvoiceAPI
       #   @return [Date, nil]
       optional :due_date, Date, nil?: true
 
+      # @!attribute error_message
+      #   Error message when success is False
+      #
+      #   @return [String, nil]
+      optional :error_message, String, nil?: true
+
+      # @!attribute error_type
+      #   Error type/category when success is False
+      #
+      #   @return [String, nil]
+      optional :error_type, String, nil?: true
+
       # @!attribute invoice_date
       #   The date when the invoice was issued
       #
@@ -133,7 +145,7 @@ module EInvoiceAPI
       optional :invoice_total, String, nil?: true
 
       # @!attribute items
-      #   At least one line item is required
+      #   Line items (may be empty for failed conversions)
       #
       #   @return [Array<EInvoiceAPI::Models::DocumentCreateFromPdfResponse::Item>, nil]
       optional :items,
@@ -319,7 +331,7 @@ module EInvoiceAPI
       #   @return [String, nil]
       optional :vendor_tax_id, String, nil?: true
 
-      # @!method initialize(allowances: nil, amount_due: nil, attachments: nil, billing_address: nil, billing_address_recipient: nil, charges: nil, currency: nil, customer_address: nil, customer_address_recipient: nil, customer_company_id: nil, customer_email: nil, customer_id: nil, customer_name: nil, customer_peppol_id: nil, customer_tax_id: nil, direction: nil, document_type: nil, due_date: nil, invoice_date: nil, invoice_id: nil, invoice_total: nil, items: nil, note: nil, payment_details: nil, payment_term: nil, purchase_order: nil, remittance_address: nil, remittance_address_recipient: nil, service_address: nil, service_address_recipient: nil, service_end_date: nil, service_start_date: nil, shipping_address: nil, shipping_address_recipient: nil, state: nil, subtotal: nil, success: nil, tax_code: nil, tax_details: nil, total_discount: nil, total_tax: nil, ubl_document: nil, vatex: nil, vatex_note: nil, vendor_address: nil, vendor_address_recipient: nil, vendor_company_id: nil, vendor_email: nil, vendor_name: nil, vendor_tax_id: nil)
+      # @!method initialize(allowances: nil, amount_due: nil, attachments: nil, billing_address: nil, billing_address_recipient: nil, charges: nil, currency: nil, customer_address: nil, customer_address_recipient: nil, customer_company_id: nil, customer_email: nil, customer_id: nil, customer_name: nil, customer_peppol_id: nil, customer_tax_id: nil, direction: nil, document_type: nil, due_date: nil, error_message: nil, error_type: nil, invoice_date: nil, invoice_id: nil, invoice_total: nil, items: nil, note: nil, payment_details: nil, payment_term: nil, purchase_order: nil, remittance_address: nil, remittance_address_recipient: nil, service_address: nil, service_address_recipient: nil, service_end_date: nil, service_start_date: nil, shipping_address: nil, shipping_address_recipient: nil, state: nil, subtotal: nil, success: nil, tax_code: nil, tax_details: nil, total_discount: nil, total_tax: nil, ubl_document: nil, vatex: nil, vatex_note: nil, vendor_address: nil, vendor_address_recipient: nil, vendor_company_id: nil, vendor_email: nil, vendor_name: nil, vendor_tax_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {EInvoiceAPI::Models::DocumentCreateFromPdfResponse} for more details.
       #
@@ -359,13 +371,17 @@ module EInvoiceAPI
       #
       #   @param due_date [Date, nil] The date when payment is due
       #
+      #   @param error_message [String, nil] Error message when success is False
+      #
+      #   @param error_type [String, nil] Error type/category when success is False
+      #
       #   @param invoice_date [Date, nil] The date when the invoice was issued
       #
       #   @param invoice_id [String, nil] The unique invoice identifier/number
       #
       #   @param invoice_total [String, nil] The total amount of the invoice including tax (invoice*total = subtotal + total*
       #
-      #   @param items [Array<EInvoiceAPI::Models::DocumentCreateFromPdfResponse::Item>] At least one line item is required
+      #   @param items [Array<EInvoiceAPI::Models::DocumentCreateFromPdfResponse::Item>] Line items (may be empty for failed conversions)
       #
       #   @param note [String, nil] Additional notes or comments for the invoice
       #

data/lib/e_invoice_api/models/validate_validate_peppol_id_response.rb

@@ -22,6 +22,12 @@ module EInvoiceAPI
       #   @return [Boolean]
       required :is_valid, EInvoiceAPI::Internal::Type::Boolean
 
+      # @!attribute supported_document_types
+      #   List of document types that this Peppol ID supports
+      #
+      #   @return [Array<String>]
+      required :supported_document_types, EInvoiceAPI::Internal::Type::ArrayOf[String]
+
       # @!attribute business_card
       #   Business card information for the Peppol ID
       #
@@ -30,12 +36,7 @@ module EInvoiceAPI
                -> { EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard },
                nil?: true
 
-      # @!attribute supported_document_types
-      #
-      #   @return [Array<String>, nil]
-      optional :supported_document_types, EInvoiceAPI::Internal::Type::ArrayOf[String]
-
-      # @!method initialize(business_card_valid:, dns_valid:, is_valid:, business_card: nil, supported_document_types: nil)
+      # @!method initialize(business_card_valid:, dns_valid:, is_valid:, supported_document_types:, business_card: nil)
       #   Response for a Peppol ID validation request.
       #
       #   This model represents the validation result of a Peppol ID in the Peppol
@@ -47,9 +48,9 @@ module EInvoiceAPI
       #
       #   @param is_valid [Boolean] Whether the Peppol ID is valid and registered in the Peppol network
       #
-      #   @param business_card [EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard, nil] Business card information for the Peppol ID
+      #   @param supported_document_types [Array<String>] List of document types that this Peppol ID supports
       #
-      #   @param supported_document_types [Array<String>]
+      #   @param business_card [EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard, nil] Business card information for the Peppol ID
 
       # @see EInvoiceAPI::Models::ValidateValidatePeppolIDResponse#business_card
       class BusinessCard < EInvoiceAPI::Internal::Type::BaseModel

data/lib/e_invoice_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EInvoiceAPI
-  VERSION = "0.29.0"
+  VERSION = "0.31.0"
 end

data/rbi/e_invoice_api/models/document_create_from_pdf_response.rbi

@@ -93,6 +93,14 @@ module EInvoiceAPI
       sig { returns(T.nilable(Date)) }
       attr_accessor :due_date
 
+      # Error message when success is False
+      sig { returns(T.nilable(String)) }
+      attr_accessor :error_message
+
+      # Error type/category when success is False
+      sig { returns(T.nilable(String)) }
+      attr_accessor :error_type
+
       # The date when the invoice was issued
       sig { returns(T.nilable(Date)) }
       attr_accessor :invoice_date
@@ -106,7 +114,7 @@ module EInvoiceAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :invoice_total
 
-      # At least one line item is required
+      # Line items (may be empty for failed conversions)
       sig do
         returns(
           T.nilable(
@@ -301,6 +309,8 @@ module EInvoiceAPI
           direction: EInvoiceAPI::DocumentDirection::OrSymbol,
           document_type: EInvoiceAPI::DocumentType::OrSymbol,
           due_date: T.nilable(Date),
+          error_message: T.nilable(String),
+          error_type: T.nilable(String),
           invoice_date: T.nilable(Date),
           invoice_id: T.nilable(String),
           invoice_total: T.nilable(String),
@@ -384,6 +394,10 @@ module EInvoiceAPI
         document_type: nil,
         # The date when payment is due
         due_date: nil,
+        # Error message when success is False
+        error_message: nil,
+        # Error type/category when success is False
+        error_type: nil,
         # The date when the invoice was issued
         invoice_date: nil,
         # The unique invoice identifier/number
@@ -391,7 +405,7 @@ module EInvoiceAPI
         # The total amount of the invoice including tax (invoice_total = subtotal +
         # total_tax + total_discount). Must be positive and rounded to maximum 2 decimals
         invoice_total: nil,
-        # At least one line item is required
+        # Line items (may be empty for failed conversions)
         items: nil,
         # Additional notes or comments for the invoice
         note: nil,
@@ -482,6 +496,8 @@ module EInvoiceAPI
             direction: EInvoiceAPI::DocumentDirection::TaggedSymbol,
             document_type: EInvoiceAPI::DocumentType::TaggedSymbol,
             due_date: T.nilable(Date),
+            error_message: T.nilable(String),
+            error_type: T.nilable(String),
             invoice_date: T.nilable(Date),
             invoice_id: T.nilable(String),
             invoice_total: T.nilable(String),

data/rbi/e_invoice_api/models/validate_validate_peppol_id_response.rbi

@@ -23,6 +23,10 @@ module EInvoiceAPI
       sig { returns(T::Boolean) }
       attr_accessor :is_valid
 
+      # List of document types that this Peppol ID supports
+      sig { returns(T::Array[String]) }
+      attr_accessor :supported_document_types
+
       # Business card information for the Peppol ID
       sig do
         returns(
@@ -43,12 +47,6 @@ module EInvoiceAPI
       end
       attr_writer :business_card
 
-      sig { returns(T.nilable(T::Array[String])) }
-      attr_reader :supported_document_types
-
-      sig { params(supported_document_types: T::Array[String]).void }
-      attr_writer :supported_document_types
-
       # Response for a Peppol ID validation request.
       #
       # This model represents the validation result of a Peppol ID in the Peppol
@@ -58,11 +56,11 @@ module EInvoiceAPI
           business_card_valid: T::Boolean,
           dns_valid: T::Boolean,
           is_valid: T::Boolean,
+          supported_document_types: T::Array[String],
           business_card:
             T.nilable(
               EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard::OrHash
-            ),
-          supported_document_types: T::Array[String]
+            )
         ).returns(T.attached_class)
       end
       def self.new(
@@ -72,9 +70,10 @@ module EInvoiceAPI
         dns_valid:,
         # Whether the Peppol ID is valid and registered in the Peppol network
         is_valid:,
+        # List of document types that this Peppol ID supports
+        supported_document_types:,
         # Business card information for the Peppol ID
-        business_card: nil,
-        supported_document_types: nil
+        business_card: nil
       )
       end
 
@@ -84,11 +83,11 @@ module EInvoiceAPI
             business_card_valid: T::Boolean,
             dns_valid: T::Boolean,
             is_valid: T::Boolean,
+            supported_document_types: T::Array[String],
             business_card:
               T.nilable(
                 EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard
-              ),
-            supported_document_types: T::Array[String]
+              )
           }
         )
       end

data/sig/e_invoice_api/models/document_create_from_pdf_response.rbs

@@ -20,6 +20,8 @@ module EInvoiceAPI
         direction: EInvoiceAPI::Models::document_direction,
         document_type: EInvoiceAPI::Models::document_type,
         due_date: Date?,
+        error_message: String?,
+        error_type: String?,
         invoice_date: Date?,
         invoice_id: String?,
         invoice_total: String?,
@@ -103,6 +105,10 @@ module EInvoiceAPI
 
       attr_accessor due_date: Date?
 
+      attr_accessor error_message: String?
+
+      attr_accessor error_type: String?
+
       attr_accessor invoice_date: Date?
 
       attr_accessor invoice_id: String?
@@ -200,6 +206,8 @@ module EInvoiceAPI
         ?direction: EInvoiceAPI::Models::document_direction,
         ?document_type: EInvoiceAPI::Models::document_type,
         ?due_date: Date?,
+        ?error_message: String?,
+        ?error_type: String?,
         ?invoice_date: Date?,
         ?invoice_id: String?,
         ?invoice_total: String?,
@@ -253,6 +261,8 @@ module EInvoiceAPI
         direction: EInvoiceAPI::Models::document_direction,
         document_type: EInvoiceAPI::Models::document_type,
         due_date: Date?,
+        error_message: String?,
+        error_type: String?,
         invoice_date: Date?,
         invoice_id: String?,
         invoice_total: String?,

data/sig/e_invoice_api/models/validate_validate_peppol_id_response.rbs

@@ -5,8 +5,8 @@ module EInvoiceAPI
         business_card_valid: bool,
         dns_valid: bool,
         is_valid: bool,
-        business_card: EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard?,
-        supported_document_types: ::Array[String]
+        supported_document_types: ::Array[String],
+        business_card: EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard?
       }
 
     class ValidateValidatePeppolIDResponse < EInvoiceAPI::Internal::Type::BaseModel
@@ -16,26 +16,24 @@ module EInvoiceAPI
 
       attr_accessor is_valid: bool
 
-      attr_accessor business_card: EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard?
-
-      attr_reader supported_document_types: ::Array[String]?
+      attr_accessor supported_document_types: ::Array[String]
 
-      def supported_document_types=: (::Array[String]) -> ::Array[String]
+      attr_accessor business_card: EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard?
 
       def initialize: (
         business_card_valid: bool,
         dns_valid: bool,
         is_valid: bool,
-        ?business_card: EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard?,
-        ?supported_document_types: ::Array[String]
+        supported_document_types: ::Array[String],
+        ?business_card: EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard?
       ) -> void
 
       def to_hash: -> {
         business_card_valid: bool,
         dns_valid: bool,
         is_valid: bool,
-        business_card: EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard?,
-        supported_document_types: ::Array[String]
+        supported_document_types: ::Array[String],
+        business_card: EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard?
       }
 
       type business_card =

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: e-invoice-api
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.31.0
 platform: ruby
 authors:
 - e-invoice