Class: Harvest::API::Invoices

Inherits:
Base
  • Object
show all
Includes:
Behavior::Crud
Defined in:
lib/forecast/api/invoices.rb

Instance Method Summary collapse

Instance Method Details

#all ⇒ Array<Harvest::Invoice> #all(options) ⇒ Array<Harvest::Invoice>

Retrieves invoices

Available options

  • :status - invoices by status

  • :page

  • :updated_since

  • :timeframe (must be a nested hash with :to and :from)

Overloads:

  • #all(options) ⇒ Array<Harvest::Invoice>

    Parameters:

    • filtering (Hash) —

      options

Returns:

  • (Array<Harvest::Invoice>) —

    an array of invoices



20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/forecast/api/invoices.rb', line 20

def all(options = {})
  query = {}
  query[:status]        = options[:status]        if options[:status]
  query[:page]          = options[:page]          if options[:page]
  query[:updated_since] = options[:updated_since] if options[:updated_since]
  if options[:timeframe]
    query[:from] = options[:timeframe][:from]
    query[:to]   = options[:timeframe][:to]
  end

  response = request(:get, credentials, "/invoices", :query => query)
  api_model.parse(response.parsed_response)
end