Class: Freshbooks::API::Report

Inherits:
Client
  • Object
show all
Includes:
NoCRUDL
Defined in:
lib/freshbooks/api/report.rb

Overview

www.freshbooks.com/developers/docs/reports

Instance Attribute Summary

Attributes inherited from Client

#api_url, #token

Instance Method Summary collapse

Methods included from NoCRUDL

included

Methods inherited from Client

#call, #hash_to_raw_xml, #initialize, #options, #parse, #post, #to_request, #underscore

Methods included from CRUD

#create, #delete, #get, #list, #update

Methods included from Methods

#callbacks, #categories, #clients, #contractors, #currencies, #default_terms, #email_templates, #estimates, #expenses, #gateways, #invoices, #items, #languages, #payments, #projects, #receipts, #recurring, #reports, #staff, #systems, #tasks, #taxes, #time_entries

Constructor Details

This class inherits a constructor from Freshbooks::Client

Instance Method Details

#get_client_details(params = {}) ⇒ Object

Returns profit and account standing details for the specified client.



8
9
10
 
# File 'lib/freshbooks/api/report.rb', line 8

def get_client_details(params = {})
  call('report.getClientDetails', params)
end

#get_estimate_details(params = {}) ⇒ Object

Returns total estimated, accepted and invoiced values for invoices; broken down by currency.



13
14
15
 
# File 'lib/freshbooks/api/report.rb', line 13

def get_estimate_details(params = {})
  call('report.getEstimateDetails', params)
end

#get_expense_details(params = {}) ⇒ Object

Returns information about all, or a filtered set of expenses.



18
19
20
 
# File 'lib/freshbooks/api/report.rb', line 18

def get_expense_details(params = {})
  call('report.getExpenseDetails', params)
end

#get_invoice_details(params = {}) ⇒ Object

Returns information about all, or a filtered set of invoices.



23
24
25
 
# File 'lib/freshbooks/api/report.rb', line 23

def get_invoice_details(params = {})
  call('report.getInvoiceDetails', params)
end

#get_profit_details(params = {}) ⇒ Object

Reports profit and loss details.



28
29
30
 
# File 'lib/freshbooks/api/report.rb', line 28

def get_profit_details(params = {})
  call('report.getProfitDetails', params)
end