FreshBooks
TARGET_SYSTEM: freshbooks
FreshBooks is accounting softwarefor small and medium-sized businesses.
| Read | Create | Update | ||
|---|---|---|---|---|
| Accounts | ⌛ | ⌛ | ⌛ | |
| Async task | ❌ | ❌ | ❌ | |
| Bills | ⌛ | ⌛ | ⌛ | |
| Booking proposals | ⌛ | ⌛ | ⌛ | |
| Contacts | ❌ | ❌ | ❌ | |
| Customers | ✅ | ✅ | ✅ | |
| Credit notes | ⌛ | ⌛ | ⌛ | |
| Dimensions | ⌛ | ⌛ | ⌛ | |
| Expenses | ⌛ | ⌛ | ⌛ | |
| Files | ⌛ | ⌛ | ⌛ | |
| Invoices | ⌛ | ⌛ | ⌛ | |
| Invoice lines | ⌛ | ⌛ | ⌛ | |
| Items | ⌛ | ⌛ | ⌛ | |
| Journal entries | ⌛ | ⌛ | ⌛ | |
| Offers | ⌛ | ⌛ | ⌛ | |
| Offer lines | ⌛ | ⌛ | ⌛ | |
| Payments | ⌛ | ⌛ | ⌛ | |
| Payment Terms | ⌛ | ⌛ | ⌛ | |
| Projects | ⌛ | ⌛ | ⌛ | |
| Sales Orders | ❌ | ❌ | ❌ | |
| Sales Orders Lines | ❌ | ❌ | ❌ | |
| Suppliers | ✅ | ✅ | ✅ | |
| Tax Rates | ⌛ | ⌛ | ⌛ | |
| Tracking categories | ⌛ | ⌛ | ⌛ | |
| Transactions | ⌛ | ⌛ | ⌛ | |
| Vendor credits | ⌛ | ⌛ | ⌛ |
✅ = Endpoint available
⌛ = Endpoint in progress
❌ = Endpoint not supported by FreshBooks
How to connect to FreshBooks
To allow your customers to link your application with their FreshBooks accounts, you need to set up a FreshBooks App and submit your application credentials to maesn.
Prerequisites
Before you begin, ensure you have the following:
- An active FreshBooks account.
If you do not already have a FreshBooks account, you can sign up for a free trial at FreshBooks Sign-Up. Note that this FreshBooks account will only be used to manage your FreshBooks App and, optionally, to become a FreshBooks partner in the future.
Create the FreshBooks App
This step will guide you through creating the App that users can install in their FreshBooks account to authorize integration with your application.
- Visit the FreshBooks Developer Portal and log in, if you are not already logged in.
- Click “Create New App”.
- Enter the following details:
- Name: The name of your application. This is what users will see when they are asked to authorize integration with their FreshBooks account.
- Application Type: Select Public App.
- Website URL: Enter the homepage URL of your company, e.g.,
https://yourcompany.com. - Redirect URI: Set this to
https://api.maesn.dev/auth/callback/freshbooks.
Set the Scopes for Your Application
To enable data access for your users, you must add the following scopes to your application:
user:profile:readuser:clients:readuser:clients:writeuser:bill_vendors:readuser:bill_vendors:write
Click Save to create your application.
Retrieve Your Client Secret
Once the setup is complete, click on your application to access your OAuth credentials. You will find both your OAuth Client Identifier and your OAuth Client Secret, which are required to connect to the FreshBooks API.
Configure your integration in the maesn API
In the last step, we setup your API tenant with your App’s details:
- Get in touch with your contact person at maesn to submit the client id and client secret.
If you are not sure who your technical contact is, do not hesitate to reach out to us.