Class: EInvoiceAPI::Models::DocumentCreate

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/e_invoice_api/models/document_create.rb

Defined Under Namespace

Modules: AmountDue, InvoiceTotal, PreviousUnpaidBalance, Subtotal, TotalDiscount, TotalTax Classes: Item, TaxDetail

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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_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) ⇒ Object

Parameters:

  • amount_due (Float, String, nil) (defaults to: nil)
  • attachments (Array<EInvoiceAPI::Models::DocumentAttachmentCreate>, nil) (defaults to: nil)
  • billing_address (String, nil) (defaults to: nil)
  • billing_address_recipient (String, nil) (defaults to: nil)
  • currency (Symbol, EInvoiceAPI::Models::CurrencyCode) (defaults to: nil) —

    Currency of the invoice

  • customer_address (String, nil) (defaults to: nil)
  • customer_address_recipient (String, nil) (defaults to: nil)
  • customer_email (String, nil) (defaults to: nil)
  • customer_id (String, nil) (defaults to: nil)
  • customer_name (String, nil) (defaults to: nil)
  • customer_tax_id (String, nil) (defaults to: nil)
  • direction (Symbol, EInvoiceAPI::Models::DocumentDirection) (defaults to: nil)
  • document_type (Symbol, EInvoiceAPI::Models::DocumentType) (defaults to: nil)
  • due_date (Date, nil) (defaults to: nil)
  • invoice_date (Date, nil) (defaults to: nil)
  • invoice_id (String, nil) (defaults to: nil)
  • invoice_total (Float, String, nil) (defaults to: nil)
  • items (Array<EInvoiceAPI::Models::DocumentCreate::Item>, nil) (defaults to: nil)
  • note (String, nil) (defaults to: nil)
  • payment_details (Array<EInvoiceAPI::Models::PaymentDetailCreate>, nil) (defaults to: nil)
  • payment_term (String, nil) (defaults to: nil)
  • previous_unpaid_balance (Float, String, nil) (defaults to: nil)
  • purchase_order (String, nil) (defaults to: nil)
  • remittance_address (String, nil) (defaults to: nil)
  • remittance_address_recipient (String, nil) (defaults to: nil)
  • service_address (String, nil) (defaults to: nil)
  • service_address_recipient (String, nil) (defaults to: nil)
  • service_end_date (Date, nil) (defaults to: nil)
  • service_start_date (Date, nil) (defaults to: nil)
  • shipping_address (String, nil) (defaults to: nil)
  • shipping_address_recipient (String, nil) (defaults to: nil)
  • state (Symbol, EInvoiceAPI::Models::DocumentState) (defaults to: nil)
  • subtotal (Float, String, nil) (defaults to: nil)
  • tax_details (Array<EInvoiceAPI::Models::DocumentCreate::TaxDetail>, nil) (defaults to: nil)
  • total_discount (Float, String, nil) (defaults to: nil)
  • total_tax (Float, String, nil) (defaults to: nil)
  • vendor_address (String, nil) (defaults to: nil)
  • vendor_address_recipient (String, nil) (defaults to: nil)
  • vendor_email (String, nil) (defaults to: nil)
  • vendor_name (String, nil) (defaults to: nil)
  • vendor_tax_id (String, nil) (defaults to: nil) 



# File 'lib/e_invoice_api/models/document_create.rb', line 222

Instance Attribute Details

#amount_due ⇒ Float, ...

Returns:

  • (Float, String, nil) 


9
 
# File 'lib/e_invoice_api/models/document_create.rb', line 9

optional :amount_due, union: -> { EInvoiceAPI::DocumentCreate::AmountDue }, nil?: true

#attachments ⇒ Array<EInvoiceAPI::Models::DocumentAttachmentCreate>?

Returns:



14
15
16
 
# File 'lib/e_invoice_api/models/document_create.rb', line 14

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

#billing_address ⇒ String?

Returns:

  • (String, nil) 


21
 
# File 'lib/e_invoice_api/models/document_create.rb', line 21

optional :billing_address, String, nil?: true

#billing_address_recipient ⇒ String?

Returns:

  • (String, nil) 


26
 
# File 'lib/e_invoice_api/models/document_create.rb', line 26

optional :billing_address_recipient, String, nil?: true

#currency ⇒ Symbol, ...

Currency of the invoice

Returns:



32
 
# File 'lib/e_invoice_api/models/document_create.rb', line 32

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

#customer_address ⇒ String?

Returns:

  • (String, nil) 


37
 
# File 'lib/e_invoice_api/models/document_create.rb', line 37

optional :customer_address, String, nil?: true

#customer_address_recipient ⇒ String?

Returns:

  • (String, nil) 


42
 
# File 'lib/e_invoice_api/models/document_create.rb', line 42

optional :customer_address_recipient, String, nil?: true

#customer_email ⇒ String?

Returns:

  • (String, nil) 


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

optional :customer_email, String, nil?: true

#customer_id ⇒ String?

Returns:

  • (String, nil) 


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

optional :customer_id, String, nil?: true

#customer_name ⇒ String?

Returns:

  • (String, nil) 


57
 
# File 'lib/e_invoice_api/models/document_create.rb', line 57

optional :customer_name, String, nil?: true

#customer_tax_id ⇒ String?

Returns:

  • (String, nil) 


62
 
# File 'lib/e_invoice_api/models/document_create.rb', line 62

optional :customer_tax_id, String, nil?: true

#direction ⇒ Symbol, ...

Returns:



67
 
# File 'lib/e_invoice_api/models/document_create.rb', line 67

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

#document_type ⇒ Symbol, ...

Returns:



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

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

#due_date ⇒ Date?

Returns:

  • (Date, nil) 


77
 
