FreshBooks

Search


API Calls

Resources

Clients

Staff have access to the API calls listed below if the Clients tab is enabled for staff. Each staff member can create clients, and view and edit clients that they are assigned to.

client.create

Create a new client and return the corresponding client_id. If a password is not supplied, one will be created at random.

Request

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

  
    Jane
    Doe
    ABC Corp
    janedoe@freshbooks.com
    janedoe            
    seCret!7           
    (555) 123-4567 
    (555) 234-5678 
                           
                                 
                             
    123 Fake St.     
    Unit 555
    New York
    New York
    United States
    553132

                     
    
    
    
    
    
  
	

Response

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

  13
	

client.update

Update the details of the client with the given client_id. Any fields not referenced in the request will remain unchanged.

Request

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

  
    13

    
  
	

Response

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

client.get

Return the client details associated with the given client_id.

Request

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

  13
	

Response

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

  
    13

    Jane
    Doe
    ABC Corp
    janedoe@freshbooks.com
    janedoe
    (555) 123-4567
    (555) 234-5678
    
    
    123.45
                             

    123 Fake St.
    Unit 555
    New York
    New York
    United States
    553132

    
    
    
    
    
    
    https://sample.freshbooks.com/view/Vbbfs324trTkxer<
    https://sample.freshbooks.com/clients/13
    
      https://sample.freshbooks.com/view/Vbbfs324trTkxer
      https://sample.freshbooks.com/clients/13
    
    2009-08-12 09:00:00 
  
	

client.delete

Delete the client with the given client_id.

Request

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

  13

Response

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

client.list

Returns a list of client summaries in order of descending client_id.

Request

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

  janedoe@freshbooks.com 
  janedoe          
  2009-01-01 00:00:00 
  2009-12-01 00:00:00 
  1                        
  15               
	

Response

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

  
    
      13
      Jane
      Doe
      ABC Corp
      janedoe@freshbooks.com
      janedoe
      (555) 123-4567
      (555) 234-5678
      
      
      123.45
                               

      123 Fake St.
      Unit 555
      New York
      New York
      United States
      553132

      
      
      
      
      
      
      https://sample.freshbooks.com/view/Vbbfs324trTkxer
      https://sample.freshbooks.com/clients/13
      
        https://sample.freshbooks.com/view/Vbbfs324trTkxer
        https://sample.freshbooks.com/clients/13
      
      2009-08-12 09:00:00
    
    ...