e-invoice-api 0.11.0 → 0.12.0

data/rbi/e_invoice_api/models/me_retrieve_response.rbi

@@ -28,7 +28,7 @@ module EInvoiceAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :bcc_recipient_email
 
-      # Address of the company
+      # Address of the company. Must be in the form of `Street Name Street Number`
       sig { returns(T.nilable(String)) }
       attr_accessor :company_address
 
@@ -44,14 +44,21 @@ module EInvoiceAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :company_email
 
-      # Name of the company
+      # Name of the company. Must include the company type. For example: `BV`, `NV`,
+      # `CVBA`, `VOF`
       sig { returns(T.nilable(String)) }
       attr_accessor :company_name
 
-      # Company number
+      # Company number. For Belgium this is the CBE number or their EUID (European
+      # Unique Identifier) number
       sig { returns(T.nilable(String)) }
       attr_accessor :company_number
 
+      # Company tax ID. For Belgium this is the VAT number. Must include the country
+      # prefix
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_tax_id
+
       # Zip code of the company
       sig { returns(T.nilable(String)) }
       attr_accessor :company_zip
@@ -87,6 +94,7 @@ module EInvoiceAPI
           company_email: T.nilable(String),
           company_name: T.nilable(String),
           company_number: T.nilable(String),
+          company_tax_id: T.nilable(String),
           company_zip: T.nilable(String),
           description: T.nilable(String),
           ibans: T.nilable(T::Array[String]),
@@ -103,7 +111,7 @@ module EInvoiceAPI
         plan:,
         # BCC recipient email to deliver documents
         bcc_recipient_email: nil,
-        # Address of the company
+        # Address of the company. Must be in the form of `Street Name Street Number`
         company_address: nil,
         # City of the company
         company_city: nil,
@@ -111,10 +119,15 @@ module EInvoiceAPI
         company_country: nil,
         # Email of the company
         company_email: nil,
-        # Name of the company
+        # Name of the company. Must include the company type. For example: `BV`, `NV`,
+        # `CVBA`, `VOF`
         company_name: nil,
-        # Company number
+        # Company number. For Belgium this is the CBE number or their EUID (European
+        # Unique Identifier) number
         company_number: nil,
+        # Company tax ID. For Belgium this is the VAT number. Must include the country
+        # prefix
+        company_tax_id: nil,
         # Zip code of the company
         company_zip: nil,
         description: nil,
@@ -142,6 +155,7 @@ module EInvoiceAPI
             company_email: T.nilable(String),
             company_name: T.nilable(String),
             company_number: T.nilable(String),
+            company_tax_id: T.nilable(String),
             company_zip: T.nilable(String),
             description: T.nilable(String),
             ibans: T.nilable(T::Array[String]),

data/rbi/e_invoice_api/models/payment_detail_create.rbi

@@ -11,15 +11,20 @@ module EInvoiceAPI
           )
         end
 
+      # Bank account number (for non-IBAN accounts)
       sig { returns(T.nilable(String)) }
       attr_accessor :bank_account_number
 
+      # International Bank Account Number for payment transfers
       sig { returns(T.nilable(String)) }
       attr_accessor :iban
 
+      # Structured payment reference or communication (e.g., structured communication
+      # for Belgian bank transfers)
       sig { returns(T.nilable(String)) }
       attr_accessor :payment_reference
 
+      # SWIFT/BIC code of the bank
       sig { returns(T.nilable(String)) }
       attr_accessor :swift
 
@@ -32,9 +37,14 @@ module EInvoiceAPI
         ).returns(T.attached_class)
       end
       def self.new(
+        # Bank account number (for non-IBAN accounts)
         bank_account_number: nil,
+        # International Bank Account Number for payment transfers
         iban: nil,
+        # Structured payment reference or communication (e.g., structured communication
+        # for Belgian bank transfers)
         payment_reference: nil,
+        # SWIFT/BIC code of the bank
         swift: nil
       )
       end

data/rbi/e_invoice_api/resources/documents.rbi

@@ -25,6 +25,7 @@ module EInvoiceAPI
           currency: EInvoiceAPI::CurrencyCode::OrSymbol,
           customer_address: T.nilable(String),
           customer_address_recipient: T.nilable(String),
+          customer_company_id: T.nilable(String),
           customer_email: T.nilable(String),
           customer_id: T.nilable(String),
           customer_name: T.nilable(String),
