e-invoice-api 0.10.1 → 0.12.0

data/lib/e_invoice_api/models/document_create_from_pdf_response.rb

@@ -10,8 +10,7 @@ module EInvoiceAPI
       optional :allowances, -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Allowance] }, nil?: true
 
       # @!attribute amount_due
-      #   The amount due of the invoice. Must be positive and rounded to maximum 2
-      #   decimals
+      #   The amount due for payment. Must be positive and rounded to maximum 2 decimals
       #
       #   @return [String, nil]
       optional :amount_due, String, nil?: true
@@ -24,11 +23,13 @@ module EInvoiceAPI
                nil?: true
 
       # @!attribute billing_address
+      #   The billing address (if different from customer address)
       #
       #   @return [String, nil]
       optional :billing_address, String, nil?: true
 
       # @!attribute billing_address_recipient
+      #   The recipient name at the billing address
       #
       #   @return [String, nil]
       optional :billing_address_recipient, String, nil?: true
@@ -39,69 +40,88 @@ module EInvoiceAPI
       optional :charges, -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Charge] }, nil?: true
 
       # @!attribute currency
-      #   Currency of the invoice
+      #   Currency of the invoice (ISO 4217 currency code)
       #
       #   @return [Symbol, EInvoiceAPI::Models::CurrencyCode, nil]
       optional :currency, enum: -> { EInvoiceAPI::CurrencyCode }
 
       # @!attribute customer_address
+      #   The address of the customer/buyer
       #
       #   @return [String, nil]
       optional :customer_address, String, nil?: true
 
       # @!attribute customer_address_recipient
+      #   The recipient name at the customer address
       #
       #   @return [String, nil]
       optional :customer_address_recipient, String, nil?: true
 
+      # @!attribute customer_company_id
+      #   Customer company ID. For Belgium this is the CBE number or their EUID (European
+      #   Unique Identifier) number. In the Netherlands this is the KVK number.
+      #
+      #   @return [String, nil]
+      optional :customer_company_id, String, nil?: true
+
       # @!attribute customer_email
+      #   The email address of the customer
       #
       #   @return [String, nil]
       optional :customer_email, String, nil?: true
 
       # @!attribute customer_id
+      #   The unique identifier for the customer in your system
       #
       #   @return [String, nil]
       optional :customer_id, String, nil?: true
 
       # @!attribute customer_name
+      #   The company name of the customer/buyer
       #
       #   @return [String, nil]
       optional :customer_name, String, nil?: true
 
       # @!attribute customer_tax_id
+      #   Customer tax ID. For Belgium this is the VAT number. Must include the country
+      #   prefix
       #
       #   @return [String, nil]
       optional :customer_tax_id, String, nil?: true
 
       # @!attribute direction
+      #   The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
       #
       #   @return [Symbol, EInvoiceAPI::Models::DocumentDirection, nil]
       optional :direction, enum: -> { EInvoiceAPI::DocumentDirection }
 
       # @!attribute document_type
+      #   The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE
       #
       #   @return [Symbol, EInvoiceAPI::Models::DocumentType, nil]
       optional :document_type, enum: -> { EInvoiceAPI::DocumentType }
 
       # @!attribute due_date
+      #   The date when payment is due
       #
       #   @return [Date, nil]
       optional :due_date, Date, nil?: true
 
       # @!attribute invoice_date
+      #   The date when the invoice was issued
       #
       #   @return [Date, nil]
       optional :invoice_date, Date, nil?: true
 
       # @!attribute invoice_id
+      #   The unique invoice identifier/number
       #
       #   @return [String, nil]
       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
+      #   The total amount of the invoice including tax (invoice_total = subtotal +
+      #   total_tax + total_discount). Must be positive and rounded to maximum 2 decimals
       #
       #   @return [String, nil]
       optional :invoice_total, String, nil?: true
@@ -114,6 +134,7 @@ module EInvoiceAPI
                -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::DocumentCreateFromPdfResponse::Item] }
 
       # @!attribute note
+      #   Additional notes or comments for the invoice
       #
       #   @return [String, nil]
       optional :note, String, nil?: true
@@ -126,63 +147,74 @@ module EInvoiceAPI
                nil?: true
 
       # @!attribute payment_term
