class Belvo::TaxStatus

A Tax status is the representation of the tax situation of a person or a business to the tax authority in the country.

Public Class Methods

new(session) click to toggle source
Calls superclass method Belvo::Resource::new
# File lib/belvo/resources.rb, line 431
def initialize(session)
  super(session)
  @endpoint = 'tax-status/'
end

Public Instance Methods

resume(_session_id, _token, _link: nil) click to toggle source
# File lib/belvo/resources.rb, line 453
def resume(_session_id, _token, _link: nil)
  raise NotImplementedError 'TaxReturn does not support resuming a session.'
end
retrieve(link:, options: nil) click to toggle source

Retrieve tax status information from a specific fiscal link. @param link [String] Link UUID @param options [TaxStatusOptions] Configurable properties @return [Hash] created tax status details @raise [RequestError] If response code is different than 2XX

# File lib/belvo/resources.rb, line 441
def retrieve(link:, options: nil)
  options = TaxStatusOptions.from(options)
  body = {
    link: link,
    token: options.token,
    save_data: options.save_data || true,
    attach_pdf: options.attach_pdf
  }.merge(options)
  body = clean body: body
  @session.post(@endpoint, body)
end