Class: EInvoiceAPI::Models::DocumentResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• EInvoiceAPI::Models::DocumentResponse

Defined in:

lib/e_invoice_api/models/document_response.rb

Overview

See Also:

• Resources::Documents#create

Defined Under Namespace

Modules: TaxCode, Vatex Classes: Allowance, Charge, Item, PaymentDetail, TaxDetail

Instance Attribute Summary

• #allowances ⇒ Array<EInvoiceAPI::Models::DocumentResponse::Allowance>^?
• #amount_due ⇒ String^?

  The amount due for payment.

• #attachments ⇒ Array<EInvoiceAPI::Models::Documents::DocumentAttachment>^?
• #billing_address ⇒ String^?

  The billing address (if different from customer address).

• #billing_address_recipient ⇒ String^?

  The recipient name at the billing address.

• #charges ⇒ Array<EInvoiceAPI::Models::DocumentResponse::Charge>^?
• #created_at ⇒ Time
• #currency ⇒ Symbol, ...

  Currency of the invoice (ISO 4217 currency code).

• #customer_address ⇒ String^?

  The address of the customer/buyer.

• #customer_address_recipient ⇒ String^?

  The recipient name at the customer address.

• #customer_company_id ⇒ String^?

  Customer company ID.

• #customer_email ⇒ String^?

  The email address of the customer.

• #customer_id ⇒ String^?

  The unique identifier for the customer in your system.

• #customer_name ⇒ String^?

  The company name of the customer/buyer.

• #customer_peppol_id ⇒ String^?

  Customer Peppol ID.

• #customer_tax_id ⇒ String^?

  Customer tax ID.

• #direction ⇒ Symbol, ...

  The direction of the document: INBOUND (purchases) or OUTBOUND (sales).

• #document_type ⇒ Symbol, ...

  The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE.

• #due_date ⇒ Date^?

  The date when payment is due.

• #id ⇒ String
• #invoice_date ⇒ Date^?

  The date when the invoice was issued.

• #invoice_id ⇒ String^?

  The unique invoice identifier/number.

• #invoice_total ⇒ String^?

  The total amount of the invoice including tax (invoice_total = subtotal + total_tax + total_discount).

• #items ⇒ Array<EInvoiceAPI::Models::DocumentResponse::Item>^?
• #note ⇒ String^?

  Additional notes or comments for the invoice.

• #payment_details ⇒ Array<EInvoiceAPI::Models::DocumentResponse::PaymentDetail>^?
• #payment_term ⇒ String^?

  The payment terms (e.g., ‘Net 30’, ‘Due on receipt’, ‘2/10 Net 30’).

• #purchase_order ⇒ String^?

  The purchase order reference number.

• #remittance_address ⇒ String^?

  The address where payment should be sent or remitted to.

• #remittance_address_recipient ⇒ String^?

  The recipient name at the remittance address.

• #service_address ⇒ String^?

  The address where services were performed or goods were delivered.

• #service_address_recipient ⇒ String^?

  The recipient name at the service address.

• #service_end_date ⇒ Date^?

  The end date of the service period or delivery period.

• #service_start_date ⇒ Date^?

  The start date of the service period or delivery period.

• #shipping_address ⇒ String^?

  The shipping/delivery address.

• #shipping_address_recipient ⇒ String^?

  The recipient name at the shipping address.

• #state ⇒ Symbol, ...

  The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED.

• #subtotal ⇒ String^?

  The taxable base of the invoice.

• #tax_code ⇒ Symbol, ...

  Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E for exempt).

• #tax_details ⇒ Array<EInvoiceAPI::Models::DocumentResponse::TaxDetail>^?
• #total_discount ⇒ String^?

  The net financial discount/charge of the invoice (non-VAT charges minus non-VAT allowances).

• #total_tax ⇒ String^?

  The total tax amount of the invoice.

• #vatex ⇒ Symbol, ...

  VATEX code list for VAT exemption reasons.

• #vatex_note ⇒ String^?

  Textual explanation for VAT exemption.

• #vendor_address ⇒ String^?

  The address of the vendor/seller.

• #vendor_address_recipient ⇒ String^?

  The recipient name at the vendor address.

• #vendor_company_id ⇒ String^?

  Vendor company ID.

• #vendor_email ⇒ String^?

  The email address of the vendor.

• #vendor_name ⇒ String^?

  The name of the vendor/seller/supplier.

