e-invoice-api 0.5.3 → 0.7.0

data/lib/e_invoice_api/models/document_create.rb

@@ -3,7 +3,16 @@
 module EInvoiceAPI
   module Models
     class DocumentCreate < EInvoiceAPI::Internal::Type::BaseModel
+      # @!attribute allowances
+      #
+      #   @return [Array<EInvoiceAPI::Models::DocumentCreate::Allowance>, nil]
+      optional :allowances,
+               -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::DocumentCreate::Allowance] },
+               nil?: true
+
       # @!attribute amount_due
+      #   The amount due of the invoice. Must be positive and rounded to maximum 2
+      #   decimals
       #
       #   @return [Float, String, nil]
       optional :amount_due, union: -> { EInvoiceAPI::DocumentCreate::AmountDue }, nil?: true
@@ -25,6 +34,13 @@ module EInvoiceAPI
       #   @return [String, nil]
       optional :billing_address_recipient, String, nil?: true
 
+      # @!attribute charges
+      #
+      #   @return [Array<EInvoiceAPI::Models::DocumentCreate::Charge>, nil]
+      optional :charges,
+               -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::DocumentCreate::Charge] },
+               nil?: true
+
       # @!attribute currency
       #   Currency of the invoice
       #
@@ -87,16 +103,17 @@ module EInvoiceAPI
       optional :invoice_id, String, nil?: true
 
       # @!attribute invoice_total
+      #   The total amount of the invoice (so invoice_total = subtotal + total_tax +
+      #   total_discount). Must be positive and rounded to maximum 2 decimals
       #
       #   @return [Float, String, nil]
       optional :invoice_total, union: -> { EInvoiceAPI::DocumentCreate::InvoiceTotal }, nil?: true
 
       # @!attribute items
+      #   At least one line item is required
       #
       #   @return [Array<EInvoiceAPI::Models::DocumentCreate::Item>, nil]
-      optional :items,
-               -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::DocumentCreate::Item] },
-               nil?: true
+      optional :items, -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::DocumentCreate::Item] }
 
       # @!attribute note
       #
@@ -116,6 +133,8 @@ module EInvoiceAPI
       optional :payment_term, String, nil?: true
 
       # @!attribute previous_unpaid_balance
+      #   The previous unpaid balance of the invoice, if any. Must be positive and rounded
+      #   to maximum 2 decimals
       #
       #   @return [Float, String, nil]
       optional :previous_unpaid_balance,
@@ -173,10 +192,19 @@ module EInvoiceAPI
       optional :state, enum: -> { EInvoiceAPI::DocumentState }
 
       # @!attribute subtotal
+      #   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
       #
       #   @return [Float, String, nil]
       optional :subtotal, union: -> { EInvoiceAPI::DocumentCreate::Subtotal }, nil?: true
 
+      # @!attribute tax_code
+      #   Tax category code of the invoice
+      #
+      #   @return [Symbol, EInvoiceAPI::Models::DocumentCreate::TaxCode, nil]
+      optional :tax_code, enum: -> { EInvoiceAPI::DocumentCreate::TaxCode }
+
       # @!attribute tax_details
       #
       #   @return [Array<EInvoiceAPI::Models::DocumentCreate::TaxDetail>, nil]
@@ -185,15 +213,32 @@ module EInvoiceAPI
                nil?: true
 
       # @!attribute total_discount
+      #   The total financial discount of the invoice (so discounts not subject to VAT).
+      #   Must be positive and rounded to maximum 2 decimals
       #
       #   @return [Float, String, nil]
       optional :total_discount, union: -> { EInvoiceAPI::DocumentCreate::TotalDiscount }, nil?: true
 
       # @!attribute total_tax
+      #   The total tax of the invoice. Must be positive and rounded to maximum 2 decimals
       #
       #   @return [Float, String, nil]
       optional :total_tax, union: -> { EInvoiceAPI::DocumentCreate::TotalTax }, nil?: true
 
+      # @!attribute vatex
+      #   VATEX code list for VAT exemption reasons
+      #
+      #   Agency: CEF Identifier: vatex
+      #
+      #   @return [Symbol, EInvoiceAPI::Models::DocumentCreate::Vatex, nil]
+      optional :vatex, enum: -> { EInvoiceAPI::DocumentCreate::Vatex }, nil?: true
+
+      # @!attribute vatex_note
+      #   VAT exemption note of the invoice
+      #
+      #   @return [String, nil]
+      optional :vatex_note, String, nil?: true
+
       # @!attribute vendor_address
       #
       #   @return [String, nil]
@@ -219,8 +264,13 @@ module EInvoiceAPI
       #   @return [String, nil]
       optional :vendor_tax_id, String, nil?: true
 
