Connectors Reference
FreshBooks is a cloud based small business accounting software. Send invoices, track time, manage receipts and expenses.
|
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
|
Name |
Summary |
|
List expenses |
|
|
AddExpense ([internal]integer per_page, string accountid, AddExpenseParameterBody body) |
Create new expense |
|
Update expense |
|
|
Delete expense |
|
|
List Staff |
|
|
List Category |
|
|
AddClient ([internal]integer per_page, string accountid, AddClientParameterBody body) |
Add new client |
|
My User Information |
|
|
List Vendors |
|
Name |
Summary |
|
TrigUpdatedInvoice ([internal]string include[], [internal]integer per_page, string accountid) |
When an invoice is created or updated |
|
TrigUpdatedExpense ([internal]integer per_page, string accountid) |
When an expense is created or updated |
|
TrigUpdatedPayment ([internal]string include[], [internal]integer per_page, string accountid) |
When a payment is recorded or updated |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List expenses
Description: Retrieves a list of all your expenses.
Syntax:
FreshBooks.ListExpenses ([internal]integer per_page, string accountid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
per_page |
integer
|
|
True |
|
|
accountid |
string (Account) |
Id of expense account. |
True |
Returns:
Type:array of (Expense)
Summary: Expenses
Description: Array of expenses.
Summary: Create new expense
Description: This operation creates a new expense in your account.
Syntax:
FreshBooks.AddExpense ([internal]integer per_page, string accountid, AddExpenseParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
per_page |
integer
|
|
True |
|
|
accountid |
string (Account) |
Id of expense account. |
True |
|
|
body |
|
|
True |
Returns:
Type:Expense
Summary: Update expense
Description: This operation is used to update an existing expense in your account.
Syntax:
FreshBooks.UpdateExpense ([internal]integer per_page, string accountid, string expenseid, UpdateExpenseParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
per_page |
integer
|
|
True |
|
|
accountid |
string (Account) |
Id of expense account. |
True |
|
|
expenseid |
string (Expense Id) |
Unique Id of the expense. |
True |
|
|
body |
|
|
True |
Returns:
Summary: Delete expense
Description: This operation is used to delete an existing expense from your account.
Syntax:
FreshBooks.DeleteExpense ([internal]integer per_page, string accountid, string expenseid, DeleteExpenseParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
per_page |
integer
|
|
True |
|
|
accountid |
string (Account) |
Id of expense account. |
True |
|
|
expenseid |
string (Expense Id) |
Unique Id of the expense. |
True |
|
|
body |
|
|
True |
Returns:
Summary: List Staff
Description: List staff.
Syntax:
FreshBooks.ListStaff ([internal]integer per_page, string accountid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
per_page |
integer
|
|
True |
|
|
accountid |
string (Account) |
Id of expense account. |
True |
Returns:
Type:array of (ListStaffResponseItem)
Summary: staff
Description: staff
Summary: List Category
Description: List categories.
Syntax:
FreshBooks.ListCategory ([internal]integer per_page, string accountid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
per_page |
integer
|
|
True |
|
|
accountid |
string (Account) |
Id of expense account. |
True |
Returns:
Type:array of (ListCategoryResponseItem)
Summary: categories
Description: categories
Summary: Add new client
Description: 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.
Syntax:
FreshBooks.AddClient ([internal]integer per_page, string accountid, AddClientParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
per_page |
integer
|
|
True |
|
|
accountid |
string (Account) |
Id of expense account. |
True |
|
|
body |
|
|
True |
Returns:
Type:Client
Summary: My User Information
Description: Get my user information.
Syntax:
FreshBooks.MyUserInformation ()
Returns:
Type:array of (MyUserInformationResponseItem)
Summary: business_memberships
Description: business_memberships
Summary: List Vendors
Description: List vendors.
Syntax:
FreshBooks.ListVendors ([internal]integer per_page, string accountid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
per_page |
integer
|
|
True |
|
|
accountid |
string (Account) |
Id of expense account. |
True |
Returns:
Type:array of (ListVendorsResponseItem)
Summary: vendors
Description: vendors
Summary: When an invoice is created or updated
Description: Triggers when a new invoice is created or an existing one is updated.
Syntax:
FreshBooks.TrigUpdatedInvoice ([internal]string include[], [internal]integer per_page, string accountid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
include[] |
string
|
|
True |
|
|
per_page |
integer
|
|
True |
|
|
accountid |
string (Account) |
Id of expense account. |
True |
Returns:
Type:array of (Invoice)
Summary: Invoices
Description: Array of invoices.
Summary: When an expense is created or updated
Description: Triggers when a new expense is created or an existing one is updated.
Syntax:
FreshBooks.TrigUpdatedExpense ([internal]integer per_page, string accountid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
per_page |
integer
|
|
True |
|
|
accountid |
string (Account) |
Id of expense account. |
True |
Returns:
Type:array of (Expense)
Summary: Expenses
Description: Array of expenses.
Summary: When a payment is recorded or updated
Description: Triggers when a new payment is recorded or an existing one is updated.
Syntax:
FreshBooks.TrigUpdatedPayment ([internal]string include[], [internal]integer per_page, string accountid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
include[] |
string
|
|
True |
|
|
per_page |
integer
|
|
True |
|
|
accountid |
string (Account) |
Id of expense account. |
True |
Returns:
Type:array of (Payment)
Summary: Payments
Description: Array of payments.
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
client |
|
client |
Summary:
Description: client
Properties:
|
Name |
Type |
Summary |
|
fname |
string First Name |
|
|
lname |
string Last Name |
|
|
organization |
string Organization |
|
|
|
string Email Address |
|
|
bus_phone |
string Phone Number |
|
|
currency_code |
string Currency |
3-letter currency code. Values: [AED, AMD, ANG, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWL] |
|
p_street |
string Street Address 1 |
|
|
p_street2 |
string Street Address 2 |
|
|
p_city |
string City |
|
|
p_code |
string Postal Code |
|
|
p_country |
string Country |
|
|
p_province |
string Province |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
expense |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
amount |
|
|
|
categoryid |
integer(int32) Category |
Pick an expense category. |
|
staffid |
integer(int32) Staff |
Pick the staff member to expense. |
|
date |
string Date |
YYYY-MM-DD or ISO format datetime. |
|
vendor |
string Vendor |
Pick a vendor to expense. |
|
notes |
string Notes |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
amount |
string Amount |
|
|
code |
string Currency |
3-letter currency code. Values: [AED, AMD, ANG, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWL] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
response |
|
response |
Summary:
Description: response
Properties:
|
Name |
Type |
Summary |
|
result |
|
result |
Summary:
Description: result
Properties:
|
Name |
Type |
Summary |
|
client |
|
client |
Summary:
Description: client
Properties:
|
Name |
Type |
Summary |
|
fname |
string First Name |
Client's first name. |
|
lname |
string Last Name |
Client's last name. |
|
fax |
string Fa Number |
Client's fax number. |
|
vat_number |
string VAT Number |
Value added tax number. |
|
vat_name |
string VAT Name |
Value added tax name. |
|
id |
integer(int32) Client Id |
Unique to this business id for client. |
|
s_province |
string Province |
Shipping address. |
|
s_country |
string Country |
Shipping address. |
|
s_city |
string City |
Shipping address. |
|
s_street |
string Street |
Shipping address. |
|
s_street2 |
string Street 2 |
Shipping address. |
|
s_code |
string Postal Code |
Shipping address. |
|
note |
string Note |
Notes kept by admin about client. |
|
mob_phone |
string Mobile Phone |
Mobile phone number. |
|
home_phone |
string Home Phone |
Home phone number. |
|
company_industry |
string Company Industry |
Description of industry client is in. |
|
|
string |
Client's email. |
|
username |
string Username |
Username used by client to log in. |
|
updated |
string Updated |
Updated |
|
p_province |
string Province |
Billing address. |
|
p_country |
string Country |
Billing address. |
|
p_city |
string City |
Billing address. |
|
p_street |
string Street |
Billing address. |
|
p_code |
string Postal Code |
Billing address. |
|
p_street2 |
string Street 2 |
Billing address. |
|
bus_phone |
string Phone |
Billing address. |
|
company_size |
string Size |
Billing address. |
|
accounting_systemid |
string System Id |
Unique identifier of business client exists on. |
|
language |
string Language |
Shortcode indicating user language. |
|
organization |
string Organization |
Name for client's business. |
|
currency_code |
string Currency Code |
3-letter shortcode for preferred currency. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
expense |
expense |
expense |
Summary: expense
Description: expense
Properties:
|
Name |
Type |
Summary |
|
vis_state |
integer(int32) vis_state |
vis_state |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Expense ID |
Unique to this business id for expense. |
|
markup_percent |
string Markup Percent |
Decimal, percent to mark expense up. |
|
projectid |
integer(int32) Project Id |
Id of related project, if applicable. |
|
clientid |
integer(int32) Client Id |
Id of related client, if applicable. |
|
taxPercent1 |
string Tax Percent 1 |
Decimal, first tax percent. |
|
taxName1 |
string Tax Name 1 |
Name of first tax. |
|
taxAmount1 |
|
|
|
taxPercent2 |
string Tax Percent 2 |
Decimal, second tax percent. |
|
taxName2 |
string Tax Name 2 |
Name of second tax. |
|
taxAmount2 |
|
|
|
invoiceid |
integer Invoice Id |
Id of related invoice, if applicable. |
|
status |
integer(int32) Status |
Value from the expense status table. |
|
bank_name |
string Bank Name |
Name of bank expense was imported from, if applicable. |
|
updated |
string Updated |
When the expense was last updated. |
|
vendor |
string Vendor |
Name of vendor. |
|
has_receipt |
boolean Has Receipt |
True if the receipt is attached. |
|
ext_systemid |
integer(int32) External System Id |
Id of related contractor system, if applicable. |
|
date |
string Date |
Date of the expense. |
|
transactionid |
string Transaction Id |
Id of related transaction, if applicable. |
|
notes |
string Notes |
Expense notes. |
|
account_name |
string Account Name |
Name of related account, if applicable. |
|
amount |
|
|
|
compounded_tax |
boolean Compounded Tax |
True if tax 2 was a compounded tax. |
|
accountid |
string Account Id |
Id of expense account, if applicable. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
amount |
string First task amount |
Amount of first tax. |
|
code |
string First tax currency code |
3-letter currency code. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
amount |
string Second tax amount |
Amount of second tax. |
|
code |
string Second tax currency code |
3-letter currency code. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
amount |
string Amount |
Decimal value. |
|
code |
string Currency Code |
3-letter currency code. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Invoice ID |
Unique-to-this-system invoice id. |
|
invoice_number |
string Invoice Number |
User-specified and visible invoice id. |
|
accountid |
string Account ID |
Unique id for system. |
|
currency_code |
string 3-letter currency code |
Three-letter currency code for invoice. |
|
v3_status |
string Invoice status |
Invoice status. |
|
description |
string Description |
Description of first line of invoice. |
|
notes |
string Notes |
Notes listed on invoice. |
|
language |
string Two-letter language code |
Two-letter language code of the invoice. |
|
customerid |
integer(int32) Customer ID |
Unique-to-this-system client-id. |
|
organization |
string Organization invoiced |
Name of organization being invoiced. |
|
fname |
string Customer First Name |
First name of the client on invoice. |
|
lname |
string Customer Last Name |
Last name of the client on invoice. |
|
create_date |
string Invoice create date |
Date invoice was created, YYYY-MM-DD format. |
|
due_date |
string Invoice due date |
Date invoice is marked as due by, YYYY-MM-DD format. |
|
updated |
string Last Updated |
Time invoice was last updated, YYYY-MM-DD HH:MM:SS format. |
|
created_at |
string Create Date |
Time invoice was created, YYYY-MM-DD HH:MM:SS format. |
|
date_paid |
string Invoice paid date |
Date invoice was fully paid, YYYY-MM-DD format. |
|
payment_status |
string Payment Status |
Description of payment status. One of 'unpaid', 'partial', 'paid', and 'auto-paid'. |
|
amount |
|
|
|
paid |
|
|
|
outstanding |
|
|
|
discount |
|
|
|
client |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
amount |
string Invoice Amount |
Total amount of invoice, to two decimal places. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
amount |
string Amount Paid |
Amount paid on invoice, to two decimal places. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
amount |
string Outstanding Amount |
Amount outstanding on invoice, to two decimal places. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
amount |
string Discount Amount |
Amount of discount, to two decimal places. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string |
Client's email. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
category |
string category |
category |
|
id |
integer(int32) id |
id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) id |
id |
|
display_name |
string display_name |
display_name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
vendor |
string vendor |
vendor |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
business |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Name |
|
|
account_id |
string Account Id |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Payment ID |
Unique-to-this-system payment id. |
|
type |
string Payment Type |
Type of payment - Cash, check, credit |
|
note |
string Note |
Notes listed on the payment. |
|
date |
string Payment date |
Date the payment was made, YYYY-MM-DD format. |
|
clientid |
integer(int32) Customer ID |
Unique-to-this-system client-id. |
|
amount |
|
|
|
accounting_systemid |
string Account ID |
Unique id for business. |
|
invoiceid |
integer(int32) Invoice ID |
ID of the related invoice. |
|
updated |
string Last Updated |
Time payment was last updated at, YYYY-MM-DD HH:MM:SS format. |
|
client |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
amount |
string Invoice Amount |
Total amount of the payment, to two decimal places. |
|
code |
string 3-letter currency code |
Three-letter currency code. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fname |
string First Name |
Client's first name. |
|
lname |
string Last Name |
Client's last name. |
|
|
string |
Client's email. |
|
username |
string Username |
Username used by client to log in. |
|
organization |
string Organization |
Name of client's business. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
expense |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
amount |
|
|
|
categoryid |
integer(int32) Category |
Pick an expense category. |
|
staffid |
integer(int32) Staff |
Pick the staff member to expense. |
|
date |
string Date |
YYYY-MM-DD or ISO format datetime. |
|
vendor |
string Vendor |
Pick a vendor to expense. |
|
notes |
string Notes |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
amount |
string Amount |
|
|
code |
string Currency |
3-letter currency code. Values: [AED, AMD, ANG, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWL] |