e-invoice-api 0.33.0 → 0.34.0

data/rbi/e_invoice_api/models/document_create.rbi

@@ -32,6 +32,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::DocumentCreate::Charge])) }
       attr_accessor :charges
 
@@ -71,6 +76,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)) }
@@ -129,6 +138,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 previous unpaid balance from prior invoices, if any. Must be positive and
       # rounded to maximum 2 decimals
       sig do
@@ -152,6 +170,21 @@ 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 do
+        returns(
+          T.nilable(EInvoiceAPI::DocumentCreate::RoundingAmount::Variants)
+        )
+      end
+      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
@@ -201,6 +234,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(T::Array[EInvoiceAPI::DocumentCreate::TaxDetail]))
       end
@@ -221,6 +260,17 @@ module EInvoiceAPI
       end
       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 do
+        returns(
+          T.nilable(
+            EInvoiceAPI::DocumentCreate::TotalTaxInTaxCurrency::Variants
+          )
+        )
+      end
+      attr_accessor :total_tax_in_tax_currency
+
       # VATEX code list for VAT exemption reasons
       #
       # Agency: CEF Identifier: vatex
@@ -252,6 +302,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)) }
@@ -267,6 +323,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::DocumentCreate::Charge::OrHash]),
           currency: EInvoiceAPI::CurrencyCode::OrSymbol,
@@ -277,6 +334,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,
@@ -290,6 +348,8 @@ 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),
           previous_unpaid_balance:
             T.nilable(
               EInvoiceAPI::DocumentCreate::PreviousUnpaidBalance::Variants
@@ -297,6 +357,9 @@ module EInvoiceAPI
           purchase_order: T.nilable(String),
           remittance_address: T.nilable(String),
           remittance_address_recipient: T.nilable(String),
+          rounding_amount:
+            T.nilable(EInvoiceAPI::DocumentCreate::RoundingAmount::Variants),
+          sales_order: T.nilable(String),
           service_address: T.nilable(String),
           service_address_recipient: T.nilable(String),
           service_end_date: T.nilable(Date),
@@ -306,11 +369,16 @@ module EInvoiceAPI
           state: EInvoiceAPI::DocumentState::OrSymbol,
           subtotal: T.nilable(EInvoiceAPI::DocumentCreate::Subtotal::Variants),
           tax_code: EInvoiceAPI::DocumentCreate::TaxCode::OrSymbol,
+          tax_currency: T.nilable(String),
           tax_details:
             T.nilable(T::Array[EInvoiceAPI::DocumentCreate::TaxDetail::OrHash]),
           total_discount:
             T.nilable(EInvoiceAPI::DocumentCreate::TotalDiscount::Variants),
           total_tax: T.nilable(EInvoiceAPI::DocumentCreate::TotalTax::Variants),
+          total_tax_in_tax_currency:
+            T.nilable(
+              EInvoiceAPI::DocumentCreate::TotalTaxInTaxCurrency::Variants
+            ),
           vatex: T.nilable(EInvoiceAPI::DocumentCreate::Vatex::OrSymbol),
           vatex_note: T.nilable(String),
           vendor_address: T.nilable(String),
@@ -318,6 +386,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
@@ -330,6 +399,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,
@@ -348,6 +420,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,
@@ -371,6 +445,11 @@ 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 previous unpaid balance from prior invoices, if any. Must be positive and
         # rounded to maximum 2 decimals
         previous_unpaid_balance: nil,
@@ -380,6 +459,13 @@ module EInvoiceAPI
         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
@@ -401,6 +487,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.
@@ -409,6 +499,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,
         # VATEX code list for VAT exemption reasons
         #
         # Agency: CEF Identifier: vatex
@@ -426,6 +519,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
@@ -443,6 +540,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::DocumentCreate::Charge]),
             currency: EInvoiceAPI::CurrencyCode::OrSymbol,
             customer_address: T.nilable(String),
@@ -452,6 +550,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,
@@ -465,6 +564,8 @@ 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),
             previous_unpaid_balance:
               T.nilable(
                 EInvoiceAPI::DocumentCreate::PreviousUnpaidBalance::Variants
@@ -472,6 +573,9 @@ module EInvoiceAPI
             purchase_order: T.nilable(String),
             remittance_address: T.nilable(String),
             remittance_address_recipient: T.nilable(String),
+            rounding_amount:
+              T.nilable(EInvoiceAPI::DocumentCreate::RoundingAmount::Variants),
+            sales_order: T.nilable(String),
             service_address: T.nilable(String),
             service_address_recipient: T.nilable(String),
             service_end_date: T.nilable(Date),
@@ -482,12 +586,17 @@ module EInvoiceAPI
             subtotal:
               T.nilable(EInvoiceAPI::DocumentCreate::Subtotal::Variants),
             tax_code: EInvoiceAPI::DocumentCreate::TaxCode::OrSymbol,
+            tax_currency: T.nilable(String),
             tax_details:
               T.nilable(T::Array[EInvoiceAPI::DocumentCreate::TaxDetail]),
             total_discount:
               T.nilable(EInvoiceAPI::DocumentCreate::TotalDiscount::Variants),
             total_tax:
               T.nilable(EInvoiceAPI::DocumentCreate::TotalTax::Variants),
+            total_tax_in_tax_currency:
+              T.nilable(
+                EInvoiceAPI::DocumentCreate::TotalTaxInTaxCurrency::Variants
+              ),
             vatex: T.nilable(EInvoiceAPI::DocumentCreate::Vatex::OrSymbol),
             vatex_note: T.nilable(String),
             vendor_address: T.nilable(String),
@@ -495,6 +604,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)
           }
         )
