| Active |
|---|
| This application does not need additional settings. So you can make connection only by using your login credentials or by following the instructions below . |
With FreeAgent modules in Boost.space Integrator, you can manage the contacts, tasks, invoices, and monitor users in your FreeAgent account.
To use the FreeAgent modules, you must have a FreeAgent account. You can create an account at freeagent.com.
Refer to the FreeAgent API documentation for a list of available endpoints.
To establish the connection, you must:
-
Log in to your Boost.space Integrator account, add a FreeAgent module to your scenario, and click Create a connection.
-
Optional: In the Connection name field, enter a name for the connection.
-
Optional: Click Show advanced settings and enter your custom app client credentials. For more information, refer to FreeAgent OAuth 2.0 Guide.
If requested, use the following Redirect URI when creating your custom app:
https://integrator.boost.space/oauth/cb/freeagent. -
Click Save.
-
If prompted, authenticate your account and confirm access.
You have successfully established the connection. You can now edit your scenario and add more FreeAgent modules. If your connection requires reauthorization at any point, follow the connection renewal steps here.
To create an FreeAgent custom application and retrieve your client credentials:
-
Log in to your FreeAgent Developer account.
-
Click Create New App.
-
Enter the details provided as a reference in the below table.
Name
App’s name
Description
Details of the app.
App Homepage URL
App’s website URL address.
OAuth Redirect URI
Enter the following redirect URIs:
https://integrator.boost.space/oauth/cb/freeagenthttps://www.integrator.boost.space/oauth/cb/freeagentIcon
App’s profile image.
Enable Accountancy Practice API
Optional: Select the checkbox to enable the Accountancy practice API for the app.
-
Click Create App.
-
Copy the OAuth identifier and OAuth secret to a safe place.
You will use these values in the Client ID and Client Secret fields in Boost.space Integrator.
You can watch, list, retrieve, create, update, and delete contacts using the following modules.
Watches for newly created contacts.
|
Connection |
|
|
Limit |
Set the maximum number of contacts Boost.space Integrator will return during one execution cycle. The default value is 2. |
Returns a list of contacts.
|
Connection |
|
|
Limit |
Set the maximum number of contacts Boost.space Integrator will return during one execution cycle. The default value is 10. |
For field descriptions, see the FreeAgent API reference.
Returns a specified contact.
|
Connection |
|
|
Contact ID |
Select or map the Contact ID whose details you want to retrieve. |
Updates a specified contact.
|
Connection |
|
|
Contact ID |
Select or map the Contact ID whose details you want to update. |
For field descriptions, see the FreeAgent API reference.
Deletes a specified contact.
|
Connection |
|
|
Contact ID |
Select or map the Contact ID you want to delete. |
You can watch, list, retrieve, create, update, and delete tasks using the following modules.
Watches for newly created tasks.
|
Connection |
|
|
Limit |
Set the maximum number of tasks Boost.space Integrator will return during one execution cycle. The default value is 2. |
Returns a list of tasks.
|
Connection |
|
|
Limit |
Set the maximum number of tasks Boost.space Integrator will return during one execution cycle. The default value is 10. |
For field descriptions, see the FreeAgent API reference.
Returns a specified task.
|
Connection |
|
|
Task ID |
Select or map the Task ID whose details you want to retrieve. |
Updates a specified task.
|
Connection |
|
|
Task ID |
Select or map the Task ID whose details you want to update. |
For field descriptions, see the FreeAgent API reference.
Deletes a specified task.
|
Connection |
|
|
Task ID |
Select or map the Task ID you want to delete. |
You can watch users using the following module.
Watches for newly created users.
|
Connection |
|
|
Limit |
Set the maximum number of users Boost.space Integrator will return during one execution cycle. The default value is 2. |
You can watch, retrieve, create, search, and delete invoices using the following modules.
Watches for newly created invoices
|
Connection |
|
|
Limit |
Set the maximum number of invoices Boost.space Integrator will return during one execution cycle. The default value is 2. |
Returns a specified invoice.
|
Connection |
|
|
Invoice ID |
Select or map the Invoice ID whose details you want to retrieve. |
Searches for invoices or lists them all.
|
Connection |
|
|
Limit |
Set the maximum number of invoices Boost.space Integrator will return during one execution cycle. The default value is 10. |
See FreeAgent Invoice API reference for entering the field values to search the invoices that match the specified value.
Deletes a specified invoice.
|
Connection |
|
|
Invoice ID |
Select or map the Invoice ID you want to delete. |
You can call APIs using the following module.
![[Note]](https://docs.boost.space/wp-content/themes/bsdocs/docs-parser/HTML/css/image/note.png) |
Note |
|---|---|
|
For the list of available endpoints, refer to the FreeAgent API documentation. |
Performs an arbitrary authorized API call.
|
Connection |
|
|
URL |
Enter a path relative to |
|
Method |
GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
|
Headers |
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
|
Query String |
Enter the request query string. |
|
Body |
Enter the body content for your API call. |
