Skip to Main Content
×
Freshbooks
Official App
Free – Google Play
Get it
FreshBooks is Loved by American Small Business Owners
FreshBooks is Loved by Canadian Small Business Owners
FreshBooks is Loved by Small Business Owners in the UK

Reports

Provides access to the most commonly used reports and information.

report.getClientDetails

Returns profit and account standing details for the specified client.

Request

<?xml version="1.0" encoding="utf-8"?>

   12

Response

<?xml version="1.0" encoding="utf-8"?>

  
    
      12
      
        
          1676.47
          2.50
          1673.97
          CAD
        
        
          6102.24
          110.00
          5992.24
          USD
        
      
    
  

report.getEstimateDetails

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

Request

<?xml version="1.0" encoding="utf-8"?>

   69931
   
   YYYY-MM-DD
   YYYY-MM-DD

Response

<?xml version="1.0" encoding="utf-8"?>

  
    
      CAD
      1012.00
      560.00
      468.07
    
  

report.getExpenseDetails

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

Request

<?xml version="1.0" encoding="utf-8"?>

    
   12
   YYYY-MM-DD
   YYYY-MM-DD
   date

Response (When not grouped by date)

<?xml version="1.0" encoding="utf-8"?>

  
    
      385.00
      595.08
      240.00
      33438.39
    
  

Response (When Grouped by date)

<?xml version="1.0" encoding="utf-8"?>

  
    
      260.00
      299.00
      0.00
      10565.02
      2014
      7
    
    
      100.00
      500.00
      280.00
      20540.00
      2013
      5
    
  

report.getInvoiceDetails

Returns information about all, or a filtered set of invoices. Default sorting in the response is by currency code, unless overruled with the filter.

Request

<?xml version="1.0" encoding="utf-8"?>

    
   active
   324
   YYYY-MM-DD
   YYYY-MM-DD
   date

Response

<?xml version="1.0" encoding="utf-8"?>

  
    
      102959905.17
      100046149.96
      2913755.21
      CAD
    
    
      100.00
      0.00
      100.00
      EUR
    
    
      30.00
      30.00
      0.00
      GBP
    
    
      75394.35
      1951.66
      73442.69
      USD
    
  

Response (grouped by month)

<?xml version="1.0" encoding="utf-8"?>

  
    
      89412.56
      0.00
      89412.56
      CAD
      2014
      11
    
    
      4510.00
      0.00
      4510.00
      USD
      2014
      11
    
    
      1173500.78
      0.00
      1173500.78
      CAD
      2014
      10
    
    ...
  

report.getProfitDetails

Returns profit & loss details. With this report we assume that the currency_code is the same as the system’s base currency_code. Invoice amounts in other currencies will be converted. The normal call (not filtered by date) will return the same information as the ‘Totals’ column on the Profit & Loss Report.

Request

<?xml version="1.0" encoding="utf-8"?>

    
   YYYY-MM-DD
   YYYY-MM-DD
   
   date

Response (Not using optional date filter)

<?xml version="1.0" encoding="utf-8"?>

  
    
      6972.97
      12681.89
      -5708.92
      USD
    
  

Response (using optional date filter)

<?xml version="1.0" encoding="utf-8"?>

  
    
      456.96
      597.56
      -140.60
      USD
      2014
      01
    
    
      912.41
      204.88
      707.53
      USD
      2014
      02
    
    
      102.24
      97.56
      4.68
      USD
      2014
      03
    
    ...