-      # @!method initialize(amount_due: nil, attachments: nil, billing_address: nil, billing_address_recipient: nil, currency: nil, customer_address: nil, customer_address_recipient: nil, customer_email: nil, customer_id: nil, customer_name: 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, previous_unpaid_balance: 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, tax_details: nil, total_discount: nil, total_tax: nil, vendor_address: nil, vendor_address_recipient: nil, vendor_email: nil, vendor_name: nil, vendor_tax_id: nil)
-      #   @param amount_due [Float, String, 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_email: nil, customer_id: nil, customer_name: 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, previous_unpaid_balance: 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, tax_code: nil, tax_details: nil, total_discount: nil, total_tax: nil, vatex: nil, vatex_note: nil, vendor_address: nil, vendor_address_recipient: nil, vendor_email: nil, vendor_name: nil, vendor_tax_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {EInvoiceAPI::Models::DocumentCreate} for more details.
+      #
+      #   @param allowances [Array<EInvoiceAPI::Models::DocumentCreate::Allowance>, nil]
+      #
+      #   @param amount_due [Float, String, nil] The amount due of the invoice. Must be positive and rounded to maximum 2 decimal
       #
       #   @param attachments [Array<EInvoiceAPI::Models::DocumentAttachmentCreate>, nil]
       #
@@ -228,6 +278,8 @@ module EInvoiceAPI
       #
       #   @param billing_address_recipient [String, nil]
       #
+      #   @param charges [Array<EInvoiceAPI::Models::DocumentCreate::Charge>, nil]
+      #
       #   @param currency [Symbol, EInvoiceAPI::Models::CurrencyCode] Currency of the invoice
       #
       #   @param customer_address [String, nil]
@@ -252,9 +304,9 @@ module EInvoiceAPI
       #
       #   @param invoice_id [String, nil]
       #
-      #   @param invoice_total [Float, String, nil]
+      #   @param invoice_total [Float, String, nil] The total amount of the invoice (so invoice_total = subtotal + total_tax + total
       #
-      #   @param items [Array<EInvoiceAPI::Models::DocumentCreate::Item>, nil]
+      #   @param items [Array<EInvoiceAPI::Models::DocumentCreate::Item>] At least one line item is required
       #
       #   @param note [String, nil]
       #
@@ -262,7 +314,7 @@ module EInvoiceAPI
       #
       #   @param payment_term [String, nil]
       #
-      #   @param previous_unpaid_balance [Float, String, nil]
+      #   @param previous_unpaid_balance [Float, String, nil] The previous unpaid balance of the invoice, if any. Must be positive and rounded
       #
       #   @param purchase_order [String, nil]
       #
@@ -284,13 +336,19 @@ module EInvoiceAPI
       #
       #   @param state [Symbol, EInvoiceAPI::Models::DocumentState]
       #
-      #   @param subtotal [Float, String, nil]
+      #   @param subtotal [Float, String, nil] The taxable base of the invoice. Should be the sum of all line items - allowance
+      #
+      #   @param tax_code [Symbol, EInvoiceAPI::Models::DocumentCreate::TaxCode] Tax category code of the invoice
       #
       #   @param tax_details [Array<EInvoiceAPI::Models::DocumentCreate::TaxDetail>, nil]
       #
-      #   @param total_discount [Float, String, nil]
+      #   @param total_discount [Float, String, nil] The total financial discount of the invoice (so discounts not subject to VAT). M
+      #
+      #   @param total_tax [Float, String, nil] The total tax of the invoice. Must be positive and rounded to maximum 2 decimals
+      #
+      #   @param vatex [Symbol, EInvoiceAPI::Models::DocumentCreate::Vatex, nil] VATEX code list for VAT exemption reasons
       #
-      #   @param total_tax [Float, String, nil]
+      #   @param vatex_note [String, nil] VAT exemption note of the invoice
       #
       #   @param vendor_address [String, nil]
       #
@@ -302,6 +360,146 @@ module EInvoiceAPI
       #
       #   @param vendor_tax_id [String, nil]
 