# File 'lib/e_invoice_api/models/document_create.rb', line 77

optional :due_date, Date, nil?: true

#invoice_date ⇒ Date?

Returns:

  • (Date, nil) 


82
 
# File 'lib/e_invoice_api/models/document_create.rb', line 82

optional :invoice_date, Date, nil?: true

#invoice_id ⇒ String?

Returns:

  • (String, nil) 


87
 
# File 'lib/e_invoice_api/models/document_create.rb', line 87

optional :invoice_id, String, nil?: true

#invoice_total ⇒ Float, ...

Returns:

  • (Float, String, nil) 


92
 
# File 'lib/e_invoice_api/models/document_create.rb', line 92

optional :invoice_total, union: -> { EInvoiceAPI::DocumentCreate::InvoiceTotal }, nil?: true

#items ⇒ Array<EInvoiceAPI::Models::DocumentCreate::Item>?

Returns:



97
98
99
 
# File 'lib/e_invoice_api/models/document_create.rb', line 97

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

#note ⇒ String?

Returns:

  • (String, nil) 


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

optional :note, String, nil?: true

#payment_details ⇒ Array<EInvoiceAPI::Models::PaymentDetailCreate>?

Returns:



109
110
111
 
# File 'lib/e_invoice_api/models/document_create.rb', line 109

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

#payment_term ⇒ String?

Returns:

  • (String, nil) 


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

optional :payment_term, String, nil?: true

#previous_unpaid_balance ⇒ Float, ...

Returns:

  • (Float, String, nil) 


121
122
123
 
# File 'lib/e_invoice_api/models/document_create.rb', line 121

optional :previous_unpaid_balance,
union: -> { EInvoiceAPI::DocumentCreate::PreviousUnpaidBalance },
nil?: true

#purchase_order ⇒ String?

Returns:

  • (String, nil) 


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

optional :purchase_order, String, nil?: true

#remittance_address ⇒ String?

Returns:

  • (String, nil) 


133
 
# File 'lib/e_invoice_api/models/document_create.rb', line 133

optional :remittance_address, String, nil?: true

#remittance_address_recipient ⇒ String?

Returns:

  • (String, nil) 


138
 
# File 'lib/e_invoice_api/models/document_create.rb', line 138

optional :remittance_address_recipient, String, nil?: true

#service_address ⇒ String?

Returns:

  • (String, nil) 


143
 
# File 'lib/e_invoice_api/models/document_create.rb', line 143

optional :service_address, String, nil?: true

#service_address_recipient ⇒ String?

Returns:

  • (String, nil) 


148
 
# File 'lib/e_invoice_api/models/document_create.rb', line 148

optional :service_address_recipient, String, nil?: true

#service_end_date ⇒ Date?

Returns:

  • (Date, nil) 


153
 
# File 'lib/e_invoice_api/models/document_create.rb', line 153

optional :service_end_date, Date, nil?: true

#service_start_date ⇒ Date?

Returns:

  • (Date, nil) 


158
 
# File 'lib/e_invoice_api/models/document_create.rb', line 158

optional :service_start_date, Date, nil?: true

#shipping_address ⇒ String?

Returns:

  • (String, nil) 


163
 
# File 'lib/e_invoice_api/models/document_create.rb', line 163

optional :shipping_address, String, nil?: true

#shipping_address_recipient ⇒ String?

Returns:

  • (String, nil) 


168
 
# File 'lib/e_invoice_api/models/document_create.rb', line 168

optional :shipping_address_recipient, String, nil?: true

#state ⇒ Symbol, ...

Returns:



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

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

#subtotal ⇒ Float, ...

Returns:

  • (Float, String, nil) 


178
 
# File 'lib/e_invoice_api/models/document_create.rb', line 178

optional :subtotal, union: -> { EInvoiceAPI::DocumentCreate::Subtotal }, nil?: true

#tax_details ⇒ Array<EInvoiceAPI::Models::DocumentCreate::TaxDetail>?

Returns:



183
184
185
 
# File 'lib/e_invoice_api/models/document_create.rb', line 183

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

#total_discount ⇒ Float, ...

Returns:

  • (Float, String, nil) 


190
 
# File 'lib/e_invoice_api/models/document_create.rb', line 190

optional :total_discount, union: -> { EInvoiceAPI::DocumentCreate::TotalDiscount }, nil?: true

#total_tax ⇒ Float, ...

Returns:

  • (Float, String, nil) 


195
 
# File 'lib/e_invoice_api/models/document_create.rb', line 195

optional :total_tax, union: -> { EInvoiceAPI::DocumentCreate::TotalTax }, nil?: true

#vendor_address ⇒ String?

Returns:

  • (String, nil) 


200
 
# File 'lib/e_invoice_api/models/document_create.rb', line 200

optional :vendor_address, String, nil?: true

#vendor_address_recipient ⇒ String?

Returns:

  • (String, nil) 


205
 
# File 'lib/e_invoice_api/models/document_create.rb', line 205

optional :vendor_address_recipient, String, nil?: true

#vendor_email ⇒ String?

Returns:

  • (String, nil) 


210
 
# File 'lib/e_invoice_api/models/document_create.rb', line 210

optional :vendor_email, String, nil?: true

#vendor_name ⇒ String?

Returns:

  • (String, nil) 


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

optional :vendor_name, String, nil?: true

#vendor_tax_id ⇒ String?

Returns:

  • (String, nil) 


220
 
# File 'lib/e_invoice_api/models/document_create.rb', line 220

optional :vendor_tax_id, String, nil?: true

Class Method Details

.variants ⇒ Array(Float, String)

Returns:

  • (Array(Float, String)) 



# File 'lib/e_invoice_api/models/document_create.rb', line 313