• #vendor_tax_id ⇒ String^?

  Vendor tax ID.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(amount: nil, rate: nil) ⇒ Object constructor

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(amount: nil, rate: nil) ⇒ Object

Parameters:

• amount (String, nil) (defaults to: nil) —

  The tax amount for this tax category. Must be rounded to maximum 2 decimals

• rate (String, nil) (defaults to: nil) —

  The tax rate as a percentage (e.g., ‘21.00’, ‘6.00’, ‘0.00’)

# File 'lib/e_invoice_api/models/document_response.rb', line 896

Instance Attribute Details

#allowances ⇒ Array<EInvoiceAPI::Models::DocumentResponse::Allowance>^?

Returns:

• (Array<EInvoiceAPI::Models::DocumentResponse::Allowance>, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 20

optional :allowances,
-> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::DocumentResponse::Allowance] },
nil?: true

#amount_due ⇒ String^?

The amount due for payment. Must be positive and rounded to maximum 2 decimals

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 28

optional :amount_due, String, nil?: true

#attachments ⇒ Array<EInvoiceAPI::Models::Documents::DocumentAttachment>^?

Returns:

• (Array<EInvoiceAPI::Models::Documents::DocumentAttachment>, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 33

optional :attachments,
-> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Documents::DocumentAttachment] },
nil?: true

#billing_address ⇒ String^?

The billing address (if different from customer address)

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 41

optional :billing_address, String, nil?: true

#billing_address_recipient ⇒ String^?

The recipient name at the billing address

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 47

optional :billing_address_recipient, String, nil?: true

#charges ⇒ Array<EInvoiceAPI::Models::DocumentResponse::Charge>^?

Returns:

• (Array<EInvoiceAPI::Models::DocumentResponse::Charge>, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 52

optional :charges,
-> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::DocumentResponse::Charge] },
nil?: true

#created_at ⇒ Time

Returns:

• (Time)

# File 'lib/e_invoice_api/models/document_response.rb', line 15

required :created_at, Time

#currency ⇒ Symbol, ...

Currency of the invoice (ISO 4217 currency code)

Returns:

