Class: EInvoiceAPI::Resources::Inbox

Inherits:

Object

• Object
• EInvoiceAPI::Resources::Inbox

Defined in:

lib/e_invoice_api/resources/inbox.rb

Instance Method Summary

• #initialize(client:) ⇒ Inbox constructor private

  A new instance of Inbox.

• #list(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sender: nil, sort_by: nil, sort_order: nil, type: nil, request_options: {}) ⇒ EInvoiceAPI::Internal::DocumentsNumberPage<EInvoiceAPI::Models::DocumentResponse>

  Retrieve a paginated list of received documents with filtering options including state, type, sender, date range, and text search.

• #list_credit_notes(page: nil, page_size: nil, sort_by: nil, sort_order: nil, request_options: {}) ⇒ EInvoiceAPI::Internal::DocumentsNumberPage<EInvoiceAPI::Models::DocumentResponse>

  Retrieve a paginated list of received credit notes with filtering options.

• #list_invoices(page: nil, page_size: nil, sort_by: nil, sort_order: nil, request_options: {}) ⇒ EInvoiceAPI::Internal::DocumentsNumberPage<EInvoiceAPI::Models::DocumentResponse>

  Retrieve a paginated list of received invoices with filtering options.

Constructor Details

#initialize(client:) ⇒ Inbox

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Inbox.

Parameters:

• client (EInvoiceAPI::Client)

# File 'lib/e_invoice_api/resources/inbox.rb', line 110

def initialize(client:)
  @client = client
end

Instance Method Details

#list(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sender: nil, sort_by: nil, sort_order: nil, type: nil, request_options: {}) ⇒ EInvoiceAPI::Internal::DocumentsNumberPage<EInvoiceAPI::Models::DocumentResponse>

Retrieve a paginated list of received documents with filtering options including state, type, sender, date range, and text search.

Parameters:

• date_from (Time, nil) —

  Filter by issue date (from)

• date_to (Time, nil) —

  Filter by issue date (to)

• page (Integer) —

  Page number

• page_size (Integer) —

  Number of items per page

• search (String, nil) —

  Search in invoice number, seller/buyer names

• sender (String, nil) —

  Filter by sender (vendor_name, vendor_email, vendor_tax_id, vendor_company_id)

• sort_by (Symbol, EInvoiceAPI::Models::InboxListParams::SortBy) —

  Field to sort by

• sort_order (Symbol, EInvoiceAPI::Models::InboxListParams::SortOrder) —

  Sort direction (asc/desc)

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

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

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

Returns:

• (EInvoiceAPI::Internal::DocumentsNumberPage<EInvoiceAPI::Models::DocumentResponse>)

See Also:

• Models::InboxListParams

# File 'lib/e_invoice_api/resources/inbox.rb', line 34

def list(params = {})
  parsed, options = EInvoiceAPI::InboxListParams.dump_request(params)
  query = EInvoiceAPI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "api/inbox/",
    query: query,
    page: EInvoiceAPI::Internal::DocumentsNumberPage,
    model: EInvoiceAPI::DocumentResponse,
    options: options
  )
end

#list_credit_notes(page: nil, page_size: nil, sort_by: nil, sort_order: nil, request_options: {}) ⇒ EInvoiceAPI::Internal::DocumentsNumberPage<EInvoiceAPI::Models::DocumentResponse>

Retrieve a paginated list of received credit notes with filtering options.

Parameters:

• page (Integer) —

  Page number

• page_size (Integer) —

  Number of items per page

• sort_by (Symbol, EInvoiceAPI::Models::InboxListCreditNotesParams::SortBy) —

  Field to sort by

• sort_order (Symbol, EInvoiceAPI::Models::InboxListCreditNotesParams::SortOrder) —

  Sort direction (asc/desc)

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

Returns:

• (EInvoiceAPI::Internal::DocumentsNumberPage<EInvoiceAPI::Models::DocumentResponse>)

See Also:

• Models::InboxListCreditNotesParams

# File 'lib/e_invoice_api/resources/inbox.rb', line 64

def list_credit_notes(params = {})
  parsed, options = EInvoiceAPI::InboxListCreditNotesParams.dump_request(params)
  query = EInvoiceAPI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "api/inbox/credit-notes",
    query: query,
    page: EInvoiceAPI::Internal::DocumentsNumberPage,
    model: EInvoiceAPI::DocumentResponse,
    options: options
  )
end

#list_invoices(page: nil, page_size: nil, sort_by: nil, sort_order: nil, request_options: {}) ⇒ EInvoiceAPI::Internal::DocumentsNumberPage<EInvoiceAPI::Models::DocumentResponse>

Retrieve a paginated list of received invoices with filtering options.

Parameters:

• page (Integer) —

  Page number

• page_size (Integer) —

  Number of items per page

• sort_by (Symbol, EInvoiceAPI::Models::InboxListInvoicesParams::SortBy) —

  Field to sort by

• sort_order (Symbol, EInvoiceAPI::Models::InboxListInvoicesParams::SortOrder) —

  Sort direction (asc/desc)

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

Returns:

• (EInvoiceAPI::Internal::DocumentsNumberPage<EInvoiceAPI::Models::DocumentResponse>)

See Also:

• Models::InboxListInvoicesParams

# File 'lib/e_invoice_api/resources/inbox.rb', line 94

def list_invoices(params = {})
  parsed, options = EInvoiceAPI::InboxListInvoicesParams.dump_request(params)
  query = EInvoiceAPI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "api/inbox/invoices",
    query: query,
    page: EInvoiceAPI::Internal::DocumentsNumberPage,
    model: EInvoiceAPI::DocumentResponse,
    options: options
  )
end