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
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Contact
Name Microsoft
URL Microsoft LogicApps Support
Microsoft Power Automate Support
Microsoft Power Apps Support
Connector Metadata
Publisher Microsoft
Website https://www.freshbooks.com/
Privacy policy https://www.freshbooks.com/policies/privacy

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds
Frequency of trigger polls160 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.

Create new expense

This operation creates a new expense in your account.

Delete expense

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

List expenses

Retrieves a list of all your expenses.

Update expense

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

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.

Parameters

Name Key Required Type Description
Account
accountid True string

Id of expense account.

First Name
fname string
Last Name
lname string
Organization
organization string
Email Address
email string
Phone Number
bus_phone string
Currency
currency_code string

3-letter currency code.

Street Address 1
p_street string
Street Address 2
p_street2 string
City
p_city string
Postal Code
p_code string
Country
p_country string
Province
p_province string

Returns

Body
Client

Create new expense

This operation creates a new expense in your account.

Parameters

Name Key Required Type Description
Account
accountid True string

Id of expense account.

Amount
amount True string
Currency
code string

3-letter currency code.

Category
categoryid True integer

Pick an expense category.

Staff
staffid True integer

Pick the staff member to expense.

Date
date True string

YYYY-MM-DD or ISO format datetime.

Vendor
vendor string

Pick a vendor to expense.

Notes
notes string

Returns

Body
Expense

Delete expense

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

Parameters

Name Key Required Type Description
Account
accountid True string

Id of expense account.

Expense Id
expenseid True string

Unique Id of the expense.

List expenses

Retrieves a list of all your expenses.

Parameters

Name Key Required Type Description
Account
accountid True string

Id of expense account.

Returns

Array of expenses.

Items
ExpenseList

Update expense

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

Parameters

Name Key Required Type Description
Account
accountid True string

Id of expense account.

Expense Id
expenseid True string

Unique Id of the expense.

Amount
amount string
Currency
code string

3-letter currency code.

Category
categoryid integer

Pick an expense category.

Staff
staffid integer

Pick the staff member to expense.

Date
date string

YYYY-MM-DD or ISO format datetime.

Vendor
vendor string

Pick a vendor to expense.

Notes
notes string

Triggers

When a payment is recorded or updated

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

When an expense is created or updated

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

When an invoice is created or updated

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

When a payment is recorded or updated

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

Parameters

Name Key Required Type Description
Account
accountid True 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.

Parameters

Name Key Required Type Description
Account
accountid True 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.

Parameters

Name Key Required Type Description
Account
accountid True string

Id of expense account.

Returns

Body
Invoice

Definitions

ExpenseList

Array of expenses.

Name Path Type Description
Items
Expense

Expense

Name Path Type Description
Expense ID
id integer

Unique to this business id for expense.

Markup Percent
markup_percent string

Decimal, percent to mark expense up.

Project Id
projectid integer

Id of related project, if applicable.

Client Id
clientid integer

Id of related client, if applicable.

Tax Percent 1
taxPercent1 string

Decimal, first tax percent.

Tax Name 1
taxName1 string

Name of first tax.

First task amount
taxAmount1.amount string

Amount of first tax.

First tax currency code
taxAmount1.code string

3-letter currency code.

Tax Percent 2
taxPercent2 string

Decimal, second tax percent.

Tax Name 2
taxName2 string

Name of second tax.

Second tax amount
taxAmount2.amount string

Amount of second tax.

Second tax currency code
taxAmount2.code string

3-letter currency code.

Invoice Id
invoiceid integer

Id of related invoice, if applicable.

Status
status integer

Value from the expense status table.

Bank Name
bank_name string

Name of bank expense was imported from, if applicable.

Vendor
vendor string

Name of vendor.

Has Receipt
has_receipt boolean

True if the receipt is attached.

External System Id
ext_systemid integer

Id of related contractor system, if applicable.

Date
date string

Date of the expense.

Transaction Id
transactionid string

Id of related transaction, if applicable.

Notes
notes string

Expense notes.

Account Name
account_name string

Name of related account, if applicable.

Amount
amount.amount string

Decimal value.

Currency Code
amount.code string

3-letter currency code.

Compounded Tax
compounded_tax boolean

True if tax 2 was a compounded tax.

Account Id
accountid string

Id of expense account, if applicable.