+      class Allowance < EInvoiceAPI::Internal::Type::BaseModel
+        # @!attribute amount
+        #   The allowance amount, without VAT. Must be rounded to maximum 2 decimals
+        #
+        #   @return [Float, String, nil]
+        optional :amount, union: -> { EInvoiceAPI::DocumentCreate::Allowance::Amount }, nil?: true
+
+        # @!attribute base_amount
+        #   The base amount that may be used, in conjunction with the allowance percentage,
+        #   to calculate the allowance amount. Must be rounded to maximum 2 decimals
+        #
+        #   @return [Float, String, nil]
+        optional :base_amount, union: -> { EInvoiceAPI::DocumentCreate::Allowance::BaseAmount }, nil?: true
+
+        # @!attribute multiplier_factor
+        #   The percentage that may be used, in conjunction with the allowance base amount,
+        #   to calculate the allowance amount. To state 20%, use value 20
+        #
+        #   @return [Float, String, nil]
+        optional :multiplier_factor,
+                 union: -> { EInvoiceAPI::DocumentCreate::Allowance::MultiplierFactor },
+                 nil?: true
+
+        # @!attribute reason
+        #   The reason for the allowance
+        #
+        #   @return [String, nil]
+        optional :reason, String, nil?: true
+
+        # @!attribute reason_code
+        #   The code for the allowance reason
+        #
+        #   @return [String, nil]
+        optional :reason_code, String, nil?: true
+
+        # @!attribute tax_code
+        #   Duty or tax or fee category codes (Subset of UNCL5305)
+        #
+        #   Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL
+        #
+        #   @return [Symbol, EInvoiceAPI::Models::DocumentCreate::Allowance::TaxCode, nil]
+        optional :tax_code, enum: -> { EInvoiceAPI::DocumentCreate::Allowance::TaxCode }, nil?: true
+
+        # @!attribute tax_rate
+        #   The VAT rate, represented as percentage that applies to the allowance
+        #
+        #   @return [String, nil]
+        optional :tax_rate, String, nil?: true
+
+        # @!method initialize(amount: nil, base_amount: nil, multiplier_factor: nil, reason: nil, reason_code: nil, tax_code: nil, tax_rate: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {EInvoiceAPI::Models::DocumentCreate::Allowance} for more details.
+        #
+        #   An allowance is a discount for example for early payment, volume discount, etc.
+        #
+        #   @param amount [Float, String, nil] The allowance amount, without VAT. Must be rounded to maximum 2 decimals
+        #
+        #   @param base_amount [Float, String, nil] The base amount that may be used, in conjunction with the allowance percentage,
+        #
+        #   @param multiplier_factor [Float, String, nil] The percentage that may be used, in conjunction with the allowance base amount,
+        #
+        #   @param reason [String, nil] The reason for the allowance
+        #
+        #   @param reason_code [String, nil] The code for the allowance reason
+        #
+        #   @param tax_code [Symbol, EInvoiceAPI::Models::DocumentCreate::Allowance::TaxCode, nil] Duty or tax or fee category codes (Subset of UNCL5305)
+        #
+        #   @param tax_rate [String, nil] The VAT rate, represented as percentage that applies to the allowance
+
+        # The allowance amount, without VAT. Must be rounded to maximum 2 decimals
+        #
+        # @see EInvoiceAPI::Models::DocumentCreate::Allowance#amount
+        module Amount
+          extend EInvoiceAPI::Internal::Type::Union
+
+          variant Float
+
+          variant String
+
+          # @!method self.variants
+          #   @return [Array(Float, String)]
+        end
+
+        # The base amount that may be used, in conjunction with the allowance percentage,
+        # to calculate the allowance amount. Must be rounded to maximum 2 decimals
+        #
+        # @see EInvoiceAPI::Models::DocumentCreate::Allowance#base_amount
+        module BaseAmount
+          extend EInvoiceAPI::Internal::Type::Union
+
+          variant Float
+
+          variant String
+
+          # @!method self.variants
+          #   @return [Array(Float, String)]
+        end
+
+        # The percentage that may be used, in conjunction with the allowance base amount,
+        # to calculate the allowance amount. To state 20%, use value 20
+        #
+        # @see EInvoiceAPI::Models::DocumentCreate::Allowance#multiplier_factor
+        module MultiplierFactor
+          extend EInvoiceAPI::Internal::Type::Union
+
+          variant Float
+
+          variant String
+
+          # @!method self.variants
+          #   @return [Array(Float, String)]
+        end
+
+        # Duty or tax or fee category codes (Subset of UNCL5305)
+        #
+        # Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL
+        #
+        # @see EInvoiceAPI::Models::DocumentCreate::Allowance#tax_code
+        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
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The amount due of the invoice. Must be positive and rounded to maximum 2
+      # decimals
+      #
       # @see EInvoiceAPI::Models::DocumentCreate#amount_due
       module AmountDue
         extend EInvoiceAPI::Internal::Type::Union
@@ -314,6 +512,146 @@ module EInvoiceAPI
         #   @return [Array(Float, String)]
       end
 
