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 .
Redirect url
https://integrator.boost.space/oauth/cb/freeagent

FreeAgent

With FreeAgent modules in Boost.space Integrator, you can:

  • watch, list, retrieve, create, update, and delete contacts

  • watch, list, retrieve, create, update, and delete tasks

  • watch users

  • watch, retrieve, create, search, and delete invoices

To get started with FreeAgent, create an account at freeagent.com

Connect FreeAgent to Boost.space Integrator

To connect FreeAgent app, you need to obtain the user credentials.

  1. Log in to your FreeAgent account.

  2. In your Boost.space Integrator account, insert a FreeAgent module in your scenario and click the Add button next to the Connection field.

    FreeAgent_1.gif
  3. In the Connection name field, enter a name for the connection.

  4. Optional: Click Show advanced settings to enter client credentials. See Create your own app and client credentials

  5. Click Save.

  6. In the prompt window, enter your FreeAgent account login credentials, and click Approve app.

    FreeAgent_7.png
  7. Confirm the access by clicking Approve.

    FreeAgent_3.png

You have successfully connected the FreeAgent app and can now build scenarios.

Create your own app and client credentials

To create your own app:

  1. Log in to your FreeAgent Developer account.

  2. Click Create New App.

    freeagent-8.png
  3. Enter the details provided as a reference in the below table.

    freeagent-9.png

    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/freeagent

    https://www.integrator.boost.space/oauth/cb/freeagent

    Icon

    App’s profile image.

    Enable Accountancy Practice API

    Optional: Select the checkbox to enable the Accountancy practice API for the app.

  4. Click Create App.

  5. Copy theOAuth identifier and OAuth secret to a safe place.

    freeagent-10.png

You have successfully created the client credentials.

Contacts

You can watch, list, retrieve, create, update, and delete contacts using the following modules.

Watch Contacts

Watches for newly created contacts.

Connection

Establish a connection to your FreeAgent account.

Limit

Set the maximum number of contacts Boost.space Integrator will return during one execution cycle. The default value is 2.

List Contacts

Returns a list of contacts.

Connection

Establish a connection to your FreeAgent account.

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.

Get a Contact

Returns a specified contact.

Connection

Establish a connection to your FreeAgent account.

Contact ID

Select or map the Contact ID whose details you want to retrieve.

Create a Contact

Creates a new contact.

For field descriptions, see the FreeAgent API reference.

Update a Contact

Updates a specified contact.

Connection

Establish a connection to your FreeAgent account.

Contact ID

Select or map the Contact ID whose details you want to update.

For field descriptions, see the FreeAgent API reference.

Delete a Contact

Deletes a specified contact.

Connection

Establish a connection to your FreeAgent account.

Contact ID

Select or map the Contact ID you want to delete.

Tasks

You can watch, list, retrieve, create, update, and delete tasks using the following modules.

Watch Tasks

Watches for newly created tasks.

Connection

Establish a connection to your FreeAgent account.

Limit

Set the maximum number of tasks Boost.space Integrator will return during one execution cycle. The default value is 2.

List Tasks

Returns a list of tasks.

Connection

Establish a connection to your FreeAgent account.

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.

Get a Task

Returns a specified task.

Connection

Establish a connection to your FreeAgent account.

Task ID

Select or map the Task ID whose details you want to retrieve.

Create a Task

Creates a new task.

For field descriptions, see the FreeAgent API reference.

Update a Task

Updates a specified task.

Connection

Establish a connection to your FreeAgent account.

Task ID

Select or map the Task ID whose details you want to update.

For field descriptions, see the FreeAgent API reference.

Delete a Task

Deletes a specified task.

Connection

Establish a connection to your FreeAgent account.

Task ID

Select or map the Task ID you want to delete.

Users

You can watch users using the following module.

Watch Users

Watches for newly created users.

Connection

Establish a connection to your FreeAgent account.

Limit

Set the maximum number of users Boost.space Integrator will return during one execution cycle. The default value is 2.

Invoices

You can watch, retrieve, create, search, and delete invoices using the following modules.

Watch Invoices

Watches for newly created invoices

Connection

Establish a connection to your FreeAgent account.

Limit

Set the maximum number of invoices Boost.space Integrator will return during one execution cycle. The default value is 2.

Create an Invoice

Creates a new invoice.

For field descriptions, see the FreeAgent API reference.

Get an Invoice

Returns a specified invoice.

Connection

Establish a connection to your FreeAgent account.

Invoice ID

Select or map the Invoice ID whose details you want to retrieve.

Search Invoices

Searches for invoices or lists them all.

Connection

Establish a connection to your FreeAgent account.

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.

Delete an Invoice

Deletes a specified invoice.

Connection

Establish a connection to your FreeAgent account.

Invoice ID

Select or map the Invoice ID you want to delete.

Other

You can call APIs using the following module.

[Note] Note

For the list of available endpoints, refer to the FreeAgent API documentation.

Make an API Call

Performs an arbitrary authorized API call.

Connection

Establish a connection to your FreeAgent account.

URL

Enter a path relative to https://api.freeagent.com. For example, /v2/users/me

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.

Example of use – List Contacts

The following API call returns all the contacts from your FreeAgent account.

URL/v2/contacts

MethodGET

FreeAgent_4.png

Matches of the search can be found in the module’s Output under Bundle > Body > contacts

In our example 5 contacts were returned:

FreeAgent_5.png