Invoice

Name Path Type Description
Invoice ID
id integer

Unique-to-this-system invoice id.

Invoice Number
invoice_number string

User-specified and visible invoice id.

Account ID
accountid string

Unique id for system.

3-letter currency code
currency_code string

Three-letter currency code for invoice.

Invoice status
v3_status string

Invoice status.

Description
description string

Description of first line of invoice.

Notes
notes string

Notes listed on invoice.

Two-letter language code
language string

Two-letter language code of the invoice.

Customer ID
customerid integer

Unique-to-this-system client-id.

Organization invoiced
organization string

Name of organization being invoiced.

Customer First Name
fname string

First name of the client on invoice.

Customer Last Name
lname string

Last name of the client on invoice.

Invoice create date
create_date string

Date invoice was created, YYYY-MM-DD format.

Invoice due date
due_date string

Date invoice is marked as due by, YYYY-MM-DD format.

Last Updated
updated string

Time invoice was last updated, YYYY-MM-DD HH:MM:SS format.

Create Date
created_at string

Time invoice was created, YYYY-MM-DD HH:MM:SS format.

Invoice paid date
date_paid string

Date invoice was fully paid, YYYY-MM-DD format.

Payment Status
payment_status string

Description of payment status. One of 'unpaid', 'partial', 'paid', and 'auto-paid'.

Invoice Amount
amount.amount string

Total amount of invoice, to two decimal places.

Amount Paid
paid.amount string

Amount paid on invoice, to two decimal places.

Outstanding Amount
outstanding.amount string

Amount outstanding on invoice, to two decimal places.

Discount Amount
discount.amount string

Amount of discount, to two decimal places.

Email
client.email string

Client's email.

Payment

Name Path Type Description
Payment ID
id integer

Unique-to-this-system payment id.

Payment Type
type string

Type of payment - Cash, check, credit

Note
note string

Notes listed on the payment.

Payment date
date string

Date the payment was made, YYYY-MM-DD format.

Customer ID
clientid integer

Unique-to-this-system client-id.

Invoice Amount
amount.amount string

Total amount of the payment, to two decimal places.

3-letter currency code
amount.code string

Three-letter currency code.

Account ID
accounting_systemid string

Unique id for business.

Invoice ID
invoiceid integer

ID of the related invoice.

First Name
client.fname string

Client's first name.

Last Name
client.lname string

Client's last name.

Email
client.email string

Client's email.

Username
client.username string

Username used by client to log in.

Organization
client.organization string

Name of client's business.

Client

Name Path Type Description
First Name
response.result.client.fname string

Client's first name.

Last Name
response.result.client.lname string

Client's last name.

Fa Number
response.result.client.fax string

Client's fax number.

VAT Number
response.result.client.vat_number string

Value added tax number.

VAT Name
response.result.client.vat_name string

Value added tax name.

Client Id
response.result.client.id integer

Unique to this business id for client.

Province
response.result.client.s_province string

Shipping address.

Country
response.result.client.s_country string

Shipping address.

City
response.result.client.s_city string

Shipping address.

Street
response.result.client.s_street string

Shipping address.

Street 2
response.result.client.s_street2 string

Shipping address.

Postal Code
response.result.client.s_code string

Shipping address.

Note
response.result.client.note string

Notes kept by admin about client.

Mobile Phone
response.result.client.mob_phone string

Mobile phone number.

Home Phone
response.result.client.home_phone string

Home phone number.

Company Industry
response.result.client.company_industry string

Description of industry client is in.

Email
response.result.client.email string

Client's email.

Username
response.result.client.username string

Username used by client to log in.

Province
response.result.client.p_province string

Billing address.

Country
response.result.client.p_country string

Billing address.

City
response.result.client.p_city string

Billing address.

Street
response.result.client.p_street string

Billing address.

Postal Code
response.result.client.p_code string

Billing address.

Street 2
response.result.client.p_street2 string

Billing address.

Phone
response.result.client.bus_phone string

Billing address.

Size
response.result.client.company_size string

Billing address.

System Id
response.result.client.accounting_systemid string

Unique identifier of business client exists on.

Language
response.result.client.language string

Shortcode indicating user language.

Organization
response.result.client.organization string

Name for client's business.

Currency Code
response.result.client.currency_code string

3-letter shortcode for preferred currency.