+      class Charge < EInvoiceAPI::Internal::Type::BaseModel
+        # @!attribute amount
+        #   The charge amount, without VAT. Must be rounded to maximum 2 decimals
+        #
+        #   @return [Float, String, nil]
+        optional :amount, union: -> { EInvoiceAPI::DocumentCreate::Charge::Amount }, nil?: true
+
+        # @!attribute base_amount
+        #   The base amount that may be used, in conjunction with the charge percentage, to
+        #   calculate the charge amount. Must be rounded to maximum 2 decimals
+        #
+        #   @return [Float, String, nil]
+        optional :base_amount, union: -> { EInvoiceAPI::DocumentCreate::Charge::BaseAmount }, nil?: true
+
+        # @!attribute multiplier_factor
+        #   The percentage that may be used, in conjunction with the charge base amount, to
+        #   calculate the charge amount. To state 20%, use value 20
+        #
+        #   @return [Float, String, nil]
+        optional :multiplier_factor,
+                 union: -> { EInvoiceAPI::DocumentCreate::Charge::MultiplierFactor },
+                 nil?: true
+
+        # @!attribute reason
+        #   The reason for the charge
+        #
+        #   @return [String, nil]
+        optional :reason, String, nil?: true
+
+        # @!attribute reason_code
+        #   The code for the charge reason
+        #
+        #   @return [String, nil]
+        optional :reason_code, String, nil?: true
+
+        # @!attribute tax_code
+        #   Duty or tax or fee category codes (Subset of UNCL5305)
+        #
+        #   Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL
+        #
+        #   @return [Symbol, EInvoiceAPI::Models::DocumentCreate::Charge::TaxCode, nil]
+        optional :tax_code, enum: -> { EInvoiceAPI::DocumentCreate::Charge::TaxCode }, nil?: true
+
+        # @!attribute tax_rate
+        #   The VAT rate, represented as percentage that applies to the charge
+        #
+        #   @return [String, nil]
+        optional :tax_rate, String, nil?: true
+
+        # @!method initialize(amount: nil, base_amount: nil, multiplier_factor: nil, reason: nil, reason_code: nil, tax_code: nil, tax_rate: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {EInvoiceAPI::Models::DocumentCreate::Charge} for more details.
+        #
+        #   A charge is an additional fee for example for late payment, late delivery, etc.
+        #
+        #   @param amount [Float, String, nil] The charge amount, without VAT. Must be rounded to maximum 2 decimals
+        #
+        #   @param base_amount [Float, String, nil] The base amount that may be used, in conjunction with the charge percentage, to
+        #
+        #   @param multiplier_factor [Float, String, nil] The percentage that may be used, in conjunction with the charge base amount, to
+        #
+        #   @param reason [String, nil] The reason for the charge
+        #
+        #   @param reason_code [String, nil] The code for the charge reason
+        #
+        #   @param tax_code [Symbol, EInvoiceAPI::Models::DocumentCreate::Charge::TaxCode, nil] Duty or tax or fee category codes (Subset of UNCL5305)
+        #
+        #   @param tax_rate [String, nil] The VAT rate, represented as percentage that applies to the charge
+
+        # The charge amount, without VAT. Must be rounded to maximum 2 decimals
+        #
+        # @see EInvoiceAPI::Models::DocumentCreate::Charge#amount
+        module Amount
+          extend EInvoiceAPI::Internal::Type::Union
+
+          variant Float
+
+          variant String
+
+          # @!method self.variants
+          #   @return [Array(Float, String)]
+        end
+
+        # The base amount that may be used, in conjunction with the charge percentage, to
+        # calculate the charge amount. Must be rounded to maximum 2 decimals
+        #
+        # @see EInvoiceAPI::Models::DocumentCreate::Charge#base_amount
+        module BaseAmount
+          extend EInvoiceAPI::Internal::Type::Union
+
+          variant Float
+
+          variant String
+
+          # @!method self.variants
+          #   @return [Array(Float, String)]
+        end
+
+        # The percentage that may be used, in conjunction with the charge base amount, to
+        # calculate the charge amount. To state 20%, use value 20
+        #
+        # @see EInvoiceAPI::Models::DocumentCreate::Charge#multiplier_factor
+        module MultiplierFactor
+          extend EInvoiceAPI::Internal::Type::Union
+
+          variant Float
+
+          variant String
+
+          # @!method self.variants
+          #   @return [Array(Float, String)]
+        end
+
+        # Duty or tax or fee category codes (Subset of UNCL5305)
+        #
+        # Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL
+        #
+        # @see EInvoiceAPI::Models::DocumentCreate::Charge#tax_code
+        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
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The total amount of the invoice (so invoice_total = subtotal + total_tax +
+      # total_discount). Must be positive and rounded to maximum 2 decimals
+      #
       # @see EInvoiceAPI::Models::DocumentCreate#invoice_total
       module InvoiceTotal
         extend EInvoiceAPI::Internal::Type::Union
@@ -327,37 +665,62 @@ module EInvoiceAPI
       end
 
       class Item < EInvoiceAPI::Internal::Type::BaseModel
+        # @!attribute allowances
+        #   The allowances of the line item.
+        #
+        #   @return [Array<EInvoiceAPI::Models::DocumentCreate::Item::Allowance>, nil]
+        optional :allowances,
+                 -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::DocumentCreate::Item::Allowance] },
+                 nil?: true
+
         # @!attribute amount
+        #   The total amount of the line item, exclusive of VAT, after subtracting line
+        #   level allowances and adding line level charges. Must be rounded to maximum 2
+        #   decimals
         #
         #   @return [Float, String, nil]
         optional :amount, union: -> { EInvoiceAPI::DocumentCreate::Item::Amount }, nil?: true
 
+        # @!attribute charges
+        #   The charges of the line item.
+        #
+        #   @return [Array<EInvoiceAPI::Models::DocumentCreate::Item::Charge>, nil]
+        optional :charges,
+                 -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::DocumentCreate::Item::Charge] },
+                 nil?: true
+
         # @!attribute date
         #
         #   @return [nil]
         optional :date, NilClass
 
         # @!attribute description
+        #   The description of the line item.
         #
         #   @return [String, nil]
         optional :description, String, nil?: true
 
         # @!attribute product_code
+        #   The product code of the line item.
         #
         #   @return [String, nil]
         optional :product_code, String, nil?: true
 
         # @!attribute quantity
+        #   The quantity of items (goods or services) that is the subject of the line item.
+        #   Must be rounded to maximum 4 decimals
         #
         #   @return [Float, String, nil]
         optional :quantity, union: -> { EInvoiceAPI::DocumentCreate::Item::Quantity }, nil?: true
 
         # @!attribute tax
+        #   The total VAT amount for the line item. Must be rounded to maximum 2 decimals
         #
         #   @return [Float, String, nil]
         optional :tax, union: -> { EInvoiceAPI::DocumentCreate::Item::Tax }, nil?: true
 
         # @!attribute tax_rate
