FreshBooks API Directory

FreshBooks is a leading cloud-based accounting software tailored specifically for small businesses and freelancers. It offers an intuitive platform that simplifies financial management through its web and mobile applications. With FreshBooks, users can efficiently handle invoicing, expense tracking, time tracking, online payments, financial reporting, and project management. This makes it an ideal solution for small business owners, freelancers, and self-employed professionals, especially those in service-oriented industries such as consulting, design, and agency work. By streamlining accounting tasks, FreshBooks enables users to dedicate more time to their core business activities, enhancing productivity and growth.

One of the standout features of FreshBooks is its robust API integration capabilities. The FreshBooks API allows developers to seamlessly connect the software with other applications, facilitating data synchronization and automation of workflows. This integration potential is particularly beneficial for businesses looking to customize their accounting processes and improve operational efficiency. As you explore the FreshBooks API, you'll discover how it can be leveraged to create a more cohesive and efficient business ecosystem.

Key highlights of FreshBooks APIs

• Authentication: Utilizes OAuth 2.0 for secure authentication, ensuring only authorized applications can access user data.
• Data Formats: Communicates using JSON, compatible with a wide range of programming languages and platforms.
• Extensive Documentation: Provides comprehensive guides and references for developers.
• SDKs and Libraries: Offers official SDKs for Python and Node.js, with community-supported libraries for Java and PHP.

‍

FreshBooks API Endpoints

Accounting

