e-invoice-api 0.33.0 → 0.34.0

data/rbi/e_invoice_api/models/document_create_from_pdf_response.rbi

@@ -31,6 +31,11 @@ module EInvoiceAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :billing_address_recipient
 
+      # The buyer reference (BT-10), e.g. a cost centre or accounting reference
+      # requested by the buyer
+      sig { returns(T.nilable(String)) }
+      attr_accessor :buyer_reference
+
       sig { returns(T.nilable(T::Array[EInvoiceAPI::Charge])) }
       attr_accessor :charges
 
@@ -70,6 +75,10 @@ module EInvoiceAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :customer_peppol_id
 
+      # The telephone number of the customer contact (BT-57)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :customer_phone
+
       # Customer tax ID. For Belgium this is the VAT number. Must include the country
       # prefix
       sig { returns(T.nilable(String)) }
@@ -145,6 +154,15 @@ module EInvoiceAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :payment_term
 
+      # The preceding invoice issue date (BT-26)
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :preceding_invoice_date
+
+      # The preceding invoice reference (BT-25): the number of the invoice this document
+      # corrects, for example the invoice a credit note credits
+      sig { returns(T.nilable(String)) }
+      attr_accessor :preceding_invoice_id
+
       # The purchase order reference number
       sig { returns(T.nilable(String)) }
       attr_accessor :purchase_order
@@ -157,6 +175,17 @@ module EInvoiceAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :remittance_address_recipient
 
+      # The amount added to the invoice total to round the amount for payment (BT-114),
+      # for example to whole kronor (amount_due = invoice_total + rounding_amount when
+      # nothing is prepaid). Can be negative. Between -5.00 and 5.00, rounded to maximum
+      # 2 decimals
+      sig { returns(T.nilable(String)) }
+      attr_accessor :rounding_amount
+
+      # The sales order reference (BT-14) assigned by the seller
+      sig { returns(T.nilable(String)) }
+      attr_accessor :sales_order
+
       # The address where services were performed or goods were delivered
       sig { returns(T.nilable(String)) }
       attr_accessor :service_address
@@ -220,6 +249,12 @@ module EInvoiceAPI
       end
       attr_writer :tax_code
 