+        #   The VAT rate of the line item expressed as percentage with 2 decimals
         #
         #   @return [String, nil]
         optional :tax_rate, String, nil?: true
@@ -369,29 +732,182 @@ module EInvoiceAPI
         optional :unit, enum: -> { EInvoiceAPI::UnitOfMeasureCode }, nil?: true
 
         # @!attribute unit_price
+        #   The unit price of the line item. Must be rounded to maximum 2 decimals
         #
         #   @return [Float, String, nil]
         optional :unit_price, union: -> { EInvoiceAPI::DocumentCreate::Item::UnitPrice }, nil?: true
 
-        # @!method initialize(amount: nil, date: nil, description: nil, product_code: nil, quantity: nil, tax: nil, tax_rate: nil, unit: nil, unit_price: nil)
-        #   @param amount [Float, String, nil]
+        # @!method initialize(allowances: nil, amount: nil, charges: nil, date: nil, description: nil, product_code: nil, quantity: nil, tax: nil, tax_rate: nil, unit: nil, unit_price: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {EInvoiceAPI::Models::DocumentCreate::Item} for more details.
+        #
+        #   @param allowances [Array<EInvoiceAPI::Models::DocumentCreate::Item::Allowance>, nil] The allowances of the line item.
+        #
+        #   @param amount [Float, String, nil] The total amount of the line item, exclusive of VAT, after subtracting line leve
+        #
+        #   @param charges [Array<EInvoiceAPI::Models::DocumentCreate::Item::Charge>, nil] The charges of the line item.
         #
         #   @param date [nil]
         #
-        #   @param description [String, nil]
+        #   @param description [String, nil] The description of the line item.
         #
-        #   @param product_code [String, nil]
+        #   @param product_code [String, nil] The product code of the line item.
         #
-        #   @param quantity [Float, String, nil]
+        #   @param quantity [Float, String, nil] The quantity of items (goods or services) that is the subject of the line item.
         #
-        #   @param tax [Float, String, nil]
+        #   @param tax [Float, String, nil] The total VAT amount for the line item. Must be rounded to maximum 2 decimals
         #
-        #   @param tax_rate [String, nil]
+        #   @param tax_rate [String, nil] The VAT rate of the line item expressed as percentage with 2 decimals
         #
         #   @param unit [Symbol, EInvoiceAPI::Models::UnitOfMeasureCode, nil] Unit of Measure Codes from UNECERec20 used in Peppol BIS Billing 3.0.
         #
-        #   @param unit_price [Float, String, nil]
+        #   @param unit_price [Float, String, nil] The unit price of the line item. Must be rounded to maximum 2 decimals
+
+        class Allowance < EInvoiceAPI::Internal::Type::BaseModel
+          # @!attribute amount
+          #   The allowance amount, without VAT. Must be rounded to maximum 2 decimals
+          #
+          #   @return [Float, String, nil]
+          optional :amount, union: -> { EInvoiceAPI::DocumentCreate::Item::Allowance::Amount }, nil?: true
+
+          # @!attribute base_amount
+          #   The base amount that may be used, in conjunction with the allowance percentage,
+          #   to calculate the allowance amount. Must be rounded to maximum 2 decimals
+          #
+          #   @return [Float, String, nil]
+          optional :base_amount,
+                   union: -> {
+                     EInvoiceAPI::DocumentCreate::Item::Allowance::BaseAmount
+                   },
+                   nil?: true
+
+          # @!attribute multiplier_factor
+          #   The percentage that may be used, in conjunction with the allowance base amount,
+          #   to calculate the allowance amount. To state 20%, use value 20
+          #
+          #   @return [Float, String, nil]
+          optional :multiplier_factor,
+                   union: -> { EInvoiceAPI::DocumentCreate::Item::Allowance::MultiplierFactor },
+                   nil?: true
+
+          # @!attribute reason
+          #   The reason for the allowance
+          #
+          #   @return [String, nil]
+          optional :reason, String, nil?: true
+
+          # @!attribute reason_code
+          #   The code for the allowance reason
+          #
+          #   @return [String, nil]
+          optional :reason_code, String, nil?: true
+
+          # @!attribute tax_code
+          #   Duty or tax or fee category codes (Subset of UNCL5305)
+          #
+          #   Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL
+          #
+          #   @return [Symbol, EInvoiceAPI::Models::DocumentCreate::Item::Allowance::TaxCode, nil]
+          optional :tax_code, enum: -> { EInvoiceAPI::DocumentCreate::Item::Allowance::TaxCode }, nil?: true
+
+          # @!attribute tax_rate
+          #   The VAT rate, represented as percentage that applies to the allowance
+          #
+          #   @return [String, nil]
+          optional :tax_rate, String, nil?: true
+
+          # @!method initialize(amount: nil, base_amount: nil, multiplier_factor: nil, reason: nil, reason_code: nil, tax_code: nil, tax_rate: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {EInvoiceAPI::Models::DocumentCreate::Item::Allowance} for more details.
+          #
+          #   An allowance is a discount for example for early payment, volume discount, etc.
+          #
+          #   @param amount [Float, String, nil] The allowance amount, without VAT. Must be rounded to maximum 2 decimals
+          #
+          #   @param base_amount [Float, String, nil] The base amount that may be used, in conjunction with the allowance percentage,
+          #
+          #   @param multiplier_factor [Float, String, nil] The percentage that may be used, in conjunction with the allowance base amount,
+          #
+          #   @param reason [String, nil] The reason for the allowance
+          #
+          #   @param reason_code [String, nil] The code for the allowance reason
+          #
+          #   @param tax_code [Symbol, EInvoiceAPI::Models::DocumentCreate::Item::Allowance::TaxCode, nil] Duty or tax or fee category codes (Subset of UNCL5305)
+          #
+          #   @param tax_rate [String, nil] The VAT rate, represented as percentage that applies to the allowance
+
+          # The allowance amount, without VAT. Must be rounded to maximum 2 decimals
+          #
+          # @see EInvoiceAPI::Models::DocumentCreate::Item::Allowance#amount
+          module Amount
+            extend EInvoiceAPI::Internal::Type::Union
+
+            variant Float
+
+            variant String
+
+            # @!method self.variants
+            #   @return [Array(Float, String)]
+          end
+
+          # The base amount that may be used, in conjunction with the allowance percentage,
+          # to calculate the allowance amount. Must be rounded to maximum 2 decimals
+          #
+          # @see EInvoiceAPI::Models::DocumentCreate::Item::Allowance#base_amount
+          module BaseAmount
+            extend EInvoiceAPI::Internal::Type::Union
+
+            variant Float
+
+            variant String
+
+            # @!method self.variants
+            #   @return [Array(Float, String)]
+          end
+
+          # The percentage that may be used, in conjunction with the allowance base amount,
+          # to calculate the allowance amount. To state 20%, use value 20
+          #
+          # @see EInvoiceAPI::Models::DocumentCreate::Item::Allowance#multiplier_factor
+          module MultiplierFactor
+            extend EInvoiceAPI::Internal::Type::Union
+
+            variant Float
+
+            variant String
+
+            # @!method self.variants
+            #   @return [Array(Float, String)]
+          end
+
+          # Duty or tax or fee category codes (Subset of UNCL5305)
+          #
+          # Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL
+          #
+          # @see EInvoiceAPI::Models::DocumentCreate::Item::Allowance#tax_code
+          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
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
 
