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 of the invoice.

• #attachments ⇒ Array<EInvoiceAPI::Models::Documents::DocumentAttachment>^?
• #billing_address ⇒ String^?
• #billing_address_recipient ⇒ String^?
• #charges ⇒ Array<EInvoiceAPI::Models::DocumentResponse::Charge>^?
• #currency ⇒ Symbol, ...

  Currency of the invoice.

• #customer_address ⇒ String^?
• #customer_address_recipient ⇒ String^?
• #customer_email ⇒ String^?
• #customer_id ⇒ String^?
• #customer_name ⇒ String^?
• #customer_tax_id ⇒ String^?
• #direction ⇒ Symbol, ...
• #document_type ⇒ Symbol, ...
• #due_date ⇒ Date^?
• #id ⇒ String
• #invoice_date ⇒ Date^?
• #invoice_id ⇒ String^?
• #invoice_total ⇒ String^?

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

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

  The previous unpaid balance of the invoice, if any.

• #purchase_order ⇒ String^?
• #remittance_address ⇒ String^?
• #remittance_address_recipient ⇒ String^?
• #service_address ⇒ String^?
• #service_address_recipient ⇒ String^?
• #service_end_date ⇒ Date^?
• #service_start_date ⇒ Date^?
• #shipping_address ⇒ String^?
• #shipping_address_recipient ⇒ String^?
• #state ⇒ Symbol, ...
• #subtotal ⇒ String^?

  The taxable base of the invoice.

• #tax_code ⇒ Symbol, ...

  Tax category code of the invoice.

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

  The total financial discount of the invoice (so discounts not subject to VAT).

• #total_tax ⇒ String^?

  The total tax of the invoice.

• #vatex ⇒ Symbol, ...

  VATEX code list for VAT exemption reasons.

• #vatex_note ⇒ String^?

  VAT exemption note of the invoice.

• #vendor_address ⇒ String^?
• #vendor_address_recipient ⇒ String^?
• #vendor_email ⇒ String^?
• #vendor_name ⇒ String^?
• #vendor_tax_id ⇒ String^?

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)
• rate (String, nil) (defaults to: nil)

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

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 15

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

#amount_due ⇒ String^?

The amount due 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 24

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 29

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

#billing_address ⇒ String^?

Returns:

• (String, nil)

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

optional :billing_address, String, nil?: true

#billing_address_recipient ⇒ String^?

Returns:

• (String, nil)

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

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 46

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

#currency ⇒ Symbol, ...

Currency of the invoice

Returns:

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

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

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

#customer_address ⇒ String^?

Returns:

• (String, nil)

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

optional :customer_address, String, nil?: true

#customer_address_recipient ⇒ String^?

Returns:

• (String, nil)

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

optional :customer_address_recipient, String, nil?: true

#customer_email ⇒ String^?

Returns:

• (String, nil)

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

optional :customer_email, String, nil?: true

#customer_id ⇒ String^?

Returns:

• (String, nil)

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

optional :customer_id, String, nil?: true

#customer_name ⇒ String^?

Returns:

• (String, nil)

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

optional :customer_name, String, nil?: true

#customer_tax_id ⇒ String^?

Returns:

• (String, nil)

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

optional :customer_tax_id, String, nil?: true

#direction ⇒ Symbol, ...

Returns:

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

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

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

#document_type ⇒ Symbol, ...

Returns:

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

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

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

#due_date ⇒ Date^?

Returns:

• (Date, nil)

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

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^?

Returns:

• (Date, nil)

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

optional :invoice_date, Date, nil?: true

#invoice_id ⇒ String^?

Returns:

• (String, nil)

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

optional :invoice_id, String, nil?: true

#invoice_total ⇒ String^?

The total amount of the invoice (so 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 116

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 121

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

#note ⇒ String^?

Returns:

• (String, nil)

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

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 133

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

#payment_term ⇒ String^?

Returns:

• (String, nil)

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

optional :payment_term, String, nil?: true

#previous_unpaid_balance ⇒ String^?

The previous unpaid balance of the invoice, if any. Must be positive and rounded to maximum 2 decimals

Returns:

• (String, nil)

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

optional :previous_unpaid_balance, String, nil?: true

#purchase_order ⇒ String^?

Returns:

• (String, nil)

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

optional :purchase_order, String, nil?: true

#remittance_address ⇒ String^?

Returns:

• (String, nil)

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

optional :remittance_address, String, nil?: true

#remittance_address_recipient ⇒ String^?

Returns:

• (String, nil)

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

optional :remittance_address_recipient, String, nil?: true

#service_address ⇒ String^?

Returns:

• (String, nil)

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

optional :service_address, String, nil?: true

#service_address_recipient ⇒ String^?

Returns:

• (String, nil)

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

optional :service_address_recipient, String, nil?: true

#service_end_date ⇒ Date^?

Returns:

• (Date, nil)

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

optional :service_end_date, Date, nil?: true

#service_start_date ⇒ Date^?

Returns:

• (Date, nil)

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

optional :service_start_date, Date, nil?: true

#shipping_address ⇒ String^?

Returns:

• (String, nil)

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

optional :shipping_address, String, nil?: true

#shipping_address_recipient ⇒ String^?

Returns:

• (String, nil)

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

optional :shipping_address_recipient, String, nil?: true

#state ⇒ Symbol, ...

Returns:

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

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

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 205

optional :subtotal, String, nil?: true

#tax_code ⇒ Symbol, ...

Tax category code of the invoice

Returns:

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

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

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 216

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

#total_discount ⇒ String^?

The total financial discount of the invoice (so discounts not subject to VAT). Must be positive and rounded to maximum 2 decimals

Returns:

• (String, nil)

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

optional :total_discount, String, nil?: true

#total_tax ⇒ String^?

The total tax 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 231

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 239

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

#vatex_note ⇒ String^?

VAT exemption note of the invoice

Returns:

• (String, nil)

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

optional :vatex_note, String, nil?: true

#vendor_address ⇒ String^?

Returns:

• (String, nil)

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

optional :vendor_address, String, nil?: true

#vendor_address_recipient ⇒ String^?

Returns:

• (String, nil)

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

optional :vendor_address_recipient, String, nil?: true

#vendor_email ⇒ String^?

Returns:

• (String, nil)

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

optional :vendor_email, String, nil?: true

#vendor_name ⇒ String^?

Returns:

• (String, nil)

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

optional :vendor_name, String, nil?: true

#vendor_tax_id ⇒ String^?

Returns:

• (String, nil)

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

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 454