+      #   The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
       #
       #   @return [String, nil]
       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
+      #   The previous unpaid balance from prior invoices, if any. Must be positive and
+      #   rounded to maximum 2 decimals
       #
       #   @return [String, nil]
       optional :previous_unpaid_balance, String, nil?: true
 
       # @!attribute purchase_order
+      #   The purchase order reference number
       #
       #   @return [String, nil]
       optional :purchase_order, String, nil?: true
 
       # @!attribute remittance_address
+      #   The address where payment should be sent or remitted to
       #
       #   @return [String, nil]
       optional :remittance_address, String, nil?: true
 
       # @!attribute remittance_address_recipient
+      #   The recipient name at the remittance address
       #
       #   @return [String, nil]
       optional :remittance_address_recipient, String, nil?: true
 
       # @!attribute service_address
+      #   The address where services were performed or goods were delivered
       #
       #   @return [String, nil]
       optional :service_address, String, nil?: true
 
       # @!attribute service_address_recipient
+      #   The recipient name at the service address
       #
       #   @return [String, nil]
       optional :service_address_recipient, String, nil?: true
 
       # @!attribute service_end_date
+      #   The end date of the service period or delivery period
       #
       #   @return [Date, nil]
       optional :service_end_date, Date, nil?: true
 
       # @!attribute service_start_date
+      #   The start date of the service period or delivery period
       #
       #   @return [Date, nil]
       optional :service_start_date, Date, nil?: true
 
       # @!attribute shipping_address
+      #   The shipping/delivery address
       #
       #   @return [String, nil]
       optional :shipping_address, String, nil?: true
 
       # @!attribute shipping_address_recipient
+      #   The recipient name at the shipping address
       #
       #   @return [String, nil]
       optional :shipping_address_recipient, String, nil?: true
 
       # @!attribute state
+      #   The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED
       #
       #   @return [Symbol, EInvoiceAPI::Models::DocumentState, nil]
       optional :state, enum: -> { EInvoiceAPI::DocumentState }
@@ -202,7 +234,8 @@ module EInvoiceAPI
       optional :success, EInvoiceAPI::Internal::Type::Boolean
 
       # @!attribute tax_code
-      #   Tax category code of the invoice
+      #   Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E
+      #   for exempt)
       #
       #   @return [Symbol, EInvoiceAPI::Models::DocumentCreateFromPdfResponse::TaxCode, nil]
       optional :tax_code, enum: -> { EInvoiceAPI::Models::DocumentCreateFromPdfResponse::TaxCode }
@@ -215,14 +248,16 @@ 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
+      #   The net financial discount/charge of the invoice (non-VAT charges minus non-VAT
+      #   allowances). Can be positive (net charge), negative (net discount), or zero.
+      #   Must be rounded to maximum 2 decimals
       #
       #   @return [String, nil]
       optional :total_discount, String, nil?: true
 
       # @!attribute total_tax
-      #   The total tax of the invoice. Must be positive and rounded to maximum 2 decimals
+      #   The total tax amount of the invoice. Must be positive and rounded to maximum 2
+      #   decimals
       #
       #   @return [String, nil]
       optional :total_tax, String, nil?: true
@@ -242,135 +277,152 @@ module EInvoiceAPI
       optional :vatex, enum: -> { EInvoiceAPI::Models::DocumentCreateFromPdfResponse::Vatex }, nil?: true
 
       # @!attribute vatex_note
-      #   VAT exemption note of the invoice
+      #   Textual explanation for VAT exemption
       #
       #   @return [String, nil]
       optional :vatex_note, String, nil?: true
 
       # @!attribute vendor_address
+      #   The address of the vendor/seller
       #
       #   @return [String, nil]
       optional :vendor_address, String, nil?: true
 
       # @!attribute vendor_address_recipient
+      #   The recipient name at the vendor address
       #
       #   @return [String, nil]
       optional :vendor_address_recipient, String, nil?: true
 
+      # @!attribute vendor_company_id
+      #   Vendor company ID. For Belgium this is the CBE number or their EUID (European
+      #   Unique Identifier) number. In the Netherlands this is the KVK number.
+      #
+      #   @return [String, nil]
+      optional :vendor_company_id, String, nil?: true
+
       # @!attribute vendor_email