@@ -66,6 +67,7 @@ module EInvoiceAPI
           vatex_note: T.nilable(String),
           vendor_address: T.nilable(String),
           vendor_address_recipient: T.nilable(String),
+          vendor_company_id: T.nilable(String),
           vendor_email: T.nilable(String),
           vendor_name: T.nilable(String),
           vendor_tax_id: T.nilable(String),
@@ -74,70 +76,109 @@ module EInvoiceAPI
       end
       def create(
         allowances: nil,
-        # The amount due of the invoice. Must be positive and rounded to maximum 2
-        # decimals
+        # The amount due for payment. Must be positive and rounded to maximum 2 decimals
         amount_due: nil,
         attachments: nil,
+        # The billing address (if different from customer address)
         billing_address: nil,
+        # The recipient name at the billing address
         billing_address_recipient: nil,
         charges: nil,
-        # Currency of the invoice
+        # Currency of the invoice (ISO 4217 currency code)
         currency: nil,
+        # The address of the customer/buyer
         customer_address: nil,
+        # The recipient name at the customer address
         customer_address_recipient: nil,
+        # Customer company ID. For Belgium this is the CBE number or their EUID (European
+        # Unique Identifier) number. In the Netherlands this is the KVK number.
+        customer_company_id: nil,
+        # The email address of the customer
         customer_email: nil,
+        # The unique identifier for the customer in your system
         customer_id: nil,
+        # The company name of the customer/buyer
         customer_name: nil,
+        # Customer tax ID. For Belgium this is the VAT number. Must include the country
+        # prefix
         customer_tax_id: nil,
+        # The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
         direction: nil,
+        # The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE
         document_type: nil,
+        # The date when payment is due
         due_date: nil,
+        # The date when the invoice was issued
         invoice_date: nil,
+        # The unique invoice identifier/number
         invoice_id: nil,
-        # The total amount of the invoice (so invoice_total = subtotal + total_tax +
-        # total_discount). Must be positive and rounded to maximum 2 decimals
+        # 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
         items: nil,
+        # Additional notes or comments for the invoice
         note: nil,
         payment_details: nil,
+        # The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
         payment_term: nil,
-        # The previous unpaid balance of the invoice, if any. Must be positive and rounded
-        # to maximum 2 decimals
+        # The previous unpaid balance from prior invoices, if any. Must be positive and
+        # rounded to maximum 2 decimals
         previous_unpaid_balance: nil,
+        # The purchase order reference number
         purchase_order: nil,
+        # The address where payment should be sent or remitted to
         remittance_address: nil,
+        # The recipient name at the remittance address
         remittance_address_recipient: nil,
+        # The address where services were performed or goods were delivered
         service_address: nil,
+        # The recipient name at the service address
         service_address_recipient: nil,
+        # The end date of the service period or delivery period
         service_end_date: nil,
+        # The start date of the service period or delivery period
         service_start_date: nil,
+        # The shipping/delivery address
         shipping_address: nil,
+        # The recipient name at the shipping address
         shipping_address_recipient: nil,
+        # The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED
         state: nil,
         # The taxable base of the invoice. Should be the sum of all line items -
         # allowances (for example commercial discounts) + charges with impact on VAT. Must
         # be positive and rounded to maximum 2 decimals
         subtotal: nil,
-        # Tax category code of the invoice
+        # Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E
+        # for exempt)
         tax_code: nil,
         tax_details: nil,
         # The net financial discount/charge of the invoice (non-VAT charges minus non-VAT
         # allowances). Can be positive (net charge), negative (net discount), or zero.
         # Must be rounded to maximum 2 decimals
         total_discount: nil,
-        # The total tax of the invoice. Must be positive and rounded to maximum 2 decimals
+        # The total tax amount of the invoice. Must be positive and rounded to maximum 2
+        # decimals
         total_tax: nil,
         # VATEX code list for VAT exemption reasons
         #
         # Agency: CEF Identifier: vatex
         vatex: nil,
-        # VAT exemption note of the invoice
+        # Textual explanation for VAT exemption
         vatex_note: nil,
+        # The address of the vendor/seller
         vendor_address: nil,
+        # The recipient name at the vendor address
         vendor_address_recipient: nil,
+        # Vendor company ID. For Belgium this is the CBE number or their EUID (European
+        # Unique Identifier) number. In the Netherlands this is the KVK number.
+        vendor_company_id: nil,
+        # The email address of the vendor
         vendor_email: nil,
+        # The name of the vendor/seller/supplier
         vendor_name: nil,
+        # Vendor tax ID. For Belgium this is the VAT number. Must include the country
+        # prefix
         vendor_tax_id: nil,
         request_options: {}
       )

