Class: EInvoiceAPI::Models::OutboxListReceivedDocumentsParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/e_invoice_api/models/outbox_list_received_documents_params.rb

Overview

See Also:

Defined Under Namespace

Modules: SortBy, SortOrder

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(date_from: nil, date_to: nil, page: nil, page_size: nil, receiver: nil, search: nil, sender: nil, sort_by: nil, sort_order: nil, type: nil, request_options: {}) ⇒ Object

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

Parameters:

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

    Filter by issue date (from)

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

    Filter by issue date (to)

  • page (Integer) (defaults to: nil) —

    Page number

  • page_size (Integer) (defaults to: nil) —

    Number of items per page

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

    Filter by receiver (customer_name, customer_email, customer_tax_id, customer_com

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

    Search in invoice number, seller/buyer names

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

    (Deprecated) Filter by sender ID

  • sort_by (Symbol, EInvoiceAPI::Models::OutboxListReceivedDocumentsParams::SortBy) (defaults to: nil) —

    Field to sort by

  • sort_order (Symbol, EInvoiceAPI::Models::OutboxListReceivedDocumentsParams::SortOrder) (defaults to: nil) —

    Sort direction (asc/desc)

  • type (Symbol, EInvoiceAPI::Models::DocumentType, nil) (defaults to: nil) —

    Filter by document type. If not provided, returns all types.

  • request_options (EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/e_invoice_api/models/outbox_list_received_documents_params.rb', line 71

Instance Attribute Details

#date_from ⇒ Time?

Filter by issue date (from)

Returns:

  • (Time, nil) 


14
 
# File 'lib/e_invoice_api/models/outbox_list_received_documents_params.rb', line 14

optional :date_from, Time, nil?: true

#date_to ⇒ Time?

Filter by issue date (to)

Returns:

  • (Time, nil) 


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

optional :date_to, Time, nil?: true

#page ⇒ Integer?

Page number

Returns:

  • (Integer, nil) 


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

optional :page, Integer

#page_size ⇒ Integer?

Number of items per page

Returns:

  • (Integer, nil) 


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

optional :page_size, Integer

#receiver ⇒ String?

Filter by receiver (customer_name, customer_email, customer_tax_id, customer_company_id, customer_id)

Returns:

  • (String, nil) 


39
 
# File 'lib/e_invoice_api/models/outbox_list_received_documents_params.rb', line 39

optional :receiver, String, nil?: true

#search ⇒ String?

Search in invoice number, seller/buyer names

Returns:

  • (String, nil) 


45
 
# File 'lib/e_invoice_api/models/outbox_list_received_documents_params.rb', line 45

optional :search, String, nil?: true

#sender ⇒ String?

(Deprecated) Filter by sender ID

Returns:

  • (String, nil) 


51
 
# File 'lib/e_invoice_api/models/outbox_list_received_documents_params.rb', line 51

optional :sender, String, nil?: true

#sort_by ⇒ Symbol, ...

Field to sort by

Returns:



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

optional :sort_by, enum: -> { EInvoiceAPI::OutboxListReceivedDocumentsParams::SortBy }

#sort_order ⇒ Symbol, ...

Sort direction (asc/desc)

Returns:



63
 
# File 'lib/e_invoice_api/models/outbox_list_received_documents_params.rb', line 63

optional :sort_order, enum: -> { EInvoiceAPI::OutboxListReceivedDocumentsParams::SortOrder }

#type ⇒ Symbol, ...

Filter by document type. If not provided, returns all types.

Returns:



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

optional :type, enum: -> { EInvoiceAPI::DocumentType }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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