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

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



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

Response



  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



  
    13
    
  

Response



client.get

Return the client details associated with the given client_id.

  • The credit element is deprecated and will only represent credit in the system’s base currency. A new element, called credits has been added with child elements for each currency that the client has credit in.

Request



  13

Response



  
    13
    Jane
    Doe
    ABC Corp
    janedoe@freshbooks.com
    janedoe
    
        
            15
            alex
            
            
            johnmcnicol@freshbooks.com
            
            
        
    
    (555) 123-4567
    (555) 234-5678
    
    
    en
    USD
    123.45
    
        123.45
        43.45
        12.00
    
    
    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
      https://sample.freshbooks.com/view/3EbEwAkJGJkuJHSN
    
    
    
    active
    
    2009-08-12 09:00:00
  

client.delete

Delete the client with the given client_id.

Request



  13

Response



client.list

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

Note: This method uses pagination.

Request



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

Response



  
    
      13
      Jane
      Doe
      ABC Corp
      janedoe@freshbooks.com
      janedoe
    
        
            15
            alex
            
               
               johnmcnicol@freshbooks.com
               
               
        
    
      (555) 123-4567
      (555) 234-5678
      
      
      en
      USD
      123.45
      
          123.45
          43.45
          12.00
      
      Prefers email over phone calls
      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
        https://sample.freshbooks.com/view/3EbEwAkJGJkuJHSN
      
      
      
      2009-08-12 09:00:00
      active
    
    ...