+      #   The email address of the vendor
       #
       #   @return [String, nil]
       optional :vendor_email, String, nil?: true
 
       # @!attribute vendor_name
+      #   The name of the vendor/seller/supplier
       #
       #   @return [String, nil]
       optional :vendor_name, String, nil?: true
 
       # @!attribute vendor_tax_id
+      #   Vendor tax ID. For Belgium this is the VAT number. Must include the country
+      #   prefix
       #
       #   @return [String, nil]
       optional :vendor_tax_id, String, nil?: true
 
-      # @!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, success: nil, tax_code: nil, tax_details: nil, total_discount: nil, total_tax: nil, ubl_document: nil, vatex: nil, vatex_note: nil, vendor_address: nil, vendor_address_recipient: nil, vendor_email: nil, vendor_name: nil, vendor_tax_id: 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_company_id: 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, success: nil, tax_code: nil, tax_details: nil, total_discount: nil, total_tax: nil, ubl_document: nil, vatex: nil, vatex_note: nil, vendor_address: nil, vendor_address_recipient: nil, vendor_company_id: nil, vendor_email: nil, vendor_name: nil, vendor_tax_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {EInvoiceAPI::Models::DocumentCreateFromPdfResponse} for more details.
       #
       #   @param allowances [Array<EInvoiceAPI::Models::Allowance>, nil]
       #
-      #   @param amount_due [String, nil] The amount due of the invoice. Must be positive and rounded to maximum 2 decimal
+      #   @param amount_due [String, nil] The amount due for payment. Must be positive and rounded to maximum 2 decimals
       #
       #   @param attachments [Array<EInvoiceAPI::Models::DocumentAttachmentCreate>, nil]
       #
-      #   @param billing_address [String, nil]
+      #   @param billing_address [String, nil] The billing address (if different from customer address)
       #
-      #   @param billing_address_recipient [String, nil]
+      #   @param billing_address_recipient [String, nil] The recipient name at the billing address
       #
       #   @param charges [Array<EInvoiceAPI::Models::Charge>, nil]
       #
-      #   @param currency [Symbol, EInvoiceAPI::Models::CurrencyCode] Currency of the invoice
+      #   @param currency [Symbol, EInvoiceAPI::Models::CurrencyCode] Currency of the invoice (ISO 4217 currency code)
       #
-      #   @param customer_address [String, nil]
+      #   @param customer_address [String, nil] The address of the customer/buyer
       #
-      #   @param customer_address_recipient [String, nil]
+      #   @param customer_address_recipient [String, nil] The recipient name at the customer address
       #
-      #   @param customer_email [String, nil]
+      #   @param customer_company_id [String, nil] Customer company ID. For Belgium this is the CBE number or their EUID (European
       #
-      #   @param customer_id [String, nil]
+      #   @param customer_email [String, nil] The email address of the customer
       #
-      #   @param customer_name [String, nil]
+      #   @param customer_id [String, nil] The unique identifier for the customer in your system
       #
-      #   @param customer_tax_id [String, nil]
+      #   @param customer_name [String, nil] The company name of the customer/buyer
       #
-      #   @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection]
+      #   @param customer_tax_id [String, nil] Customer tax ID. For Belgium this is the VAT number. Must include the country pr
       #
-      #   @param document_type [Symbol, EInvoiceAPI::Models::DocumentType]
+      #   @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection] The direction of the document: INBOUND (purchases) or OUTBOUND (sales)
       #
-      #   @param due_date [Date, nil]
+      #   @param document_type [Symbol, EInvoiceAPI::Models::DocumentType] The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE
       #
-      #   @param invoice_date [Date, nil]
+      #   @param due_date [Date, nil] The date when payment is due
       #
-      #   @param invoice_id [String, nil]
+      #   @param invoice_date [Date, nil] The date when the invoice was issued
       #
-      #   @param invoice_total [String, nil] The total amount of the invoice (so invoice_total = subtotal + total_tax + total
+      #   @param invoice_id [String, nil] The unique invoice identifier/number
+      #
+      #   @param invoice_total [String, nil] The total amount of the invoice including tax (invoice*total = subtotal + total*
       #
       #   @param items [Array<EInvoiceAPI::Models::DocumentCreateFromPdfResponse::Item>] At least one line item is required
       #
