Estimates

Staff have access to the API calls listed below if the Estimates tab is enabled for staff. Staff users can only access estimates that belong to clients they are assigned to.

estimate.create

Create a new estimate and return the corresponding estimate_id.

Request



  
    13              
    
    
        
            0
        
    
    draft                 
    2007-06-23                
    2314            
    10                
    CAD     
    en                
    Due upon receipt.       
    Payment due in 30 days. 
    John          
    Smith           
    ABC Corp  
                    
                    
                          
                        
                    
                          
    
    
    
    
                                    
      
        Yard Work                     
        Mowed the lawn. 
        10                  
        4                     
        GST                 
        PST                 
        8             
        6             
        Item                          
  
      
    
  

Response



  103

estimate.update

Update an existing estimate.

Request



  
    103
    sent                 
    
  

Response



estimate.get

Retrieve an existing estimate.

Request



  21

Response



  
    00000000001
    0000001
    5
    
        
            0
        
    
    1
    Sample Organization
    John
    Smith
    123 Fake St.
    Apt 123
    New York
    New York
    United States
    553132
    
    
    84
    active
    
    40
    CAD
    en
    2009-07-21
    Some notes for the customer to see.
    Once accepted, payment must be made in 30 days.
    10
    https://sample.freshbooks.com/view/3R8gdDNVJ8uDpC6X
    https://sample.freshbooks.com/estimates/00000000001
    
      https://sample.freshbooks.com/view/3R8gdDNVJ8uDpC6X
      https://sample.freshbooks.com/estimates/00000000001
    
    
      
        Yard Work
        Mowed the Lawn
        10
        4
        40
        GST
        PST
        5
        8
        Item
      
    
  

estimate.delete

Delete an existing estimate.

Request



  103

Response



estimate.list

Returns a list of estimates. You can optionally filter by client_id, folder, and date.

Note: This method uses pagination

Request



  3            
  2007-01-01   
  2007-04-01       
  1                      
  10             
  active             

Response



  
    
      00000000001
      0000001
      5
        
        
            
                0
            
        
      1
      Sample Organization
      John
      Smith
      123 Fake St.
      Apt 123
      New York
      New York
      United States
      553132
      
      
      84
      
      active
      40
      CAD
      en
      2009-07-21
      Some notes for the customer to see.
      Once accepted, payment must be made in 30 days.
      10
      https://sample.freshbooks.com/view/3R8gdDNVJ8uDpC6X
      https://sample.freshbooks.com/estimates/00000000001
      
        https://sample.freshbooks.com/view/3R8gdDNVJ8uDpC6X
        https://sample.freshbooks.com/estimates/00000000001
      
      
        
          Yard Work
          Mowed the Lawn
          10
          4
          40
          GST
          PST
          5
          8
          Item
        
      
    
    
    ...
    
  

estimate.sendByEmail

Send an estimate to the associated client via e-mail.

Request



  21

Custom Emails

If you would like to send a custom email, include a message element. If a subject element is not included, the default subject line will be used.

Request



  21
  This is a custom subject!
  You have a new estimate. Get it here: ::estimate link::

estimate.getPDF

Returns the specified estimate in PDF format.

Request



    1354

Response

Raw binary data. Save with a .pdf file extension.

estimate.accept

Change an existing estimate’s status to ‘Accepted’.

Request



    86035

Response




estimate.markAsSent

Move a draft estimate into ‘Sent’ status without issuing the estimate.

Request



    38765

Response