data/rbi/e_invoice_api/resources/validate.rbi

@@ -19,6 +19,7 @@ module EInvoiceAPI
           currency: EInvoiceAPI::CurrencyCode::OrSymbol,
           customer_address: T.nilable(String),
           customer_address_recipient: T.nilable(String),
+          customer_company_id: T.nilable(String),
           customer_email: T.nilable(String),
           customer_id: T.nilable(String),
           customer_name: T.nilable(String),
@@ -60,6 +61,7 @@ module EInvoiceAPI
           vatex_note: T.nilable(String),
           vendor_address: T.nilable(String),
           vendor_address_recipient: T.nilable(String),
+          vendor_company_id: T.nilable(String),
           vendor_email: T.nilable(String),
           vendor_name: T.nilable(String),
           vendor_tax_id: T.nilable(String),
@@ -68,70 +70,109 @@ module EInvoiceAPI
       end
       def validate_json(
         allowances: nil,
-        # The amount due of the invoice. Must be positive and rounded to maximum 2
-        # decimals
+        # The amount due for payment. Must be positive and rounded to maximum 2 decimals
         amount_due: nil,
         attachments: nil,
+        # The billing address (if different from customer address)
         billing_address: nil,
+        # The recipient name at the billing address
         billing_address_recipient: nil,
         charges: nil,
-        # Currency of the invoice
+        # Currency of the invoice (ISO 4217 currency code)
         currency: nil,
+        # The address of the customer/buyer
         customer_address: nil,
+        # The recipient name at the customer address
         customer_address_recipient: nil,
+        # Customer company ID. For Belgium this is the CBE number or their EUID (European
+        # Unique Identifier) number. In the Netherlands this is the KVK number.
+        customer_company_id: nil,
+        # The email address of the customer
         customer_email: nil,
+        # The unique identifier for the customer in your system
         customer_id: nil,
+        # The company name of the customer/buyer
         customer_name: nil,
+        # Customer tax ID. For Belgium this is the VAT number. Must include the country
+        # prefix
         customer_tax_id: nil,
+        # The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
         direction: nil,
+        # The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE
         document_type: nil,
+        # The date when payment is due
         due_date: nil,
+        # The date when the invoice was issued
         invoice_date: nil,
+        # The unique invoice identifier/number
         invoice_id: nil,
-        # The total amount of the invoice (so invoice_total = subtotal + total_tax +
-        # total_discount). Must be positive and rounded to maximum 2 decimals
+        # 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
         items: nil,
+        # Additional notes or comments for the invoice
         note: nil,
         payment_details: nil,
+        # The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
         payment_term: nil,
-        # The previous unpaid balance of the invoice, if any. Must be positive and rounded
-        # to maximum 2 decimals
+        # The previous unpaid balance from prior invoices, if any. Must be positive and
+        # rounded to maximum 2 decimals
         previous_unpaid_balance: nil,
+        # The purchase order reference number
         purchase_order: nil,
+        # The address where payment should be sent or remitted to
         remittance_address: nil,
+        # The recipient name at the remittance address
         remittance_address_recipient: nil,
+        # The address where services were performed or goods were delivered
         service_address: nil,
+        # The recipient name at the service address
         service_address_recipient: nil,
+        # The end date of the service period or delivery period
         service_end_date: nil,
+        # The start date of the service period or delivery period
         service_start_date: nil,
+        # The shipping/delivery address
         shipping_address: nil,
+        # The recipient name at the shipping address
         shipping_address_recipient: nil,
+        # The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED
         state: nil,
         # The taxable base of the invoice. Should be the sum of all line items -
         # allowances (for example commercial discounts) + charges with impact on VAT. Must
         # be positive and rounded to maximum 2 decimals
         subtotal: nil,
-        # Tax category code of the invoice
+        # Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E
+        # for exempt)
         tax_code: nil,
         tax_details: nil,
         # The net financial discount/charge of the invoice (non-VAT charges minus non-VAT
         # allowances). Can be positive (net charge), negative (net discount), or zero.
         # Must be rounded to maximum 2 decimals
         total_discount: nil,
-        # The total tax of the invoice. Must be positive and rounded to maximum 2 decimals
+        # The total tax amount of the invoice. Must be positive and rounded to maximum 2
+        # decimals
         total_tax: nil,
         # VATEX code list for VAT exemption reasons
         #
         # Agency: CEF Identifier: vatex
         vatex: nil,
-        # VAT exemption note of the invoice
+        # Textual explanation for VAT exemption
         vatex_note: nil,
+        # The address of the vendor/seller
         vendor_address: nil,
+        # The recipient name at the vendor address
         vendor_address_recipient: nil,
+        # Vendor company ID. For Belgium this is the CBE number or their EUID (European
+        # Unique Identifier) number. In the Netherlands this is the KVK number.
+        vendor_company_id: nil,
+        # The email address of the vendor
         vendor_email: nil,
+        # The name of the vendor/seller/supplier
         vendor_name: nil,
+        # Vendor tax ID. For Belgium this is the VAT number. Must include the country
+        # prefix
         vendor_tax_id: nil,
         request_options: {}
       )

