Estimates

• estimate.create
• estimate.update
• estimate.get
• estimate.delete
• estimate.list
• estimate.sendByEmail

estimate.create

Create a new estimate and return the corresponding estimate_id.

Request

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

  
    13              

    draft                 

    2007-06-23                
    2314            
    10                
    Due upon receipt.       
    Payment due in 30 days. 
    John          
    Smith           
    ABC Corp  
                    
                    
                          
                        
                    
                          

                                    
      
        Yard Work                     
        Mowed the lawn. 
        10                  
        4                     
        GST                 
        PST                 
        8             
        6             
      
    
  

Response

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

  103
	

estimate.update

Update an existing estimate.

Request

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

  
    103
    ...
  

Response

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

estimate.get

Retrieve an existing estimate.

Request

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

  21

Response

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

  
    00000000001
    0000001
    5
    Sample Organization
    John
    Smith
    123 Fake St.
    Apt 123
    New York
    New York
    United States
    553132
    84
    
    40
    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
      
    
  

estimate.delete

Delete an existing estimate.

Request

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

  103

Response

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

estimate.list

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

Request

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

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

Response

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

  
    
      00000000001
      0000001
      5
      Sample Organization
      John
      Smith
      123 Fake St.
      Apt 123
      New York
      New York
      United States
      553132
      84
      
      40
      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
        
      
    
    
    ...
    
  

estimate.sendByEmail

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

Request

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

  21

Custom Emails

If you would like to send a custom email, include a message and subject element. Note that both of these elements are required (one or the other will not work).

Request

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

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