+        # The total amount of the line item, exclusive of VAT, after subtracting line
+        # level allowances and adding line level charges. Must be rounded to maximum 2
+        # decimals
+        #
         # @see EInvoiceAPI::Models::DocumentCreate::Item#amount
         module Amount
           extend EInvoiceAPI::Internal::Type::Union
@@ -404,6 +920,150 @@ module EInvoiceAPI
           #   @return [Array(Float, String)]
         end
 
+        class Charge < EInvoiceAPI::Internal::Type::BaseModel
+          # @!attribute amount
+          #   The charge amount, without VAT. Must be rounded to maximum 2 decimals
+          #
+          #   @return [Float, String, nil]
+          optional :amount, union: -> { EInvoiceAPI::DocumentCreate::Item::Charge::Amount }, nil?: true
+
+          # @!attribute base_amount
+          #   The base amount that may be used, in conjunction with the charge percentage, to
+          #   calculate the charge amount. Must be rounded to maximum 2 decimals
+          #
+          #   @return [Float, String, nil]
+          optional :base_amount,
+                   union: -> {
+                     EInvoiceAPI::DocumentCreate::Item::Charge::BaseAmount
+                   },
+                   nil?: true
+
+          # @!attribute multiplier_factor
+          #   The percentage that may be used, in conjunction with the charge base amount, to
+          #   calculate the charge amount. To state 20%, use value 20
+          #
+          #   @return [Float, String, nil]
+          optional :multiplier_factor,
+                   union: -> { EInvoiceAPI::DocumentCreate::Item::Charge::MultiplierFactor },
+                   nil?: true
+
+          # @!attribute reason
+          #   The reason for the charge
+          #
+          #   @return [String, nil]
+          optional :reason, String, nil?: true
+
+          # @!attribute reason_code
+          #   The code for the charge reason
+          #
+          #   @return [String, nil]
+          optional :reason_code, String, nil?: true
+
+          # @!attribute tax_code
+          #   Duty or tax or fee category codes (Subset of UNCL5305)
+          #
+          #   Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL
+          #
+          #   @return [Symbol, EInvoiceAPI::Models::DocumentCreate::Item::Charge::TaxCode, nil]
+          optional :tax_code, enum: -> { EInvoiceAPI::DocumentCreate::Item::Charge::TaxCode }, nil?: true
+
+          # @!attribute tax_rate
+          #   The VAT rate, represented as percentage that applies to the charge
+          #
+          #   @return [String, nil]
+          optional :tax_rate, String, nil?: true
+
+          # @!method initialize(amount: nil, base_amount: nil, multiplier_factor: nil, reason: nil, reason_code: nil, tax_code: nil, tax_rate: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {EInvoiceAPI::Models::DocumentCreate::Item::Charge} for more details.
+          #
+          #   A charge is an additional fee for example for late payment, late delivery, etc.
+          #
+          #   @param amount [Float, String, nil] The charge amount, without VAT. Must be rounded to maximum 2 decimals
+          #
+          #   @param base_amount [Float, String, nil] The base amount that may be used, in conjunction with the charge percentage, to
+          #
+          #   @param multiplier_factor [Float, String, nil] The percentage that may be used, in conjunction with the charge base amount, to
+          #
+          #   @param reason [String, nil] The reason for the charge
+          #
+          #   @param reason_code [String, nil] The code for the charge reason
+          #
+          #   @param tax_code [Symbol, EInvoiceAPI::Models::DocumentCreate::Item::Charge::TaxCode, nil] Duty or tax or fee category codes (Subset of UNCL5305)
+          #
+          #   @param tax_rate [String, nil] The VAT rate, represented as percentage that applies to the charge
+
+          # The charge amount, without VAT. Must be rounded to maximum 2 decimals
+          #
+          # @see EInvoiceAPI::Models::DocumentCreate::Item::Charge#amount
+          module Amount
+            extend EInvoiceAPI::Internal::Type::Union
+
+            variant Float
+
+            variant String
+
+            # @!method self.variants
+            #   @return [Array(Float, String)]
+          end
+
+          # The base amount that may be used, in conjunction with the charge percentage, to
+          # calculate the charge amount. Must be rounded to maximum 2 decimals
+          #
+          # @see EInvoiceAPI::Models::DocumentCreate::Item::Charge#base_amount
+          module BaseAmount
+            extend EInvoiceAPI::Internal::Type::Union
+
+            variant Float
+
+            variant String
+
+            # @!method self.variants
+            #   @return [Array(Float, String)]
+          end
+
+          # The percentage that may be used, in conjunction with the charge base amount, to
+          # calculate the charge amount. To state 20%, use value 20
+          #
+          # @see EInvoiceAPI::Models::DocumentCreate::Item::Charge#multiplier_factor
+          module MultiplierFactor
+            extend EInvoiceAPI::Internal::Type::Union
+
+            variant Float
+
+            variant String
+
+            # @!method self.variants
+            #   @return [Array(Float, String)]
+          end
+
+          # Duty or tax or fee category codes (Subset of UNCL5305)
+          #
+          # Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL
+          #
+          # @see EInvoiceAPI::Models::DocumentCreate::Item::Charge#tax_code
+          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
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The quantity of items (goods or services) that is the subject of the line item.
+        # Must be rounded to maximum 4 decimals
+        #
         # @see EInvoiceAPI::Models::DocumentCreate::Item#quantity
         module Quantity
           extend EInvoiceAPI::Internal::Type::Union