@@ -2188,7 +2298,7 @@ module EInvoiceAPI
         end
         attr_accessor :charges
 
-        sig { returns(NilClass) }
+        sig { returns(T.nilable(Date)) }
         attr_accessor :date
 
         # The description of the line item.
@@ -2205,6 +2315,33 @@ 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 do
+          returns(
+            T.nilable(
+              EInvoiceAPI::DocumentCreate::Item::PriceBaseQuantity::Variants
+            )
+          )
+        end
+        attr_reader :price_base_quantity
+
+        sig do
+          params(
+            price_base_quantity:
+              EInvoiceAPI::DocumentCreate::Item::PriceBaseQuantity::Variants
+          ).void
+        end
+        attr_writer :price_base_quantity
+
         # The product code of the line item.
         sig { returns(T.nilable(String)) }
         attr_accessor :product_code
@@ -2259,7 +2396,7 @@ module EInvoiceAPI
               T.nilable(
                 T::Array[EInvoiceAPI::DocumentCreate::Item::Charge::OrHash]
               ),
-            date: NilClass,
+            date: T.nilable(Date),
             description: T.nilable(String),
             item_attributes:
               T.nilable(
@@ -2267,6 +2404,9 @@ module EInvoiceAPI
                   EInvoiceAPI::DocumentCreate::Item::ItemAttribute::OrHash
                 ]
               ),
+            name: T.nilable(String),
+            price_base_quantity:
+              EInvoiceAPI::DocumentCreate::Item::PriceBaseQuantity::Variants,
             product_code: T.nilable(String),
             quantity:
               T.nilable(EInvoiceAPI::DocumentCreate::Item::Quantity::Variants),
@@ -2293,6 +2433,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.
@@ -2323,12 +2472,15 @@ module EInvoiceAPI
                 T.nilable(EInvoiceAPI::DocumentCreate::Item::Amount::Variants),
               charges:
                 T.nilable(T::Array[EInvoiceAPI::DocumentCreate::Item::Charge]),
-              date: NilClass,
+              date: T.nilable(Date),
               description: T.nilable(String),
               item_attributes:
                 T.nilable(
                   T::Array[EInvoiceAPI::DocumentCreate::Item::ItemAttribute]
                 ),
+              name: T.nilable(String),
+              price_base_quantity:
+                EInvoiceAPI::DocumentCreate::Item::PriceBaseQuantity::Variants,
               product_code: T.nilable(String),
               quantity:
                 T.nilable(
@@ -4064,6 +4216,25 @@ module EInvoiceAPI
           end
         end
 
+        # 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.
+        module PriceBaseQuantity
+          extend EInvoiceAPI::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(Float, String) }
+
+          sig do
+            override.returns(
+              T::Array[
+                EInvoiceAPI::DocumentCreate::Item::PriceBaseQuantity::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
         # The quantity of items (goods or services) that is the subject of the line item.
         # Must be rounded to maximum 4 decimals. Can be negative for credit notes or
         # corrections.
@@ -4147,6 +4318,24 @@ module EInvoiceAPI
         end
       end
 
+      # 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
+      module RoundingAmount
+        extend EInvoiceAPI::Internal::Type::Union
+
+        Variants = T.type_alias { T.any(Float, String) }
+
+        sig do
+          override.returns(
+            T::Array[EInvoiceAPI::DocumentCreate::RoundingAmount::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+
       # 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
@@ -4294,6 +4483,24 @@ module EInvoiceAPI
         end
       end
 
+      # 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
+      module TotalTaxInTaxCurrency
+        extend EInvoiceAPI::Internal::Type::Union
+
+        Variants = T.type_alias { T.any(Float, String) }
+
+        sig do
+          override.returns(
+            T::Array[
+              EInvoiceAPI::DocumentCreate::TotalTaxInTaxCurrency::Variants
+            ]
+          )
+        end
+        def self.variants
+        end
+      end
+
       # VATEX code list for VAT exemption reasons
       #
       # Agency: CEF Identifier: vatex