Access Token

Refresh Token

Freshbooks

Bills

Chart Of Accounts

unique identifier of business client exists on

3-letter shortcode for preferred currency

shortcode indicating user language e.g. "en"

active

deleted

archived

Clients

Credit Notes

Draft

Sent

Viewed

Replied

Accepted

Invoiced

Estimates

Expense Categories

internal

outstanding

invoiced

recouped

Expenses

id of creator of invoice. 1 if business admin, other if created by e.g. a contractor

id of object this invoice was generated from, 0 if none

userid of user who sent the invoice, typically 1 for admin

Disputed

Paid

Auto Paid

Retry

Failed

Partial

Invoices

Journal Entries

Journal Entry Accounts

Other Incomes

Payments

Projects

External Tax ID

Taxes

Team Members

List User

Register as a new user

Revoke Refresh Token

List Credits 

Create Prepayment Credit

Update Credit Note

Delete Credit

List Clients

Get a single client with the parameter associated with clientId

Single Client

Update Client

Note: If you do not add an `organization` to your Client object, `organization` will automatically be added as the client's first and last name.

New Client

Deletes the specified secondary contactid

Delete Secondary  Contact ID

Allows you to edit a specific secondary contact

Edit Secondary Contact ID

Will remove all secondary contacts for a single Client Profile

Remove All Secondary Contacts

Single Item

Delete Item

Create Item

List Items Filtered by SKU

List Invoice Profiles

Creates a monthly recurring invoice that sends 3 invoices in total.

Create Single Invoice Profile

Get Single Invoice Profile

Update invoice profile to two weeks and increase the number of remaining invoices to 10.



Update Invoice Profile

This will create an invoice profile that will pull unbilled time entries for your client on to the invoice that is generated

Create Single Invoice Profile w/ Time Entry Holder 

Enable Payment Options On Invoice Profile

Share PDF

Download Invoice PDF

Upload Logo or Proposal Image

Single Retainer

A retainer is deleted by changing the active status to "false". It can be undeleted by changing active status back to true.

Undelete Retainer

Create Retainer

Get all retainers

List all available other income instances.

List Other Income

This allows you to create a single entry for other income you collected (or will collect) through other means outside of FreshBooks.

Create Single Other Income

Delete Single Other Income

Single Payment

Update Payment

List Payments

Make Payment

Single Checkout Link

Update Checkout Link Payment Gateway

Update Checkout Link

Delete Checkout Link

List Invoices

Creating invoice with expense.

First you will need to create an expense. Once that is created, save the expenseId and add it to the invoice.

When adding an expense, make sure you add to the `markup_percent` parameter the amount you want to markup by and set `cogs` to `true` if it is an item you have paid for.

Create Invoice with Expense 

Single Invoice w/ Logo

Toggle Online Payments on Invoice

Call an invoice and display the enabled gateway on that invoice.

Stripe = id: 26 |
FBpay = id: 30 |
PayPal = id: 7

Single Invoice w/ Payment Gateway

Enable Payment Options On Invoice

Send Invoice by Email

Get default invoice presentation styles

Get Bills

Add Bill from Vendor

Add Payment to Bill

Edit Payment to Bill

Archive Bill

Get Vendors

Add Vendor

Delete Vendor

List Expenses

In order to create an expense with a receipt, you will first need to upload your image via the uploader endpoint. Once you receive a response, you can apply that `jwt` token to your expense under the nested `attachment` object. Look at the example on the right.

Create Expense with Receipt

Single Expense

Delete Expense

Create Recurring Expense

This endpoint will return summaries of the total amounts of expenses by active, archived, and grand total.

Active means not archived or deleted.

Archived is simply reorganizing the experience on FreshBooks so they're tucked away nicely. They will still show up on your reports and count towards active clients.

Deleted clients will be removed from your active clients list, however, any activity related to those accounts will not show up on your reports.


Expense Summaries

Expense Vendors

Single Expense Category

List Expense Categories

Custome expense categories require a parent category ID. Please make a call to list expense categories to find the parent ID you'd like.

Create Custom Expense Category

List Taxes

Create Single Tax

Single Tax

Update Tax

Get an entire list of estimates that exist within your account.

List Estimates

Creates a single estimate with multiple estimate lines and a logo and colourway.

Single Estimate With Estimate Lines

Single Estimate

Accept Estimate

Send Estimate by Email

Create a single proposal that has sections, logos, and requires an e-signature from the customer

Create Single Proposal w/ Sections, Logos, and E-signature

Time entries that have been updated since a precise time. 

Time Entries Updated Since Precise Time

Create a Time Entry

Currently you have to search for employee using their employee name and not an ID.

Time Entries For Employee on Specific Project

Update a Time Entry

Delete a Time Entry

List Tasks

Create Task

Single Task 

Delete Task

Single Project

Remember to remove `Content-Type` headers when making a GET call on projects and time-tracking.

List Projects

Create Single Project

Update project with project title.

*`client_id` in this case is `customerId`*

Update Project

Delete Project

Get all service rates associated with this project	

Service Rates

You will need to update each project service independently with this endpoint

Update Service Rates

Team Member Rates

Update Staff Rates

Invite Team Member to Project(s)

Invitation Rates

Create New Message in Project Discussion

Quickbooks

Xero

NetSuite

Sage Accounting

Zoho Books

Exact Online

# Create Invoice

This scenario allows your application to create a Invoice in any external application in the same way. 
You will pass Invoice fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.


## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to create Invoice with and configure mapping to our default model

2. **Create Invoice API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Invoice data into a format compatible with the selected external application.
   - It then makes an API call to create the Invoice in that specific application.


Create Invoice

Creates Invoice in any external application

Shopify

Stripe

Woocommerce

# Delete Customer

This scenario allows your application to delete a Customer from any external application. 
You will pass ID of the Customer you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Customer API call**:
   - Call Integration.app REST API or SDK with ID of the Customer you want to delete and Integration.app will send the correct request to the external app.


Delete Customer

Deletes Customer in any external application

# Realtime Full two-way Sync of Tax Rates

This scenario enables your application to fully sync Tax Rates between your app and any external application in both directions. It handles the initial import/export of Tax Rates and then sends events when a Tax Rate is created, updated, or deleted on any side, as close to real-time as possible.

Tax Rate fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Tax Rates in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Tax Rates to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Tax Rates

Bi-directional realtime sync of Tax Rates with records deduplication

# Continuous Import of Journal Entries to Your App

This scenario enables your application to continuously sync Journal Entries from any external application to your app's API. It handles the initial import of Journal Entries and keeps them synchronized when a Journal Entry is created, updated, or deleted in the external application.

When receiving Journal Entries data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Journal Entries to my App

Import Journal Entries and receive created/updated or deleted events

Jira

Asana

Clickup

Teamleader

Insightly

Trello Connector

Basecamp

# Update Project

This scenario allows your application to update a Project in any external application in the same way. 
You will pass  ID of the Project you want to update and Project fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.

## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to update Project with and configure mapping to our default model

2. **Create Project API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured and ID. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Project data into a format compatible with the selected external application.
   - It then makes an API call to update the Project in that specific application.


Updates Project in any external application

# Continuous Import of Credit Notes to Your App

This scenario enables your application to continuously sync Credit Notes from any external application to your app's API. It handles the initial import of Credit Notes and keeps them synchronized when a Credit Note is created, updated, or deleted in the external application.

When receiving Credit Notes data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Credit Notes to my App

Import Credit Notes and receive created/updated or deleted events

Freshbooks API Integration Profile

Data Collections

Operations

Integration Scenarios