Skip to main content
FreshBooks logo
  • Category: accounting
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 10
  • Triggers: 0
  • Slug: FRESHBOOKS
  • Version: 20261101_00

Tools

Slug: FRESHBOOKS_CREATE_WEBHOOKRegister a webhook callback for a FreshBooks account to receive notifications for a specified event at a callback URI. The callback requires verification.

Input Parameters

string
required
URL endpoint to receive webhook notifications. Must be a valid HTTPS URL that can receive POST requests. FreshBooks will send webhook payloads to this URI when the subscribed event occurs. The endpoint must respond with a 2xx status code (redirects and other codes are treated as failures).
string
required
Event type to subscribe to. Specifies which FreshBooks events will trigger the webhook. Common events include: client.create, client.update, client.delete, invoice.create, invoice.update, invoice.delete, payment.create, payment.update, payment.delete, expense.create, expense.update, expense.delete.
string
required
Unique identifier of the FreshBooks account to register the webhook for. Obtain this from the account_id field in the List Businesses action response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHBOOKS_DELETE_WEBHOOKDelete a webhook callback from a FreshBooks account. Use when you need to remove an existing webhook subscription that is no longer needed.

Input Parameters

string
required
The unique FreshBooks account identifier. Obtain this from the account details or business information.
string
required
The unique identifier of the webhook callback to delete. Obtain this from the list webhooks response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHBOOKS_GET_BUSINESS_USERSRetrieves staff identities and members for a specific FreshBooks business. This action returns detailed information about all staff members (owners, admins, employees) in a business group, including their roles, email addresses, and active status. Use this to discover team members before assigning time entries or tasks.

Input Parameters

integer
required
The unique identifier of the business whose staff identities you want to retrieve. Obtain this from the List Businesses action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHBOOKS_LIST_BUSINESSESList all businesses associated with the authenticated user. This action retrieves business membership information from the FreshBooks Identity endpoint, showing all businesses the user has access to along with their role in each business. The business_id from this response is required for many other FreshBooks API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHBOOKS_LIST_CLIENTSRetrieves all clients for a FreshBooks account. Clients are entities you send invoices to. Supports pagination, filtering by email/user ID/visibility state, sorting, and includes optional balance data (outstanding, credit, draft, overdue).

Input Parameters

integer
Page number for pagination. Pages are 1-indexed.
string
Sort results by field: client_id, organization_name, email, updated, fullname, or outstanding.
array
Include additional balance data in response. Options: outstanding_balance, credit_balance, draft_balance, overdue_balance.
integer
Number of results per page. Default is 15.
string
required
Unique identifier of the FreshBooks account. Obtain this from the List Businesses action (use the account_id field from the business object).
string
Filter by exact email address match.
integer
Filter by exact user ID match.
string ("active" | "deleted" | "archived")
Visibility state for clients.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHBOOKS_LIST_JOURNAL_ENTRIES2Lists a page of manual journal entries for a FreshBooks business, with pagination metadata and optional page controls.

Input Parameters

integer
Number of journal entries to return per page. Use to control response size. Defaults to 30 if not specified.
integer
The page number to retrieve. Use for pagination when there are many journal entries. Defaults to 1 if not specified.
string
required
The UUID of the business whose journal entries you want to list. Obtain this from the List Businesses action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHBOOKS_LIST_PROJECTSLists a page of projects for a FreshBooks business, with project details and pagination metadata. Supports filtering by active or completion status and update time, and sorting.

Input Parameters

boolean
Filter by active status. Set to true to return only active projects, false for inactive projects. Omit to return all projects regardless of active status.
string ("created_at" | "due_date" | "title")
Sort order for the returned projects. Choose ‘created_at’ for creation date, ‘due_date’ for project due date, or ‘title’ for alphabetical order. Omit for default API ordering.
boolean
Filter by completion status. Set to true to return only completed projects, false for incomplete projects. Omit to return all projects regardless of completion status.
boolean
Exclude group membership data. Set to true to omit the group field (which contains team member and invitation details) from each project to reduce response size.
integer
required
The unique identifier of the business whose projects you want to list. Obtain this from the List Businesses action.
string
Filter by last update time. Only returns projects updated at or after this UTC datetime. Must be in RFC3339 format (e.g., ‘2023-01-01T00:00:00Z’).
boolean
Include time tracking data. Set to true to include the total logged duration (in seconds) for each project in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHBOOKS_LIST_WEBHOOKSLists webhook callbacks for a FreshBooks account, returning callback details and pagination metadata.

Input Parameters

string
required
Unique identifier of the FreshBooks account. Obtain this from the List Businesses action (corresponds to account_id field in the business object).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHBOOKS_REGISTER_AS_A_NEW_USERRegister a new user account in FreshBooks. Returns an access token upon successful registration. Use this action when you need to create a new FreshBooks user account programmatically with their business information.

Input Parameters

string
required
Valid email address for the new user. Must use a real domain (e.g., gmail.com, outlook.com). This will be the user’s login email.
string
required
Password for the new user account. Should be strong and meet security requirements.
string
required
Last name of the user being registered.
string
required
First name of the user being registered.
string
required
Name of the business to register for the new user. This will be associated with their FreshBooks account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHBOOKS_UPDATE_WEBHOOKUpdate or verify a FreshBooks webhook callback. Use this to verify a newly created webhook by providing the verification code, or to request a new verification code be sent to the callback URI. Prerequisites: You need the account_id (from List Businesses as business_uuid) and callback_id (from webhook creation). Use Cases: - Verify a webhook after creation by providing the verifier code received at your callback URI - Request a new verification code if the original was lost or expired (set resend=true) Important: The verifier and resend parameters are mutually exclusive - provide only one per request.

Input Parameters

boolean
Set to true to resend the verification code to the callback URI. Mutually exclusive with verifier. Only use when you need a new verification code.
string
Verification code received at the callback URI. Provide this to verify a newly created webhook. Mutually exclusive with resend.
string
required
The account ID for the FreshBooks account. Obtain this from the List Businesses action as business_uuid.
string
required
The unique identifier of the webhook callback to update. Obtain this from the list or create callbacks endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not