FreshBooks

Search


API Calls

Resources

Items

Staff have access to the API calls listed below if the Invoices tab is enabled for staff.

item.create

Create a new item and return the corresponding item_id.

  • At the moment you cannot specify pre-defined taxes for items through the API.

Request

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

  
    Fuzzy Slippers
    Extra soft   
    59.99            
    1                  
    10               
  

Response

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

  18
	

item.update

Update an existing item. All fields aside from the item_id are optional; by omitting a field, the existing value will remain unchanged.

Request

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

  
    18
    Cheap Slippers             
    Super tight! 
    34.99            
    1                  
                     
  

Response

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

item.get

Get an existing item with the given item_id.

Request

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

  18

Response

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

  
    18
    Cheap Slippers
    Super tight!
    34.99
    1
    
  
	

item.delete

Delete an existing item.

Request

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

  1

Response

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

item.list

Returns a list of items, ordered by descending item_id.

Request

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

  1     # The page number to show (Optional)
  5 # The number of results per page, default 25 (Optional)

Response

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

  
    
      18
      Cheap Slippers
      Super tight!
      34.99
      10
      
    
    
      17
      Yard Work
      Gardening, trimming, etc.
      17.50
      4
      
    
    ...