e-invoice-api 0.5.3 → 0.7.0

data/lib/e_invoice_api/resources/documents.rb

@@ -9,11 +9,16 @@ module EInvoiceAPI
       # @return [EInvoiceAPI::Resources::Documents::Ubl]
       attr_reader :ubl
 
+      # Some parameter documentations has been truncated, see
+      # {EInvoiceAPI::Models::DocumentCreateParams} for more details.
+      #
       # Create a new invoice or credit note
       #
-      # @overload create(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, request_options: {})
+      # @overload create(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, request_options: {})
+      #
+      # @param allowances [Array<EInvoiceAPI::Models::DocumentCreate::Allowance>, nil]
       #
-      # @param amount_due [Float, String, 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]
       #
@@ -21,6 +26,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]
@@ -45,9 +52,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]
       #
@@ -55,7 +62,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]
       #
@@ -77,13 +84,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]
       #

data/lib/e_invoice_api/resources/validate.rb

@@ -3,11 +3,16 @@
 module EInvoiceAPI
   module Resources
     class Validate
+      # Some parameter documentations has been truncated, see
+      # {EInvoiceAPI::Models::ValidateValidateJsonParams} for more details.
+      #
       # Validate if the JSON document can be converted to a valid UBL document
       #
-      # @overload validate_json(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, request_options: {})
+      # @overload validate_json(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, request_options: {})
       #
-      # @param amount_due [Float, String, nil]
+      # @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]
       #
@@ -15,6 +20,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]
@@ -39,9 +46,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]
       #
@@ -49,7 +56,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]
       #
@@ -71,13 +78,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]
       #

data/lib/e_invoice_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EInvoiceAPI
-  VERSION = "0.5.3"
+  VERSION = "0.7.0"
 end