+      # The VAT accounting currency (BT-6, ISO 4217 currency code), when VAT is
+      # accounted in a currency other than the invoice currency. Must differ from
+      # currency and requires total_tax_in_tax_currency
+      sig { returns(T.nilable(String)) }
+      attr_accessor :tax_currency
+
       sig do
         returns(
           T.nilable(
@@ -242,6 +277,11 @@ module EInvoiceAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :total_tax
 
+      # The total VAT amount in the VAT accounting currency tax_currency (BT-111). Does
+      # not add to invoice_total. Requires tax_currency. Rounded to maximum 2 decimals
+      sig { returns(T.nilable(String)) }
+      attr_accessor :total_tax_in_tax_currency
+
       # The UBL document as an XML string
       sig { returns(T.nilable(String)) }
       attr_accessor :ubl_document
@@ -283,6 +323,12 @@ module EInvoiceAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :vendor_name
 
+      # The telephone number of the vendor contact (BT-42). Required when vendor and
+      # customer are both in Germany (DE-R-006); it must then hold at least 3 digits
+      # (DE-R-027, a warning).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :vendor_phone
+
       # Vendor tax ID. For Belgium this is the VAT number. Must include the country
       # prefix
       sig { returns(T.nilable(String)) }
@@ -296,6 +342,7 @@ module EInvoiceAPI
             T.nilable(T::Array[EInvoiceAPI::DocumentAttachmentCreate::OrHash]),
           billing_address: T.nilable(String),
           billing_address_recipient: T.nilable(String),
+          buyer_reference: T.nilable(String),
           charges: T.nilable(T::Array[EInvoiceAPI::Charge::OrHash]),
           currency: EInvoiceAPI::CurrencyCode::OrSymbol,
           customer_address: T.nilable(String),
@@ -305,6 +352,7 @@ module EInvoiceAPI
           customer_id: T.nilable(String),
           customer_name: T.nilable(String),
           customer_peppol_id: T.nilable(String),
+          customer_phone: T.nilable(String),
           customer_tax_id: T.nilable(String),
           direction: EInvoiceAPI::DocumentDirection::OrSymbol,
           document_type: EInvoiceAPI::DocumentType::OrSymbol,
@@ -322,9 +370,13 @@ module EInvoiceAPI
           payment_details:
             T.nilable(T::Array[EInvoiceAPI::PaymentDetailCreate::OrHash]),
           payment_term: T.nilable(String),
+          preceding_invoice_date: T.nilable(Date),
+          preceding_invoice_id: T.nilable(String),
           purchase_order: T.nilable(String),
           remittance_address: T.nilable(String),
           remittance_address_recipient: T.nilable(String),
+          rounding_amount: T.nilable(String),
+          sales_order: T.nilable(String),
           service_address: T.nilable(String),
           service_address_recipient: T.nilable(String),
           service_end_date: T.nilable(Date),
@@ -336,6 +388,7 @@ module EInvoiceAPI
           success: T::Boolean,
           tax_code:
             EInvoiceAPI::Models::DocumentCreateFromPdfResponse::TaxCode::OrSymbol,
+          tax_currency: T.nilable(String),
           tax_details:
             T.nilable(
               T::Array[
@@ -344,6 +397,7 @@ module EInvoiceAPI
             ),
           total_discount: T.nilable(String),
           total_tax: T.nilable(String),
+          total_tax_in_tax_currency: T.nilable(String),
           ubl_document: T.nilable(String),
           vatex:
             T.nilable(
@@ -355,6 +409,7 @@ module EInvoiceAPI
           vendor_company_id: T.nilable(String),
           vendor_email: T.nilable(String),
           vendor_name: T.nilable(String),
+          vendor_phone: T.nilable(String),
           vendor_tax_id: T.nilable(String)
         ).returns(T.attached_class)
       end
@@ -367,6 +422,9 @@ module EInvoiceAPI
         billing_address: nil,
         # The recipient name at the billing address
         billing_address_recipient: nil,
+        # The buyer reference (BT-10), e.g. a cost centre or accounting reference
+        # requested by the buyer
+        buyer_reference: nil,
         charges: nil,
         # Currency of the invoice (ISO 4217 currency code)
         currency: nil,
@@ -385,6 +443,8 @@ module EInvoiceAPI
         customer_name: nil,
         # Customer Peppol ID
         customer_peppol_id: nil,
+        # The telephone number of the customer contact (BT-57)
+        customer_phone: nil,
         # Customer tax ID. For Belgium this is the VAT number. Must include the country
         # prefix
         customer_tax_id: nil,
@@ -412,12 +472,24 @@ module EInvoiceAPI
         payment_details: nil,
         # The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
         payment_term: nil,
+        # The preceding invoice issue date (BT-26)
+        preceding_invoice_date: nil,
+        # The preceding invoice reference (BT-25): the number of the invoice this document
+        # corrects, for example the invoice a credit note credits
+        preceding_invoice_id: 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 amount added to the invoice total to round the amount for payment (BT-114),
+        # for example to whole kronor (amount_due = invoice_total + rounding_amount when
+        # nothing is prepaid). Can be negative. Between -5.00 and 5.00, rounded to maximum
+        # 2 decimals
+        rounding_amount: nil,
+        # The sales order reference (BT-14) assigned by the seller
+        sales_order: nil,
         # The address where services were performed or goods were delivered
         service_address: nil,
         # The recipient name at the service address
@@ -441,6 +513,10 @@ module EInvoiceAPI
         # Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E
         # for exempt)
         tax_code: nil,
+        # The VAT accounting currency (BT-6, ISO 4217 currency code), when VAT is
+        # accounted in a currency other than the invoice currency. Must differ from
+        # currency and requires total_tax_in_tax_currency
+        tax_currency: 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.
@@ -449,6 +525,9 @@ module EInvoiceAPI
         # The total tax amount of the invoice. Must be positive and rounded to maximum 2
         # decimals
         total_tax: nil,
+        # The total VAT amount in the VAT accounting currency tax_currency (BT-111). Does
+        # not add to invoice_total. Requires tax_currency. Rounded to maximum 2 decimals
+        total_tax_in_tax_currency: nil,
         # The UBL document as an XML string
         ubl_document: nil,
         # VATEX code list for VAT exemption reasons
@@ -468,6 +547,10 @@ module EInvoiceAPI
         vendor_email: nil,
         # The name of the vendor/seller/supplier
         vendor_name: nil,
+        # The telephone number of the vendor contact (BT-42). Required when vendor and
+        # customer are both in Germany (DE-R-006); it must then hold at least 3 digits
+        # (DE-R-027, a warning).
+        vendor_phone: nil,
         # Vendor tax ID. For Belgium this is the VAT number. Must include the country
         # prefix
         vendor_tax_id: nil
@@ -483,6 +566,7 @@ module EInvoiceAPI
               T.nilable(T::Array[EInvoiceAPI::DocumentAttachmentCreate]),
             billing_address: T.nilable(String),
             billing_address_recipient: T.nilable(String),
+            buyer_reference: T.nilable(String),
             charges: T.nilable(T::Array[EInvoiceAPI::Charge]),
             currency: EInvoiceAPI::CurrencyCode::TaggedSymbol,
             customer_address: T.nilable(String),
@@ -492,6 +576,7 @@ module EInvoiceAPI
             customer_id: T.nilable(String),
             customer_name: T.nilable(String),
             customer_peppol_id: T.nilable(String),
+            customer_phone: T.nilable(String),
             customer_tax_id: T.nilable(String),
             direction: EInvoiceAPI::DocumentDirection::TaggedSymbol,
             document_type: EInvoiceAPI::DocumentType::TaggedSymbol,
@@ -509,9 +594,13 @@ module EInvoiceAPI
             payment_details:
               T.nilable(T::Array[EInvoiceAPI::PaymentDetailCreate]),
             payment_term: T.nilable(String),
+            preceding_invoice_date: T.nilable(Date),
+            preceding_invoice_id: T.nilable(String),
             purchase_order: T.nilable(String),
             remittance_address: T.nilable(String),
             remittance_address_recipient: T.nilable(String),
+            rounding_amount: T.nilable(String),
+            sales_order: T.nilable(String),
             service_address: T.nilable(String),
             service_address_recipient: T.nilable(String),
             service_end_date: T.nilable(Date),
@@ -523,6 +612,7 @@ module EInvoiceAPI
             success: T::Boolean,
             tax_code:
               EInvoiceAPI::Models::DocumentCreateFromPdfResponse::TaxCode::TaggedSymbol,
+            tax_currency: T.nilable(String),
             tax_details:
               T.nilable(
                 T::Array[
@@ -531,6 +621,7 @@ module EInvoiceAPI
               ),
             total_discount: T.nilable(String),
             total_tax: T.nilable(String),
+            total_tax_in_tax_currency: T.nilable(String),
             ubl_document: T.nilable(String),
             vatex:
               T.nilable(
@@ -542,6 +633,7 @@ module EInvoiceAPI
             vendor_company_id: T.nilable(String),
             vendor_email: T.nilable(String),
             vendor_name: T.nilable(String),
+            vendor_phone: T.nilable(String),
             vendor_tax_id: T.nilable(String)
           }
         )
@@ -573,7 +665,7 @@ module EInvoiceAPI
         sig { returns(T.nilable(T::Array[EInvoiceAPI::Charge])) }
         attr_accessor :charges
 
-        sig { returns(NilClass) }
+        sig { returns(T.nilable(Date)) }
         attr_accessor :date
 
         # The description of the line item.
@@ -592,6 +684,22 @@ module EInvoiceAPI
         end
         attr_accessor :item_attributes
 
+        # The item name (BT-153), for example the product name. Written to
+        # cac:Item/cbc:Name. When omitted or blank, `description` (BT-154) is used as the
+        # item name. A posted line item needs a `name` or a `description`; a line item
+        # with neither is rejected with 422.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The item price base quantity (BT-149). The number of item units to which the
+        # unit price applies, for example 100 when the unit price is a price for each 100
+        # units. Must be greater than 0. Defaults to 1.
+        sig { returns(T.nilable(String)) }
+        attr_reader :price_base_quantity
+
+        sig { params(price_base_quantity: String).void }
+        attr_writer :price_base_quantity
+
         # The product code of the line item.
         sig { returns(T.nilable(String)) }
         attr_accessor :product_code
@@ -625,7 +733,7 @@ module EInvoiceAPI
             allowances: T.nilable(T::Array[EInvoiceAPI::Allowance::OrHash]),
             amount: T.nilable(String),
             charges: T.nilable(T::Array[EInvoiceAPI::Charge::OrHash]),
-            date: NilClass,
+            date: T.nilable(Date),
             description: T.nilable(String),
             item_attributes:
               T.nilable(
@@ -633,6 +741,8 @@ module EInvoiceAPI
                   EInvoiceAPI::Models::DocumentCreateFromPdfResponse::Item::ItemAttribute::OrHash
                 ]
               ),
+            name: T.nilable(String),
+            price_base_quantity: String,
             product_code: T.nilable(String),
             quantity: T.nilable(String),
             tax: T.nilable(String),
@@ -656,6 +766,15 @@ module EInvoiceAPI
           description: nil,
           # Item-level attributes (BG-32) from cac:AdditionalItemProperty.
           item_attributes: nil,
+          # The item name (BT-153), for example the product name. Written to
+          # cac:Item/cbc:Name. When omitted or blank, `description` (BT-154) is used as the
+          # item name. A posted line item needs a `name` or a `description`; a line item
+          # with neither is rejected with 422.
+          name: nil,
+          # The item price base quantity (BT-149). The number of item units to which the
+          # unit price applies, for example 100 when the unit price is a price for each 100
+          # units. Must be greater than 0. Defaults to 1.
+          price_base_quantity: nil,
           # The product code of the line item.
           product_code: nil,
           # The quantity of items (goods or services) that is the subject of the line item.
@@ -681,7 +800,7 @@ module EInvoiceAPI
               allowances: T.nilable(T::Array[EInvoiceAPI::Allowance]),
               amount: T.nilable(String),
               charges: T.nilable(T::Array[EInvoiceAPI::Charge]),
-              date: NilClass,
+              date: T.nilable(Date),
               description: T.nilable(String),
               item_attributes:
                 T.nilable(
@@ -689,6 +808,8 @@ module EInvoiceAPI
                     EInvoiceAPI::Models::DocumentCreateFromPdfResponse::Item::ItemAttribute
                   ]
                 ),
+              name: T.nilable(String),
+              price_base_quantity: String,
               product_code: T.nilable(String),
               quantity: T.nilable(String),
               tax: T.nilable(String),

data/rbi/e_invoice_api/models/document_lifecycle_params.rbi

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