@@ -416,6 +1076,8 @@ module EInvoiceAPI
           #   @return [Array(Float, String)]
         end
 
+        # The total VAT amount for the line item. Must be rounded to maximum 2 decimals
+        #
         # @see EInvoiceAPI::Models::DocumentCreate::Item#tax
         module Tax
           extend EInvoiceAPI::Internal::Type::Union
@@ -428,6 +1090,8 @@ module EInvoiceAPI
           #   @return [Array(Float, String)]
         end
 
+        # The unit price of the line item. Must be rounded to maximum 2 decimals
+        #
         # @see EInvoiceAPI::Models::DocumentCreate::Item#unit_price
         module UnitPrice
           extend EInvoiceAPI::Internal::Type::Union
@@ -441,6 +1105,9 @@ module EInvoiceAPI
         end
       end
 
+      # The previous unpaid balance of the invoice, if any. Must be positive and rounded
+      # to maximum 2 decimals
+      #
       # @see EInvoiceAPI::Models::DocumentCreate#previous_unpaid_balance
       module PreviousUnpaidBalance
         extend EInvoiceAPI::Internal::Type::Union
@@ -453,6 +1120,10 @@ module EInvoiceAPI
         #   @return [Array(Float, String)]
       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
+      #
       # @see EInvoiceAPI::Models::DocumentCreate#subtotal
       module Subtotal
         extend EInvoiceAPI::Internal::Type::Union
@@ -465,6 +1136,27 @@ module EInvoiceAPI
         #   @return [Array(Float, String)]
       end
 
+      # Tax category code of the invoice
+      #
+      # @see EInvoiceAPI::Models::DocumentCreate#tax_code
+      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
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       class TaxDetail < EInvoiceAPI::Internal::Type::BaseModel
         # @!attribute amount
         #
@@ -493,6 +1185,9 @@ module EInvoiceAPI
         end
       end
 
+      # The total financial discount of the invoice (so discounts not subject to VAT).
+      # Must be positive and rounded to maximum 2 decimals
+      #
       # @see EInvoiceAPI::Models::DocumentCreate#total_discount
       module TotalDiscount
         extend EInvoiceAPI::Internal::Type::Union
@@ -505,6 +1200,8 @@ module EInvoiceAPI
         #   @return [Array(Float, String)]
       end
 
+      # The total tax of the invoice. Must be positive and rounded to maximum 2 decimals
+      #
       # @see EInvoiceAPI::Models::DocumentCreate#total_tax
       module TotalTax
         extend EInvoiceAPI::Internal::Type::Union