• GET https://api.freshbooks.com/accounting/account/<accountId>/bill_payments/bill_payments : List Bill Payments
• PUT https://api.freshbooks.com/accounting/account/<accountId>/bill_payments/bill_payments/<billPaymentId> : Edit Payment to Bill
• GET https://api.freshbooks.com/accounting/account/<accountId>/bill_vendors/bill_vendors : Get Vendors
• PUT https://api.freshbooks.com/accounting/account/<accountId>/bill_vendors/bill_vendors/<vendorId> : Delete Vendor
• POST https://api.freshbooks.com/accounting/account/<accountId>/bills/bills : Create a Bill
• GET https://api.freshbooks.com/accounting/account/<accountId>/bills/bills/ : Get Bills
• PUT https://api.freshbooks.com/accounting/account/<accountId>/bills/bills/<billId> : Delete Bill
• POST https://api.freshbooks.com/accounting/account/<accountId>/expenses/expenses?include%5B%5D=attachment : Create Expense With Attachment
• POST https://api.freshbooks.com/accounting/account/<accountId>/invoices/invoices : Create Invoice with Attachment
• GET https://api.freshbooks.com/accounting/account/<accountId>/invoices/invoices/<invoiceId> : Get Single Invoice
• GET https://api.freshbooks.com/accounting/account/<accountId>/users/clients : List Clients
• PUT https://api.freshbooks.com/accounting/account/<accountId>/users/clients/ : Update Existing Client Profile with Secondary Contacts
• GET https://api.freshbooks.com/accounting/account/<accountId>/users/clients/<customerId> : Get Single Client
• GET https://api.freshbooks.com/accounting/account/<accountId>/users/clients/?include%5B%5D=recent_contacts : Get Client Profile and Associated Secondary Contacts
• POST https://api.freshbooks.com/accounting/account/<account_id>/journal_entries/journal_entries : Add Journal Entry
• GET https://api.freshbooks.com/accounting/account/<account_id>/journal_entries/journal_entry_details : Get Journal Entry Details
• GET https://api.freshbooks.com/accounting/account/<account_id>/journal_entry_accounts/journal_entry_accounts : Get Accounts
• GET https://api.freshbooks.com/accounting/account/<account_id>/projects/tasks : Listing Tasks
• PUT https://api.freshbooks.com/accounting/account/<account_id>/projects/tasks/<task_id> : Delete a Task
• GET https://api.freshbooks.com/accounting/account/<accountid> : Example Searches for Accounting Endpoint
• POST https://api.freshbooks.com/accounting/account/<accountid>/credit_notes/credit_notes : Create Credit Note
• PUT https://api.freshbooks.com/accounting/account/<accountid>/credit_notes/credit_notes/<creditid> : Delete Credit
• POST https://api.freshbooks.com/accounting/account/<accountid>/estimates/estimates : Create Single Estimate
• GET https://api.freshbooks.com/accounting/account/<accountid>/estimates/estimates/<estimateid> : Get Single Estimate
• PUT https://api.freshbooks.com/accounting/account/<accountid>/estimates/estimates/<id> : Delete Single Estimate
• GET https://api.freshbooks.com/accounting/account/<accountid>/expenses/categories : List Expense Categories
• GET https://api.freshbooks.com/accounting/account/<accountid>/expenses/categories/<id> : Get Single Expense Category
• GET https://api.freshbooks.com/accounting/account/<accountid>/expenses/expenses : List Expenses
• GET https://api.freshbooks.com/accounting/account/<accountid>/expenses/expenses/<expenseid> : Get Single Expense
• GET https://api.freshbooks.com/accounting/account/<accountid>/invoice_profiles/invoice_profiles : Listing Invoice Profiles
• PUT https://api.freshbooks.com/accounting/account/<accountid>/invoice_profiles/invoice_profiles/<profileid> : Delete an Invoice Profile
• GET https://api.freshbooks.com/accounting/account/<accountid>/invoice_profiles/invoice_profiles?include%5B%5D=next_issue_date : Including the next issue date
• GET https://api.freshbooks.com/accounting/account/<accountid>/invoice_profiles/invoice_profiles?search%5Bclientid%5D=23482 : Search example with clientid
• GET https://api.freshbooks.com/accounting/account/<accountid>/invoice_profiles/invoice_profiles?search%5Bcurrency_code%5D=USD : Search example with currency code
• GET https://api.freshbooks.com/accounting/account/<accountid>/invoices/invoices : Example Sort (accounting endpoint)
• GET https://api.freshbooks.com/accounting/account/<accountid>/items/items : List Items
• PUT https://api.freshbooks.com/accounting/account/<accountid>/items/items/<id> : Update Single Item
• GET https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/ : List Other Income Entries
• DELETE https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/<id> : Delete Other Income Entry
• GET https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/<incomeid> : Get Single Other Income
• GET https://api.freshbooks.com/accounting/account/<accountid>/payments/payments : List Payments
• PUT https://api.freshbooks.com/accounting/account/<accountid>/payments/payments/<id> : Update Single Payment
• GET https://api.freshbooks.com/accounting/account/<accountid>/systems/gateways : List Gateways
• DELETE https://api.freshbooks.com/accounting/account/<accountid>/systems/gateways/<id> : Delete Single Gateway
• GET https://api.freshbooks.com/accounting/account/<accountid>/systems/systems/<id> : Get System
• GET https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes : List Taxes
• PUT https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes/<id> : Update Single Tax
• PUT https://api.freshbooks.com/accounting/account/<accountid>/users/clients/<clientid> : Remove all Secondary Contacts
• GET https://api.freshbooks.com/accounting/account/<accountid>/users/staffs : List Staff
• GET https://api.freshbooks.com/accounting/account/<accountid>/users/staffs/<id> : Get Single Staff
• GET https://api.freshbooks.com/account/{account_id}/projects/tasks : Search Examples for Tasks
• POST https://api.freshbooks.com/accounting/businesses/{business_uuid}/ledger_accounts/accounts : Create Account
• GET https://api.freshbooks.com/accounting/businesses/{bussiness_uuid}/ledger_accounts/accounts : Get Single Account
• GET https://api.freshbooks.com/accounting/businesses/{bussiness_uuid}/ledger_accounts/accounts/{accountId} : Get Account

Authentication

• GET https://api.freshbooks.com/auth/api/v1/businesses/<business_id>/team_members : List Team Members
• GET https://api.freshbooks.com/auth/api/v1/businesses/<business_id>/team_members/<team_member_uuid> : Get Single Team Member
• GET https://api.freshbooks.com/auth/api/v1/users/me : Get Companies Information
• POST https://api.freshbooks.com/auth/oauth/revoke : Revoking a Bearer/Refresh Token
• POST https://api.freshbooks.com/auth/oauth/token : Get Bearer token via refresh code

Comments

• POST https://api.freshbooks.com/comments/business/<businessid>/service : Create a Service
• PUT https://api.freshbooks.com/comments/business/<businessid>/service/<service_id>/rate : Update a Service Rate
• GET https://api.freshbooks.com/comments/business/<businessid>/service/<serviceid> : Get Single Service
• GET https://api.freshbooks.com/comments/business/<businessid>/service/<serviceid>/rate : Get Single Service Rate
• GET https://api.freshbooks.com/comments/business/<businessid>/services : List Services

Events

• GET https://api.freshbooks.com/events/account/<account_id>/events/callbacks : List all webhook callbacks
• PUT https://api.freshbooks.com/events/account/<account_id>/events/callbacks/<callback_id> : Resend verification code

Payments