data/sig/e_invoice_api/models/allowance.rbs

@@ -6,8 +6,8 @@ module EInvoiceAPI
         base_amount: String?,
         multiplier_factor: String?,
         reason: String?,
-        reason_code: String?,
-        tax_code: EInvoiceAPI::Models::Allowance::tax_code?,
+        reason_code: EInvoiceAPI::Models::Allowance::reason_code?,
+        tax_code: EInvoiceAPI::Models::Allowance::tax_code,
         tax_rate: String?
       }
 
@@ -20,9 +20,13 @@ module EInvoiceAPI
 
       attr_accessor reason: String?
 
-      attr_accessor reason_code: String?
+      attr_accessor reason_code: EInvoiceAPI::Models::Allowance::reason_code?
 
-      attr_accessor tax_code: EInvoiceAPI::Models::Allowance::tax_code?
+      attr_reader tax_code: EInvoiceAPI::Models::Allowance::tax_code?
+
+      def tax_code=: (
+        EInvoiceAPI::Models::Allowance::tax_code
+      ) -> EInvoiceAPI::Models::Allowance::tax_code
 
       attr_accessor tax_rate: String?
 
@@ -31,8 +35,8 @@ module EInvoiceAPI
         ?base_amount: String?,
         ?multiplier_factor: String?,
         ?reason: String?,
-        ?reason_code: String?,
-        ?tax_code: EInvoiceAPI::Models::Allowance::tax_code?,
+        ?reason_code: EInvoiceAPI::Models::Allowance::reason_code?,
+        ?tax_code: EInvoiceAPI::Models::Allowance::tax_code,
         ?tax_rate: String?
       ) -> void
 
@@ -41,11 +45,58 @@ module EInvoiceAPI
         base_amount: String?,
         multiplier_factor: String?,
         reason: String?,
-        reason_code: String?,
-        tax_code: EInvoiceAPI::Models::Allowance::tax_code?,
+        reason_code: EInvoiceAPI::Models::Allowance::reason_code?,
+        tax_code: EInvoiceAPI::Models::Allowance::tax_code,
         tax_rate: String?
       }
 
+      type reason_code =
+        :"41"
+        | :"42"
+        | :"60"
+        | :"62"
+        | :"63"
+        | :"64"
+        | :"65"
+        | :"66"
+        | :"67"
+        | :"68"
+        | :"70"
+        | :"71"
+        | :"88"
+        | :"95"
+        | :"100"
+        | :"102"
+        | :"103"
+        | :"104"
+        | :"105"
+
+      module ReasonCode
+        extend EInvoiceAPI::Internal::Type::Enum
+
+        REASON_CODE_41: :"41"
+        REASON_CODE_42: :"42"
+        REASON_CODE_60: :"60"
+        REASON_CODE_62: :"62"
+        REASON_CODE_63: :"63"
+        REASON_CODE_64: :"64"
+        REASON_CODE_65: :"65"
+        REASON_CODE_66: :"66"
+        REASON_CODE_67: :"67"
+        REASON_CODE_68: :"68"
+        REASON_CODE_70: :"70"
+        REASON_CODE_71: :"71"
+        REASON_CODE_88: :"88"
+        REASON_CODE_95: :"95"
+        REASON_CODE_100: :"100"
+        REASON_CODE_102: :"102"
+        REASON_CODE_103: :"103"
+        REASON_CODE_104: :"104"
+        REASON_CODE_105: :"105"
+
+        def self?.values: -> ::Array[EInvoiceAPI::Models::Allowance::reason_code]
+      end
+
       type tax_code = :AE | :E | :S | :Z | :G | :O | :K | :L | :M | :B
 
       module TaxCode