Class: EInvoiceAPI::Models::MeRetrieveResponse

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

Overview

See Also:

Defined Under Namespace

Modules: Plan

Instance Attribute 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(credit_balance:, name:, plan:, bcc_recipient_email: nil, company_address: nil, company_city: nil, company_country: nil, company_email: nil, company_name: nil, company_number: nil, company_tax_id: nil, company_zip: nil, description: nil, ibans: nil, peppol_ids: nil, smp_registration: nil, smp_registration_date: nil) ⇒ Object

Some parameter documentations has been truncated, see EInvoiceAPI::Models::MeRetrieveResponse for more details.

Parameters:

  • credit_balance (Integer) —

    Credit balance of the tenant

  • name (String)
  • plan (Symbol, EInvoiceAPI::Models::MeRetrieveResponse::Plan) —

    Plan of the tenant

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

    BCC recipient email to deliver documents

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

    Address of the company. Must be in the form of ‘Street Name Street Number`

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

    City of the company

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

    Country of the company

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

    Email of the company

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

    Name of the company. Must include the company type. For example: ‘BV`, `NV`, `CV

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

    Company number. For Belgium this is the CBE number or their EUID (European Uniqu

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

    Company tax ID. For Belgium this is the VAT number. Must include the country pre

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

    Zip code of the company

  • description (String, nil) (defaults to: nil)
  • ibans (Array<String>, nil) (defaults to: nil) —

    IBANs of the tenant

  • peppol_ids (Array<String>, nil) (defaults to: nil) —

    Peppol IDs of the tenant

  • smp_registration (Boolean, nil) (defaults to: nil) —

    Whether the tenant is registered on our SMP

  • smp_registration_date (Time, nil) (defaults to: nil) —

    Date when the tenant was registered on SMP




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

Instance Attribute Details

#bcc_recipient_email ⇒ String?

BCC recipient email to deliver documents

Returns:

  • (String, nil) 


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

optional :bcc_recipient_email, String, nil?: true

#company_address ⇒ String?

Address of the company. Must be in the form of ‘Street Name Street Number`

Returns:

  • (String, nil) 


34
 
# File 'lib/e_invoice_api/models/me_retrieve_response.rb', line 34

optional :company_address, String, nil?: true

#company_city ⇒ String?

City of the company

Returns:

  • (String, nil) 


40
 
# File 'lib/e_invoice_api/models/me_retrieve_response.rb', line 40

optional :company_city, String, nil?: true

#company_country ⇒ String?

Country of the company

Returns:

  • (String, nil) 


46
 
# File 'lib/e_invoice_api/models/me_retrieve_response.rb', line 46

optional :company_country, String, nil?: true

#company_email ⇒ String?

Email of the company

Returns:

  • (String, nil) 


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

optional :company_email, String, nil?: true

#company_name ⇒ String?

Name of the company. Must include the company type. For example: ‘BV`, `NV`, `CVBA`, `VOF`

Returns:

  • (String, nil) 


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

optional :company_name, String, nil?: true

#company_number ⇒ String?

Company number. For Belgium this is the CBE number or their EUID (European Unique Identifier) number

Returns:

  • (String, nil) 


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

optional :company_number, String, nil?: true

#company_tax_id ⇒ String?

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

Returns:

  • (String, nil) 


73
 
# File 'lib/e_invoice_api/models/me_retrieve_response.rb', line 73

optional :company_tax_id, String, nil?: true

#company_zip ⇒ String?

Zip code of the company

Returns:

  • (String, nil) 


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

optional :company_zip, String, nil?: true

#credit_balance ⇒ Integer

Credit balance of the tenant

Returns:

  • (Integer) 


11
 
# File 'lib/e_invoice_api/models/me_retrieve_response.rb', line 11

required :credit_balance, Integer

#description ⇒ String?

Returns:

  • (String, nil) 


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

optional :description, String, nil?: true

#ibans ⇒ Array<String>?

IBANs of the tenant

Returns:

  • (Array<String>, nil) 


90
 
# File 'lib/e_invoice_api/models/me_retrieve_response.rb', line 90

optional :ibans, EInvoiceAPI::Internal::Type::ArrayOf[String], nil?: true

#name ⇒ String

Returns:

  • (String) 


16
 
# File 'lib/e_invoice_api/models/me_retrieve_response.rb', line 16

required :name, String

#peppol_ids ⇒ Array<String>?

Peppol IDs of the tenant

Returns:

  • (Array<String>, nil) 


96
 
# File 'lib/e_invoice_api/models/me_retrieve_response.rb', line 96

optional :peppol_ids, EInvoiceAPI::Internal::Type::ArrayOf[String], nil?: true

#plan ⇒ Symbol, EInvoiceAPI::Models::MeRetrieveResponse::Plan

Plan of the tenant

Returns:



22
 
# File 'lib/e_invoice_api/models/me_retrieve_response.rb', line 22

required :plan, enum: -> { EInvoiceAPI::Models::MeRetrieveResponse::Plan }

#smp_registration ⇒ Boolean?

Whether the tenant is registered on our SMP

Returns:

  • (Boolean, nil) 


102
 
# File 'lib/e_invoice_api/models/me_retrieve_response.rb', line 102

optional :smp_registration, EInvoiceAPI::Internal::Type::Boolean, nil?: true

#smp_registration_date ⇒ Time?

Date when the tenant was registered on SMP

Returns:

  • (Time, nil) 


108
 
# File 'lib/e_invoice_api/models/me_retrieve_response.rb', line 108

optional :smp_registration_date, Time, nil?: true