@@ -516,6 +1213,81 @@ module EInvoiceAPI
         # @!method self.variants
         #   @return [Array(Float, String)]
       end
+
+      # VATEX code list for VAT exemption reasons
+      #
+      # Agency: CEF Identifier: vatex
+      #
+      # @see EInvoiceAPI::Models::DocumentCreate#vatex
+      module Vatex
+        extend EInvoiceAPI::Internal::Type::Enum
+
+        VATEX_EU_79_C = :"VATEX-EU-79-C"
+        VATEX_EU_132 = :"VATEX-EU-132"
+        VATEX_EU_132_1_A = :"VATEX-EU-132-1A"
+        VATEX_EU_132_1_B = :"VATEX-EU-132-1B"
+        VATEX_EU_132_1_C = :"VATEX-EU-132-1C"
+        VATEX_EU_132_1_D = :"VATEX-EU-132-1D"
+        VATEX_EU_132_1_E = :"VATEX-EU-132-1E"
+        VATEX_EU_132_1_F = :"VATEX-EU-132-1F"
+        VATEX_EU_132_1_G = :"VATEX-EU-132-1G"
+        VATEX_EU_132_1_H = :"VATEX-EU-132-1H"
+        VATEX_EU_132_1_I = :"VATEX-EU-132-1I"
+        VATEX_EU_132_1_J = :"VATEX-EU-132-1J"
+        VATEX_EU_132_1_K = :"VATEX-EU-132-1K"
+        VATEX_EU_132_1_L = :"VATEX-EU-132-1L"
+        VATEX_EU_132_1_M = :"VATEX-EU-132-1M"
+        VATEX_EU_132_1_N = :"VATEX-EU-132-1N"
+        VATEX_EU_132_1_O = :"VATEX-EU-132-1O"
+        VATEX_EU_132_1_P = :"VATEX-EU-132-1P"
+        VATEX_EU_132_1_Q = :"VATEX-EU-132-1Q"
+        VATEX_EU_143 = :"VATEX-EU-143"
+        VATEX_EU_143_1_A = :"VATEX-EU-143-1A"
+        VATEX_EU_143_1_B = :"VATEX-EU-143-1B"
+        VATEX_EU_143_1_C = :"VATEX-EU-143-1C"
+        VATEX_EU_143_1_D = :"VATEX-EU-143-1D"
+        VATEX_EU_143_1_E = :"VATEX-EU-143-1E"
+        VATEX_EU_143_1_F = :"VATEX-EU-143-1F"
+        VATEX_EU_143_1_FA = :"VATEX-EU-143-1FA"
+        VATEX_EU_143_1_G = :"VATEX-EU-143-1G"
+        VATEX_EU_143_1_H = :"VATEX-EU-143-1H"
+        VATEX_EU_143_1_I = :"VATEX-EU-143-1I"
+        VATEX_EU_143_1_J = :"VATEX-EU-143-1J"
+        VATEX_EU_143_1_K = :"VATEX-EU-143-1K"
+        VATEX_EU_143_1_L = :"VATEX-EU-143-1L"
+        VATEX_EU_144 = :"VATEX-EU-144"
+        VATEX_EU_146_1_E = :"VATEX-EU-146-1E"
+        VATEX_EU_148 = :"VATEX-EU-148"
+        VATEX_EU_148_A = :"VATEX-EU-148-A"
+        VATEX_EU_148_B = :"VATEX-EU-148-B"
+        VATEX_EU_148_C = :"VATEX-EU-148-C"
+        VATEX_EU_148_D = :"VATEX-EU-148-D"
+        VATEX_EU_148_E = :"VATEX-EU-148-E"
+        VATEX_EU_148_F = :"VATEX-EU-148-F"
+        VATEX_EU_148_G = :"VATEX-EU-148-G"
+        VATEX_EU_151 = :"VATEX-EU-151"
+        VATEX_EU_151_1_A = :"VATEX-EU-151-1A"
+        VATEX_EU_151_1_AA = :"VATEX-EU-151-1AA"
+        VATEX_EU_151_1_B = :"VATEX-EU-151-1B"
+        VATEX_EU_151_1_C = :"VATEX-EU-151-1C"
+        VATEX_EU_151_1_D = :"VATEX-EU-151-1D"
+        VATEX_EU_151_1_E = :"VATEX-EU-151-1E"
+        VATEX_EU_159 = :"VATEX-EU-159"
+        VATEX_EU_309 = :"VATEX-EU-309"
+        VATEX_EU_AE = :"VATEX-EU-AE"
+        VATEX_EU_D = :"VATEX-EU-D"
+        VATEX_EU_F = :"VATEX-EU-F"
+        VATEX_EU_G = :"VATEX-EU-G"
+        VATEX_EU_I = :"VATEX-EU-I"
+        VATEX_EU_IC = :"VATEX-EU-IC"
+        VATEX_EU_O = :"VATEX-EU-O"
+        VATEX_EU_J = :"VATEX-EU-J"
+        VATEX_FR_FRANCHISE = :"VATEX-FR-FRANCHISE"
+        VATEX_FR_CNWVAT = :"VATEX-FR-CNWVAT"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end