e-invoice-api 0.6.0 → 0.8.0

data/rbi/e_invoice_api/models/document_validate_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    class DocumentValidateParams < EInvoiceAPI::Internal::Type::BaseModel
+      extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
+      include EInvoiceAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            EInvoiceAPI::DocumentValidateParams,
+            EInvoiceAPI::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: EInvoiceAPI::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: EInvoiceAPI::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/models/documents/ubl_create_from_ubl_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    module Documents
+      class UblCreateFromUblParams < EInvoiceAPI::Internal::Type::BaseModel
+        extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
+        include EInvoiceAPI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              EInvoiceAPI::Documents::UblCreateFromUblParams,
+              EInvoiceAPI::Internal::AnyHash
+            )
+          end
+
+        sig { returns(EInvoiceAPI::Internal::FileInput) }
+        attr_accessor :file
+
+        sig do
+          params(
+            file: EInvoiceAPI::Internal::FileInput,
+            request_options: EInvoiceAPI::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(file:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              file: EInvoiceAPI::Internal::FileInput,
+              request_options: EInvoiceAPI::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/models/me_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    class MeRetrieveParams < EInvoiceAPI::Internal::Type::BaseModel
+      extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
+      include EInvoiceAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(EInvoiceAPI::MeRetrieveParams, EInvoiceAPI::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: EInvoiceAPI::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: EInvoiceAPI::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/models/me_retrieve_response.rbi

@@ -0,0 +1,195 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    class MeRetrieveResponse < EInvoiceAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            EInvoiceAPI::Models::MeRetrieveResponse,
+            EInvoiceAPI::Internal::AnyHash
+          )
+        end
+
+      # Credit balance of the tenant
+      sig { returns(Integer) }
+      attr_accessor :credit_balance
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Plan of the tenant
+      sig do
+        returns(EInvoiceAPI::Models::MeRetrieveResponse::Plan::TaggedSymbol)
+      end
+      attr_accessor :plan
+
+      # BCC recipient email to deliver documents
+      sig { returns(T.nilable(String)) }
+      attr_accessor :bcc_recipient_email
+
+      # Address of the company
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_address
+
+      # City of the company
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_city
+
+      # Country of the company
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_country
+
+      # Email of the company
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_email
+
+      # Name of the company
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_name
+
+      # Company number
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_number
+
+      # Zip code of the company
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_zip
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # IBANs of the tenant
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :ibans
+
+      # Peppol IDs of the tenant
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :peppol_ids
+
+      # Whether the tenant is registered on our SMP
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :smp_registration
+
+      # Date when the tenant was registered on SMP
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :smp_registration_date
+
+      sig do
+        params(
+          credit_balance: Integer,
+          name: String,
+          plan: EInvoiceAPI::Models::MeRetrieveResponse::Plan::OrSymbol,
+          bcc_recipient_email: T.nilable(String),
+          company_address: T.nilable(String),
+          company_city: T.nilable(String),
+          company_country: T.nilable(String),
+          company_email: T.nilable(String),
+          company_name: T.nilable(String),
+          company_number: T.nilable(String),
+          company_zip: T.nilable(String),
+          description: T.nilable(String),
+          ibans: T.nilable(T::Array[String]),
+          peppol_ids: T.nilable(T::Array[String]),
+          smp_registration: T.nilable(T::Boolean),
+          smp_registration_date: T.nilable(Time)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Credit balance of the tenant
+        credit_balance:,
+        name:,
+        # Plan of the tenant
+        plan:,
+        # BCC recipient email to deliver documents
+        bcc_recipient_email: nil,
+        # Address of the company
+        company_address: nil,
+        # City of the company
+        company_city: nil,
+        # Country of the company
+        company_country: nil,
+        # Email of the company
+        company_email: nil,
+        # Name of the company
+        company_name: nil,
+        # Company number
+        company_number: nil,
+        # Zip code of the company
+        company_zip: nil,
+        description: nil,
+        # IBANs of the tenant
+        ibans: nil,
+        # Peppol IDs of the tenant
+        peppol_ids: nil,
+        # Whether the tenant is registered on our SMP
+        smp_registration: nil,
+        # Date when the tenant was registered on SMP
+        smp_registration_date: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            credit_balance: Integer,
+            name: String,
+            plan: EInvoiceAPI::Models::MeRetrieveResponse::Plan::TaggedSymbol,
+            bcc_recipient_email: T.nilable(String),
+            company_address: T.nilable(String),
+            company_city: T.nilable(String),
+            company_country: T.nilable(String),
+            company_email: T.nilable(String),
+            company_name: T.nilable(String),
+            company_number: T.nilable(String),
+            company_zip: T.nilable(String),
+            description: T.nilable(String),
+            ibans: T.nilable(T::Array[String]),
+            peppol_ids: T.nilable(T::Array[String]),
+            smp_registration: T.nilable(T::Boolean),
+            smp_registration_date: T.nilable(Time)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Plan of the tenant
+      module Plan
+        extend EInvoiceAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, EInvoiceAPI::Models::MeRetrieveResponse::Plan)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        STARTER =
+          T.let(
+            :starter,
+            EInvoiceAPI::Models::MeRetrieveResponse::Plan::TaggedSymbol
+          )
+        PRO =
+          T.let(
+            :pro,
+            EInvoiceAPI::Models::MeRetrieveResponse::Plan::TaggedSymbol
+          )
+        ENTERPRISE =
+          T.let(
+            :enterprise,
+            EInvoiceAPI::Models::MeRetrieveResponse::Plan::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              EInvoiceAPI::Models::MeRetrieveResponse::Plan::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/models.rbi

@@ -1,14 +1,20 @@
 # typed: strong
 
 module EInvoiceAPI
+  Allowance = EInvoiceAPI::Models::Allowance
+
   Certificate = EInvoiceAPI::Models::Certificate
 
+  Charge = EInvoiceAPI::Models::Charge
+
   CurrencyCode = EInvoiceAPI::Models::CurrencyCode
 
   DocumentAttachmentCreate = EInvoiceAPI::Models::DocumentAttachmentCreate
 
   DocumentCreate = EInvoiceAPI::Models::DocumentCreate
 
+  DocumentCreateFromPdfParams = EInvoiceAPI::Models::DocumentCreateFromPdfParams
+
   DocumentCreateParams = EInvoiceAPI::Models::DocumentCreateParams
 
   DocumentDeleteParams = EInvoiceAPI::Models::DocumentDeleteParams
@@ -27,6 +33,8 @@ module EInvoiceAPI
 
   DocumentType = EInvoiceAPI::Models::DocumentType
 
+  DocumentValidateParams = EInvoiceAPI::Models::DocumentValidateParams
+
   InboxListCreditNotesParams = EInvoiceAPI::Models::InboxListCreditNotesParams
 
   InboxListInvoicesParams = EInvoiceAPI::Models::InboxListInvoicesParams
@@ -38,6 +46,8 @@ module EInvoiceAPI
   LookupRetrieveParticipantsParams =
     EInvoiceAPI::Models::LookupRetrieveParticipantsParams
 
+  MeRetrieveParams = EInvoiceAPI::Models::MeRetrieveParams
+
   OutboxListDraftDocumentsParams =
     EInvoiceAPI::Models::OutboxListDraftDocumentsParams
 

data/rbi/e_invoice_api/resources/documents/ubl.rbi

@@ -4,6 +4,16 @@ module EInvoiceAPI
   module Resources
     class Documents
       class Ubl
+        # Create a new invoice or credit note from a UBL file
+        sig do
+          params(
+            file: EInvoiceAPI::Internal::FileInput,
+            request_options: EInvoiceAPI::RequestOptions::OrHash
+          ).returns(EInvoiceAPI::DocumentResponse)
+        end
+        def create_from_ubl(file:, request_options: {})
+        end
+
         # Get the UBL for an invoice or credit note
         sig do
           params(

data/rbi/e_invoice_api/resources/documents.rbi

@@ -12,12 +12,16 @@ module EInvoiceAPI
       # Create a new invoice or credit note
       sig do
         params(
+          allowances:
+            T.nilable(T::Array[EInvoiceAPI::DocumentCreate::Allowance::OrHash]),
           amount_due:
             T.nilable(EInvoiceAPI::DocumentCreate::AmountDue::Variants),
           attachments:
             T.nilable(T::Array[EInvoiceAPI::DocumentAttachmentCreate::OrHash]),
           billing_address: T.nilable(String),
           billing_address_recipient: T.nilable(String),
+          charges:
+            T.nilable(T::Array[EInvoiceAPI::DocumentCreate::Charge::OrHash]),
           currency: EInvoiceAPI::CurrencyCode::OrSymbol,
           customer_address: T.nilable(String),
           customer_address_recipient: T.nilable(String),
@@ -32,7 +36,7 @@ module EInvoiceAPI
           invoice_id: T.nilable(String),
           invoice_total:
             T.nilable(EInvoiceAPI::DocumentCreate::InvoiceTotal::Variants),
-          items: T.nilable(T::Array[EInvoiceAPI::DocumentCreate::Item::OrHash]),
+          items: T::Array[EInvoiceAPI::DocumentCreate::Item::OrHash],
           note: T.nilable(String),
           payment_details:
             T.nilable(T::Array[EInvoiceAPI::PaymentDetailCreate::OrHash]),
@@ -69,10 +73,14 @@ module EInvoiceAPI
         ).returns(EInvoiceAPI::DocumentResponse)
       end
       def create(
+        allowances: nil,
+        # The amount due of the invoice. Must be positive and rounded to maximum 2
+        # decimals
         amount_due: nil,
         attachments: nil,
         billing_address: nil,
         billing_address_recipient: nil,
+        charges: nil,
         # Currency of the invoice
         currency: nil,
         customer_address: nil,
@@ -86,11 +94,16 @@ module EInvoiceAPI
         due_date: nil,
         invoice_date: nil,
         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
         invoice_total: nil,
+        # At least one line item is required
         items: nil,
         note: nil,
         payment_details: nil,
         payment_term: nil,
+        # The previous unpaid balance of the invoice, if any. Must be positive and rounded
+        # to maximum 2 decimals
         previous_unpaid_balance: nil,
         purchase_order: nil,
         remittance_address: nil,
@@ -102,11 +115,17 @@ module EInvoiceAPI
         shipping_address: nil,
         shipping_address_recipient: nil,
         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_code: nil,
         tax_details: nil,
+        # The total financial discount of the invoice (so discounts not subject to VAT).
+        # Must be positive and rounded to maximum 2 decimals
         total_discount: nil,
+        # The total tax of the invoice. Must be positive and rounded to maximum 2 decimals
         total_tax: nil,
         # VATEX code list for VAT exemption reasons
         #
@@ -143,6 +162,30 @@ module EInvoiceAPI
       def delete(document_id, request_options: {})
       end
 
+      # Create a new invoice or credit note from a PDF file. If the 'ubl_document' field
+      # is set in the response, it indicates that sufficient details were extracted from
+      # the PDF to automatically generate a valid UBL document ready for sending. If
+      # 'ubl_document' is not set, human intervention may be required to ensure
+      # compliance.
+      sig do
+        params(
+          file: EInvoiceAPI::Internal::FileInput,
+          customer_tax_id: T.nilable(String),
+          vendor_tax_id: T.nilable(String),
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(EInvoiceAPI::Models::DocumentCreateFromPdfResponse)
+      end
+      def create_from_pdf(
+        # Body param:
+        file:,
+        # Query param:
+        customer_tax_id: nil,
+        # Query param:
+        vendor_tax_id: nil,
+        request_options: {}
+      )
+      end
+
       # Send an invoice or credit note via Peppol
       sig do
         params(
@@ -166,6 +209,16 @@ module EInvoiceAPI
       )
       end
 
+      # Validate a UBL document according to Peppol BIS Billing 3.0
+      sig do
+        params(
+          document_id: String,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(EInvoiceAPI::UblDocumentValidation)
+      end
+      def validate(document_id, request_options: {})
+      end
+
       # @api private
       sig { params(client: EInvoiceAPI::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/e_invoice_api/resources/me.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Resources
+    class Me
+      # Retrieve information about your account.
+      sig do
+        params(request_options: EInvoiceAPI::RequestOptions::OrHash).returns(
+          EInvoiceAPI::Models::MeRetrieveResponse
+        )
+      end
+      def retrieve(request_options: {})
+      end
+
+      # @api private
+      sig { params(client: EInvoiceAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/resources/validate.rbi

@@ -6,12 +6,16 @@ module EInvoiceAPI
       # Validate if the JSON document can be converted to a valid UBL document
       sig do
         params(
+          allowances:
+            T.nilable(T::Array[EInvoiceAPI::DocumentCreate::Allowance::OrHash]),
           amount_due:
             T.nilable(EInvoiceAPI::DocumentCreate::AmountDue::Variants),
           attachments:
             T.nilable(T::Array[EInvoiceAPI::DocumentAttachmentCreate::OrHash]),
           billing_address: T.nilable(String),
           billing_address_recipient: T.nilable(String),
+          charges:
+            T.nilable(T::Array[EInvoiceAPI::DocumentCreate::Charge::OrHash]),
           currency: EInvoiceAPI::CurrencyCode::OrSymbol,
           customer_address: T.nilable(String),
           customer_address_recipient: T.nilable(String),
@@ -26,7 +30,7 @@ module EInvoiceAPI
           invoice_id: T.nilable(String),
           invoice_total:
             T.nilable(EInvoiceAPI::DocumentCreate::InvoiceTotal::Variants),
-          items: T.nilable(T::Array[EInvoiceAPI::DocumentCreate::Item::OrHash]),
+          items: T::Array[EInvoiceAPI::DocumentCreate::Item::OrHash],
           note: T.nilable(String),
           payment_details:
             T.nilable(T::Array[EInvoiceAPI::PaymentDetailCreate::OrHash]),
@@ -63,10 +67,14 @@ module EInvoiceAPI
         ).returns(EInvoiceAPI::UblDocumentValidation)
       end
       def validate_json(
+        allowances: nil,
+        # The amount due of the invoice. Must be positive and rounded to maximum 2
+        # decimals
         amount_due: nil,
         attachments: nil,
         billing_address: nil,
         billing_address_recipient: nil,
+        charges: nil,
         # Currency of the invoice
         currency: nil,
         customer_address: nil,
@@ -80,11 +88,16 @@ module EInvoiceAPI
         due_date: nil,
         invoice_date: nil,
         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
         invoice_total: nil,
+        # At least one line item is required
         items: nil,
         note: nil,
         payment_details: nil,
         payment_term: nil,
+        # The previous unpaid balance of the invoice, if any. Must be positive and rounded
+        # to maximum 2 decimals
         previous_unpaid_balance: nil,
         purchase_order: nil,
         remittance_address: nil,
@@ -96,11 +109,17 @@ module EInvoiceAPI
         shipping_address: nil,
         shipping_address_recipient: nil,
         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_code: nil,
         tax_details: nil,
+        # The total financial discount of the invoice (so discounts not subject to VAT).
+        # Must be positive and rounded to maximum 2 decimals
         total_discount: nil,
+        # The total tax of the invoice. Must be positive and rounded to maximum 2 decimals
         total_tax: nil,
         # VATEX code list for VAT exemption reasons
         #

data/sig/e_invoice_api/client.rbs

@@ -20,6 +20,8 @@ module EInvoiceAPI
 
     attr_reader lookup: EInvoiceAPI::Resources::Lookup
 
+    attr_reader me: EInvoiceAPI::Resources::Me
+
     attr_reader webhooks: EInvoiceAPI::Resources::Webhooks
 
     private def auth_headers: -> ::Hash[String, String]

data/sig/e_invoice_api/models/allowance.rbs

@@ -0,0 +1,69 @@
+module EInvoiceAPI
+  module Models
+    type allowance =
+      {
+        amount: String?,
+        base_amount: String?,
+        multiplier_factor: String?,
+        reason: String?,
+        reason_code: String?,
+        tax_code: EInvoiceAPI::Models::Allowance::tax_code?,
+        tax_rate: String?
+      }
+
+    class Allowance < EInvoiceAPI::Internal::Type::BaseModel
+      attr_accessor amount: String?
+
+      attr_accessor base_amount: String?
+
+      attr_accessor multiplier_factor: String?
+
+      attr_accessor reason: String?
+
+      attr_accessor reason_code: String?
+
+      attr_accessor tax_code: EInvoiceAPI::Models::Allowance::tax_code?
+
+      attr_accessor tax_rate: String?
+
+      def initialize: (
+        ?amount: String?,
+        ?base_amount: String?,
+        ?multiplier_factor: String?,
+        ?reason: String?,
+        ?reason_code: String?,
+        ?tax_code: EInvoiceAPI::Models::Allowance::tax_code?,
+        ?tax_rate: String?
+      ) -> void
+
+      def to_hash: -> {
+        amount: String?,
+        base_amount: String?,
+        multiplier_factor: String?,
+        reason: String?,
+        reason_code: String?,
+        tax_code: EInvoiceAPI::Models::Allowance::tax_code?,
+        tax_rate: String?
+      }
+
+      type tax_code = :AE | :E | :S | :Z | :G | :O | :K | :L | :M | :B
+
+      module TaxCode
+        extend EInvoiceAPI::Internal::Type::Enum
+
+        AE: :AE
+        E: :E
+        S: :S
+        Z: :Z
+        G: :G
+        O: :O
+        K: :K
+        L: :L
+        M: :M
+        B: :B
+
+        def self?.values: -> ::Array[EInvoiceAPI::Models::Allowance::tax_code]
+      end
+    end
+  end
+end