• POST https://api.freshbooks.com/payments/account/<account_id>/invoice/<invoice_id>/payment_options : Add payment gateway to the invoice
• GET https://api.freshbooks.com/payments/account/<account_id>/payment_options : Check Online Payment Gateways Available
• GET https://api.freshbooks.com/payments/account/<accountid>/invoice/<invoiceid>/payment_options : See Payment Options on an Invoice
• GET https://api.freshbooks.com/payments/account/<accountid>/payment_options?entity_type=invoice : Get the Default Invoice Payment Options

Projects

• POST https://api.freshbooks.com/projects/business/<business_id>/project : Create a Single Project
• DELETE https://api.freshbooks.com/projects/business/<business_id>/project/<project_id> : Delete a Single Project
• GET https://api.freshbooks.com/projects/business/<business_id>/projects : List Projects
• GET https://api.freshbooks.com/projects/business/<businessid>/projects : Example Sort (project endpoint)

Test

• GET https://api.freshbooks.com/test : Test Call

Time Tracking

• GET https://api.freshbooks.com/timetracking/business/<business_id>/time_entries : List Time Entries Update From A Particular Time
• PUT https://api.freshbooks.com/timetracking/business/<business_id>/time_entries/<time_entry_id> : Update a Time Entry
• GET https://api.freshbooks.com/timetracking/business/<business_id>/time_entries/{time_entrie_id} : Get A Single Time Entry
• GET https://api.freshbooks.com/timetracking/business/<businessid> : Example Searches for Timetracking Endpoint

Uploads

• POST https://api.freshbooks.com/uploads/account/<accountId>/attachments : Upload Attachment
• POST https://api.freshbooks.com/uploads/account/<account_id>/attachments : Upload Invoice Attachment
• POST https://api.freshbooks.com/uploads/account/<account_id>/images : Upload Logo / Banner

‍

Freshbooks API FAQs

How do I authenticate with the FreshBooks API?

• Answer: The FreshBooks API uses OAuth 2.0 for authentication. To authenticate:some text
  1. Create an OAuth application in your FreshBooks account to obtain a Client ID and Client Secret.
  2. Direct users to authorize your application, which provides an authorization code.
  3. Exchange the authorization code for an access token.
  4. Use the access token in the Authorization header of your API requests.
• Source: FreshBooks API Introduction

What are the rate limits for the FreshBooks API?

• Answer: FreshBooks enforces rate limits to ensure fair usage and maintain system performance. While specific rate limits are not publicly detailed, it's recommended to implement error handling for potential rate limiting responses and to contact FreshBooks support for detailed rate limit information.
• Source: FreshBooks API Introduction

Can I retrieve client information using the FreshBooks API?

• Answer: Yes, the FreshBooks API provides endpoints to manage clients. For example, you can use the /accounting/account/<accountId>/users/clients endpoint to list all clients associated with your account.
• Source: Client API | FreshBooks

Does the FreshBooks API support webhooks for real-time data updates?

• Answer: Yes, FreshBooks supports webhooks, allowing you to receive real-time notifications for specific events, such as when an invoice is created or updated. You can configure webhook subscriptions to specify which events you want to receive notifications for.
• Source: Webhook Callbacks - FreshBooks API

Are there official SDKs or client libraries for the FreshBooks API?

• Answer: Yes, FreshBooks provides official SDKs to facilitate integration:some text
  • Node.js SDK: An officially maintained wrapper for Node.js developers.
• Source: Getting Started with FreshBooks NodeJS SDK

Get Started with Frehbooks API Integration

Create a FreshBooks Account: Sign up for a FreshBooks account if you don’t already have one.

Register Your Application: Access the FreshBooks Developer Hub to create a new application and get your Client ID and Client Secret.

Authenticate Using OAuth 2.0: Implement the OAuth 2.0 flow to obtain an access token, enabling API interactions on behalf of users.

Utilize SDKs and Libraries: Leverage the available SDKs for easier integration.

Explore API Endpoints: Familiarize yourself with the API endpoints to create clients, send invoices, and track expenses.

‍

Additional Resources:

• Postman Collection: FreshBooks Postman Workspace for testing and understanding API endpoints.
• API Libraries and SDKs: Official and community-supported libraries are available on the FreshBooks API Libraries page.
• Developer Community: Join the FreshBooks Developer Community for support and updates.

About Knit

Knit API offers a convenient solution for quick and seamless integration with Freshbooks API. Our AI-powered integration platform allows you to build any Freshbooks API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Freshbooks API.‍

To sign up for free, click here. To check the pricing, see our pricing page.