FreshBooks (Preview)

FreshBooks (Preview)

FreshBooks is a cloud based small business accounting software. Send invoices, track time, manage receipts and expenses.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Premium All Flow regions
PowerApps Premium All PowerApps regions

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds
Frequency of trigger polls 1 60 seconds

Actions

Add new client

This operation creates a new client in your account. At least one field of the client (i.e. first name, last name, organization, email, etc) must be specified otherwise the operation will fail.

Required Parameters

Account
string
Id of expense account.

Optional Parameters

First Name
string
Last Name
string
Organization
string
Email Address
string
Phone Number
string
Currency
string
3-letter currency code.
Street Address 1
string
Street Address 2
string
City
string
Postal Code
string
Country
string
Province
string

Returns

Body
Client

Create new expense

This operation creates a new expense in your account.

Required Parameters

Account
string
Id of expense account.
Amount
string
Category
integer
Pick an expense category.
Staff
integer
Pick the staff member to expense.
Date
string
YYYY-MM-DD or ISO format datetime.

Optional Parameters

Currency
string
3-letter currency code.
Vendor
string
Pick a vendor to expense.
Notes
string

Returns

Body
Expense

Delete expense

This operation is used to delete an existing expense from your account.

Required Parameters

Account
string
Id of expense account.
Expense Id
string
Unique Id of the expense.

Returns

Body
Client

List expenses

Retrieves a list of all your expenses.

Required Parameters

Account
string
Id of expense account.

Returns

Items
ExpenseList

Array of expenses.

Update expense

This operation is used to update an existing expense in your account.

Required Parameters

Account
string
Id of expense account.
Expense Id
string
Unique Id of the expense.

Optional Parameters

Amount
string
Currency
string
3-letter currency code.
Category
integer
Pick an expense category.
Staff
integer
Pick the staff member to expense.
Date
string
YYYY-MM-DD or ISO format datetime.
Vendor
string
Pick a vendor to expense.
Notes
string

Returns

Body
Client

Triggers

When a payment is recorded or updated

Triggers when a new payment is recorded or an existing one is updated.

Required Parameters

Account
string
Id of expense account.

Returns

Body
Payment

When an expense is created or updated

Triggers when a new expense is created or an existing one is updated.

Required Parameters

Account
string
Id of expense account.

Returns

Body
Expense

When an invoice is created or updated

Triggers when a new invoice is created or an existing one is updated.

Required Parameters

Account
string
Id of expense account.

Returns

Body
Invoice

Definitions

ExpenseList

Array of expenses.

Items
Expense
Array of expenses.

Expense

Account Id
string
Id of expense account, if applicable.
Account Name
string
Name of related account, if applicable.
Amount
string
Decimal value.
Bank Name
string
Name of bank expense was imported from, if applicable.
Client Id
integer
Id of related client, if applicable.
Compounded Tax
boolean
True if tax 2 was a compounded tax.
Currency Code
string
3-letter currency code.
Date
string
Date of the expense.
Expense ID
integer
Unique to this business id for expense.
External System Id
integer
Id of related contractor system, if applicable.
Has Receipt
boolean
True if the receipt is attached.
Invoice Id
string
Id of related invoice, if applicable.
Markup Percent
string
Decimal, percent to mark expense up.
Notes
string
Expense notes.
Project Id
integer
Id of related project, if applicable.
Status
integer
Value from the expense status table.
Tax Amount 1
string
Amount of first tax.
Tax Amount 2
string
Amount of second tax.
Tax Name 1
string
Name of first tax.
Tax Name 2
string
Name of second tax.
Tax Percent 1
string
Decimal, first tax percent.
Tax Percent 2
string
Decimal, second tax percent.
Transaction Id
integer
Id of related transaction, if applicable.
Vendor
string
Name of vendor.

Invoice

3-letter currency code
string
Three-letter currency code for invoice.
Account ID
string
Unique id for system.
Amount Paid
string
Amount paid on invoice, to two decimal places.
Create Date
string
Time invoice was created, YYYY-MM-DD HH:MM:SS format.
Customer First Name
string
First name of the client on invoice.
Customer ID
integer
Unique-to-this-system client-id.
Customer Last Name
string
Last name of the client on invoice.
Description
string
Description of first line of invoice.
Discount Amount
string
Amount of discount, to two decimal places.
Email
string
Client's email.
Invoice Amount
string
Total amount of invoice, to two decimal places.
Invoice ID
integer
Unique-to-this-system invoice id.
Invoice Number
string
User-specified and visible invoice id.
Invoice create date
string
Date invoice was created, YYYY-MM-DD format.
Invoice due date
string
Date invoice is marked as due by, YYYY-MM-DD format.
Invoice paid date
string
Date invoice was fully paid, YYYY-MM-DD format.
Invoice status
string
Invoice status.
Last Updated
string
Time invoice was last updated, YYYY-MM-DD HH:MM:SS format.
Notes
string
Notes listed on invoice.
Organization invoiced
string
Name of organization being invoiced.
Outstanding Amount
string
Amount outstanding on invoice, to two decimal places.
Payment Status
string
Description of payment status. One of 'unpaid', 'partial', 'paid', and 'auto-paid'.
Two-letter language code
string
Two-letter language code of the invoice.

Payment

3-letter currency code
string
Three-letter currency code.
Account ID
string
Unique id for business.
Customer ID
integer
Unique-to-this-system client-id.
Email
string
Client's email.
First Name
string
Client's first name.
Invoice Amount
string
Total amount of the payment, to two decimal places.
Invoice ID
string
ID of the related invoice.
Last Name
string
Client's last name.
Note
string
Notes listed on the payment.
Organization
string
Name of client's business.
Payment ID
integer
Unique-to-this-system payment id.
Payment Type
string
Type of payment - Cash, check, credit
Payment date
string
Date the payment was made, YYYY-MM-DD format.
Username
string
Username used by client to log in.

Client

City
string
Billing address.
City
string
Shipping address.
Client Id
integer
Unique to this business id for client.
Company Industry
string
Description of industry client is in.
Country
string
Billing address.
Country
string
Shipping address.
Currency Code
string
3-letter shortcode for preferred currency.
Email
string
Client's email.
Fa Number
string
Client's fax number.
First Name
string
Client's first name.
Home Phone
string
Home phone number.
Language
string
Shortcode indicating user language.
Last Name
string
Client's last name.
Mobile Phone
string
Mobile phone number.
Note
string
Notes kept by admin about client.
Organization
string
Name for client's business.
Phone
string
Billing address.
Postal Code
string
Shipping address.
Postal Code
string
Billing address.
Province
string
Shipping address.
Province
string
Billing address.
Size
string
Billing address.
Street
string
Shipping address.
Street
string
Billing address.
Street 2
string
Shipping address.
Street 2
string
Billing address.
System Id
string
Unique identifier of business client exists on.
Username
string
Username used by client to log in.
VAT Name
string
Value added tax name.
VAT Number
string
Value added tax number.