FreshBooks icon

FreshBooks

FreshBooks Node

Actions22

Overview

This node integration with FreshBooks allows users to list projects associated with their FreshBooks account. It is particularly useful for retrieving project data filtered by client IDs and project status, enabling users to manage and analyze their projects efficiently within automated workflows.

Common scenarios include:

  • Fetching all active projects for specific clients to generate reports or dashboards.
  • Filtering out completed projects to focus on ongoing work.
  • Integrating project data into other systems for billing, time tracking, or resource allocation.

For example, a user might list all active projects for certain clients to update a project management tool or trigger notifications about project statuses.

Properties

Name Meaning
Business ID Your FreshBooks Business ID. Found in your FreshBooks account URL or via the API endpoint /auth/api/v1/users/me. Required for authentication and scoping requests.
Client IDs Comma-separated list of client IDs to filter which projects to retrieve. Only projects related to these clients will be listed. This is required for the Project List operation.
Active Projects Only Boolean flag indicating whether to return only active projects (true) or include inactive ones (false). Defaults to true.
Exclude Completed Boolean flag indicating whether to exclude completed projects (true) from the results. Defaults to false.
Return All Boolean flag to determine if all matching projects should be returned (true) or limited to a maximum number (false). Defaults to false.
Limit Maximum number of projects to return when Return All is false. Minimum value is 1, default is 50.

Output

The node outputs an array of project objects in the json field of each item. Each object represents a project retrieved from FreshBooks and includes details such as project ID, name, status, associated client, and other metadata as provided by the FreshBooks API.

No binary data output is produced by this operation.

Dependencies

  • Requires a valid FreshBooks API authentication token (OAuth2 or API key) configured in n8n credentials.
  • The user must provide their FreshBooks Business ID.
  • Network access to the FreshBooks API endpoint https://api.freshbooks.com.

Troubleshooting

  • Missing or invalid Business ID: The node requires a correct Business ID to scope API requests. Verify that the Business ID matches the one in your FreshBooks account URL or obtained via the API.
  • Invalid or missing Client IDs: The Client IDs property is mandatory for listing projects. Ensure it is provided as a comma-separated string of valid client IDs.
  • API rate limits or connectivity issues: If the node fails to fetch data, check network connectivity and FreshBooks API rate limits.
  • Empty results: If no projects are returned, verify that the client IDs exist and that filters like "Active Projects Only" and "Exclude Completed" are set correctly.
  • Limit vs Return All: When Return All is false, ensure the Limit is set appropriately; otherwise, fewer projects than expected may be returned.

Links and References

Discussion