-      #   @param note [String, nil]
+      #   @param note [String, nil] Additional notes or comments for the invoice
       #
       #   @param payment_details [Array<EInvoiceAPI::Models::PaymentDetailCreate>, nil]
       #
-      #   @param payment_term [String, nil]
+      #   @param payment_term [String, nil] The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
       #
-      #   @param previous_unpaid_balance [String, nil] The previous unpaid balance of the invoice, if any. Must be positive and rounded
+      #   @param previous_unpaid_balance [String, nil] The previous unpaid balance from prior invoices, if any. Must be positive and ro
       #
-      #   @param purchase_order [String, nil]
+      #   @param purchase_order [String, nil] The purchase order reference number
       #
-      #   @param remittance_address [String, nil]
+      #   @param remittance_address [String, nil] The address where payment should be sent or remitted to
       #
-      #   @param remittance_address_recipient [String, nil]
+      #   @param remittance_address_recipient [String, nil] The recipient name at the remittance address
       #
-      #   @param service_address [String, nil]
+      #   @param service_address [String, nil] The address where services were performed or goods were delivered
       #
-      #   @param service_address_recipient [String, nil]
+      #   @param service_address_recipient [String, nil] The recipient name at the service address
       #
-      #   @param service_end_date [Date, nil]
+      #   @param service_end_date [Date, nil] The end date of the service period or delivery period
       #
-      #   @param service_start_date [Date, nil]
+      #   @param service_start_date [Date, nil] The start date of the service period or delivery period
       #
-      #   @param shipping_address [String, nil]
+      #   @param shipping_address [String, nil] The shipping/delivery address
       #
-      #   @param shipping_address_recipient [String, nil]
+      #   @param shipping_address_recipient [String, nil] The recipient name at the shipping address
       #
-      #   @param state [Symbol, EInvoiceAPI::Models::DocumentState]
+      #   @param state [Symbol, EInvoiceAPI::Models::DocumentState] The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED
       #
       #   @param subtotal [String, nil] The taxable base of the invoice. Should be the sum of all line items - allowance
       #
       #   @param success [Boolean] Whether the PDF was successfully converted into a compliant e-invoice
       #
-      #   @param tax_code [Symbol, EInvoiceAPI::Models::DocumentCreateFromPdfResponse::TaxCode] Tax category code of the invoice
+      #   @param tax_code [Symbol, EInvoiceAPI::Models::DocumentCreateFromPdfResponse::TaxCode] Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E
       #
       #   @param tax_details [Array<EInvoiceAPI::Models::DocumentCreateFromPdfResponse::TaxDetail>, nil]
       #
-      #   @param total_discount [String, nil] The total financial discount of the invoice (so discounts not subject to VAT). M
+      #   @param total_discount [String, nil] The net financial discount/charge of the invoice (non-VAT charges minus non-VAT
       #
-      #   @param total_tax [String, nil] The total tax of the invoice. Must be positive and rounded to maximum 2 decimals
+      #   @param total_tax [String, nil] The total tax amount of the invoice. Must be positive and rounded to maximum 2 d
       #
       #   @param ubl_document [String, nil] The UBL document as an XML string
       #
       #   @param vatex [Symbol, EInvoiceAPI::Models::DocumentCreateFromPdfResponse::Vatex, nil] VATEX code list for VAT exemption reasons
       #
-      #   @param vatex_note [String, nil] VAT exemption note of the invoice
+      #   @param vatex_note [String, nil] Textual explanation for VAT exemption
+      #
+      #   @param vendor_address [String, nil] The address of the vendor/seller
       #
-      #   @param vendor_address [String, nil]
+      #   @param vendor_address_recipient [String, nil] The recipient name at the vendor address
       #
-      #   @param vendor_address_recipient [String, nil]
+      #   @param vendor_company_id [String, nil] Vendor company ID. For Belgium this is the CBE number or their EUID (European Un
       #
-      #   @param vendor_email [String, nil]
+      #   @param vendor_email [String, nil] The email address of the vendor
       #
-      #   @param vendor_name [String, nil]
+      #   @param vendor_name [String, nil] The name of the vendor/seller/supplier
       #