• (Symbol, EInvoiceAPI::Models::CurrencyCode, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 60

optional :currency, enum: -> { EInvoiceAPI::CurrencyCode }

#customer_address ⇒ String^?

The address of the customer/buyer

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 66

optional :customer_address, String, nil?: true

#customer_address_recipient ⇒ String^?

The recipient name at the customer address

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 72

optional :customer_address_recipient, String, nil?: true

#customer_company_id ⇒ String^?

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.

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 79

optional :customer_company_id, String, nil?: true

#customer_email ⇒ String^?

The email address of the customer

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 85

optional :customer_email, String, nil?: true

#customer_id ⇒ String^?

The unique identifier for the customer in your system

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 91

optional :customer_id, String, nil?: true

#customer_name ⇒ String^?

The company name of the customer/buyer

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 97

optional :customer_name, String, nil?: true

#customer_peppol_id ⇒ String^?

Customer Peppol ID

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 103

optional :customer_peppol_id, String, nil?: true

#customer_tax_id ⇒ String^?

Customer tax ID. For Belgium this is the VAT number. Must include the country prefix

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 110

optional :customer_tax_id, String, nil?: true

#direction ⇒ Symbol, ...

The direction of the document: INBOUND (purchases) or OUTBOUND (sales)

Returns:

• (Symbol, EInvoiceAPI::Models::DocumentDirection, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 116

optional :direction, enum: -> { EInvoiceAPI::DocumentDirection }

#document_type ⇒ Symbol, ...

The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE

Returns:

• (Symbol, EInvoiceAPI::Models::DocumentType, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 122

optional :document_type, enum: -> { EInvoiceAPI::DocumentType }

#due_date ⇒ Date^?

The date when payment is due

Returns:

• (Date, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 128

optional :due_date, Date, nil?: true

#id ⇒ String

Returns:

• (String)

# File 'lib/e_invoice_api/models/document_response.rb', line 10

required :id, String

#invoice_date ⇒ Date^?

The date when the invoice was issued

Returns:

• (Date, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 134

optional :invoice_date, Date, nil?: true

#invoice_id ⇒ String^?

The unique invoice identifier/number

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 140

optional :invoice_id, String, nil?: true

#invoice_total ⇒ String^?

The total amount of the invoice including tax (invoice_total = subtotal + total_tax + total_discount). Must be positive and rounded to maximum 2 decimals

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 147

optional :invoice_total, String, nil?: true

#items ⇒ Array<EInvoiceAPI::Models::DocumentResponse::Item>^?

Returns:

• (Array<EInvoiceAPI::Models::DocumentResponse::Item>, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 152

optional :items,
-> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::DocumentResponse::Item] },
nil?: true

#note ⇒ String^?

Additional notes or comments for the invoice

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 160

optional :note, String, nil?: true

#payment_details ⇒ Array<EInvoiceAPI::Models::DocumentResponse::PaymentDetail>^?

Returns:

• (Array<EInvoiceAPI::Models::DocumentResponse::PaymentDetail>, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 165

optional :payment_details,
-> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::DocumentResponse::PaymentDetail] },
nil?: true

#payment_term ⇒ String^?

The payment terms (e.g., ‘Net 30’, ‘Due on receipt’, ‘2/10 Net 30’)

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 173

optional :payment_term, String, nil?: true

#purchase_order ⇒ String^?

The purchase order reference number

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 179

optional :purchase_order, String, nil?: true

#remittance_address ⇒ String^?

The address where payment should be sent or remitted to

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 185

optional :remittance_address, String, nil?: true

#remittance_address_recipient ⇒ String^?

The recipient name at the remittance address

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 191

optional :remittance_address_recipient, String, nil?: true

#service_address ⇒ String^?

The address where services were performed or goods were delivered

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 197

optional :service_address, String, nil?: true

#service_address_recipient ⇒ String^?

The recipient name at the service address

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 203

optional :service_address_recipient, String, nil?: true

#service_end_date ⇒ Date^?

The end date of the service period or delivery period

Returns:

• (Date, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 209

optional :service_end_date, Date, nil?: true

#service_start_date ⇒ Date^?

The start date of the service period or delivery period

Returns:

• (Date, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 215

optional :service_start_date, Date, nil?: true

#shipping_address ⇒ String^?

The shipping/delivery address

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 221

optional :shipping_address, String, nil?: true

#shipping_address_recipient ⇒ String^?

The recipient name at the shipping address

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 227

optional :shipping_address_recipient, String, nil?: true

#state ⇒ Symbol, ...

The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED

Returns:

• (Symbol, EInvoiceAPI::Models::DocumentState, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 233

optional :state, enum: -> { EInvoiceAPI::DocumentState }

#subtotal ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 241

optional :subtotal, String, nil?: true

#tax_code ⇒ Symbol, ...

Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E for exempt)

Returns:

• (Symbol, EInvoiceAPI::Models::DocumentResponse::TaxCode, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 248

optional :tax_code, enum: -> { EInvoiceAPI::DocumentResponse::TaxCode }

#tax_details ⇒ Array<EInvoiceAPI::Models::DocumentResponse::TaxDetail>^?

Returns:

• (Array<EInvoiceAPI::Models::DocumentResponse::TaxDetail>, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 253

optional :tax_details,
-> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::DocumentResponse::TaxDetail] },
nil?: true

#total_discount ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 263

optional :total_discount, String, nil?: true

#total_tax ⇒ String^?

The total tax amount of the invoice. Must be positive and rounded to maximum 2 decimals

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 270

optional :total_tax, String, nil?: true

#vatex ⇒ Symbol, ...

VATEX code list for VAT exemption reasons

Agency: CEF Identifier: vatex

Returns:

• (Symbol, EInvoiceAPI::Models::DocumentResponse::Vatex, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 278

optional :vatex, enum: -> { EInvoiceAPI::DocumentResponse::Vatex }, nil?: true

#vatex_note ⇒ String^?

Textual explanation for VAT exemption

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 284

optional :vatex_note, String, nil?: true

#vendor_address ⇒ String^?

The address of the vendor/seller

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 290

optional :vendor_address, String, nil?: true

#vendor_address_recipient ⇒ String^?

The recipient name at the vendor address

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 296

optional :vendor_address_recipient, String, nil?: true

#vendor_company_id ⇒ String^?

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.

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 303

optional :vendor_company_id, String, nil?: true

#vendor_email ⇒ String^?

The email address of the vendor

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 309

optional :vendor_email, String, nil?: true

#vendor_name ⇒ String^?

The name of the vendor/seller/supplier

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 315

optional :vendor_name, String, nil?: true

#vendor_tax_id ⇒ String^?

Vendor tax ID. For Belgium this is the VAT number. Must include the country prefix

Returns:

• (String, nil)

# File 'lib/e_invoice_api/models/document_response.rb', line 322

optional :vendor_tax_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/e_invoice_api/models/document_response.rb', line 540