-      #   @param vendor_tax_id [String, nil]
+      #   @param vendor_tax_id [String, nil] Vendor tax ID. For Belgium this is the VAT number. Must include the country pref
 
       class Item < EInvoiceAPI::Internal::Type::BaseModel
         # @!attribute allowances
@@ -380,9 +432,9 @@ module EInvoiceAPI
         optional :allowances, -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::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
+        #   The invoice line net amount (BT-131), exclusive of VAT, inclusive of line level
+        #   allowances and charges. Calculated as: ((unit_price / price_base_quantity) \*
+        #   quantity) - allowances + charges. Must be rounded to maximum 2 decimals
         #
         #   @return [String, nil]
         optional :amount, String, nil?: true
@@ -404,6 +456,13 @@ module EInvoiceAPI
         #   @return [String, nil]
         optional :description, String, nil?: true
 
+        # @!attribute price_base_quantity
+        #   The item price base quantity (BT-149). The number of item units to which the
+        #   price applies. Defaults to 1. Must be rounded to maximum 4 decimals
+        #
+        #   @return [String, nil]
+        optional :price_base_quantity, String, nil?: true
+
         # @!attribute product_code
         #   The product code of the line item.
         #
@@ -436,18 +495,19 @@ 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
+        #   The item net price (BT-146). The price of an item, exclusive of VAT, after
+        #   subtracting item price discount. Must be rounded to maximum 4 decimals
         #
         #   @return [String, nil]
         optional :unit_price, String, nil?: true
 
-        # @!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)
+        # @!method initialize(allowances: nil, amount: nil, charges: nil, date: nil, description: nil, price_base_quantity: 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::DocumentCreateFromPdfResponse::Item} for more details.
         #
         #   @param allowances [Array<EInvoiceAPI::Models::Allowance>, nil] The allowances of the line item.
         #
-        #   @param amount [String, nil] The total amount of the line item, exclusive of VAT, after subtracting line leve
+        #   @param amount [String, nil] The invoice line net amount (BT-131), exclusive of VAT, inclusive of line level
         #
         #   @param charges [Array<EInvoiceAPI::Models::Charge>, nil] The charges of the line item.
         #
@@ -455,6 +515,8 @@ module EInvoiceAPI
         #
         #   @param description [String, nil] The description of the line item.
         #
+        #   @param price_base_quantity [String, nil] The item price base quantity (BT-149). The number of item units to which the pri
+        #
         #   @param product_code [String, nil] The product code of the line item.
         #
         #   @param quantity [String, nil] The quantity of items (goods or services) that is the subject of the line item.
@@ -465,10 +527,11 @@ module EInvoiceAPI
         #
         #   @param unit [Symbol, EInvoiceAPI::Models::UnitOfMeasureCode, nil] Unit of Measure Codes from UNECERec20 used in Peppol BIS Billing 3.0.
         #
-        #   @param unit_price [String, nil] The unit price of the line item. Must be rounded to maximum 2 decimals
+        #   @param unit_price [String, nil] The item net price (BT-146). The price of an item, exclusive of VAT, after subtr
       end
 
-      # Tax category code of the invoice
+      # Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E
+      # for exempt)
       #
       # @see EInvoiceAPI::Models::DocumentCreateFromPdfResponse#tax_code
       module TaxCode
@@ -491,18 +554,21 @@ module EInvoiceAPI
 
       class TaxDetail < EInvoiceAPI::Internal::Type::BaseModel
         # @!attribute amount
+        #   The tax amount for this tax category. Must be rounded to maximum 2 decimals
         #
         #   @return [String, nil]
         optional :amount, String, nil?: true
 
         # @!attribute rate
+        #   The tax rate as a percentage (e.g., '21.00', '6.00', '0.00')
         #
         #   @return [String, nil]
         optional :rate, String, nil?: true
 
         # @!method initialize(amount: nil, rate: nil)
-        #   @param amount [String, nil]
-        #   @param rate [String, nil]
+        #   @param amount [String, nil] The tax amount for this tax category. Must be rounded to maximum 2 decimals
+        #
+        #   @param rate [String, nil] The tax rate as a percentage (e.g., '21.00', '6.00', '0.00')
       end
 
       # VATEX code list for VAT exemption reasons