Overview
Configuration is provided for establishing connections with the FreshBooks service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Configuration
Base URL address: https://api.freshbooks.com.
- Token
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}} -
Api-Version:
alpha
Documentation: https://www.freshbooks.com/api/authentication.
-
Authorization:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/auth/api/v1/users/me.
The result is extracted from:{{=[response.response]}}.
- id
A key field. Data type: DT_I4
- profile
Field components:
-
Uses template:
ShortText. - Contains the following components: setup_complete, first_name, last_name, phone_number, address, professions.
-
Uses template:
- first_name
Template: ShortText.
- last_name
Template: ShortText.
Template: ShortText.
- confirmed_at
Template: DateTime.
- created_at
Template: DateTime.
- setup_complete
Data type: DT_BOOL
- phone_numbers
Field components:
- An array.
- Contains the following components: title, phone_number.
- addresses
Field components:
- An array.
-
Uses template:
AddressT.
- profession
Template: ProfessionT.
- links
Field components:
- An array.
-
Uses template:
LinkT.
- permissions
The gathered value is processed with
{{=_.map(item.permissions, function(v, k) { return _.extend({ id: k }, v); })}}expression. Field components:- An array.
- Contains the following components: id, notifications.access, beta.mobile.expenses, client.event.search, time_tracking.access, invoice_discounts.access, clienttypeahead.access, invoice_line_item_typeahead.access, client.limit, staff.limit.
- groups
Field components:
- An array.
- Contains the following components: id, group_id, role, identity_id, first_name, last_name, email, company, business_id, active.
- subscription_statuses
The gathered value is processed with
{{=_.map(item.subscription_statuses, function(v, k) { return { id: k, status: v }; })}}expression. Field components:- An array.
- Contains the following components: id, status.
- integrations
Template: LongText. A composite field.
- business_memberships
Field components:
- An array.
- Contains the following components: id, role, business.
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/users/clients.
- [Create] action
-
Endpoint URL address:
/users/clients.
- [Update] action
-
Endpoint URL address:
/users/clients/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/users/clients/{{=item.id}}.
- id
A key field. Data type: DT_I4
- accounting _systemid
Template: ShortText.
- bus_phone
Template: ShortText.
- company_industry
Template: ShortText.
- company_size
Template: ShortText.
- currency_code
Template: ShortText.
Template: ShortText.
- fax
Template: ShortText.
- fname
Template: ShortText.
- home_phone
Template: ShortText.
- language
Template: ShortText.
- last_activity
Template: DateTime.
- last_login
Template: ShortText.
- lname
Template: ShortText.
- mob_phone
Template: ShortText.
- note
Template: LongText.
- num_logins
Data type: DT_I4
- organization
Template: ShortText.
- p_city
Template: ShortText.
- p_code
Template: ShortText.
- p_country
Template: ShortText.
- p_province
Template: ShortText.
- p_street
Template: ShortText.
- p_street2
Template: ShortText.
- pref_email
Data type: DT_BOOL
- pref_gmail
Data type: DT_BOOL
- s_city
Template: ShortText.
- s_code
Template: ShortText.
- s_country
Template: ShortText.
- s_province
Template: ShortText.
- s_street
Template: ShortText.
- s_street2
Template: ShortText.
- signup_date
Template: DateTime.
- updated
Template: DateTime.
- username
Template: ShortText.
- vat_name
Template: ShortText.
- vat_number
Data type: DT_I4
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/estimates/estimates.
- [Create] action
-
Endpoint URL address:
/estimates/estimates.
- [Update] action
-
Endpoint URL address:
/estimates/estimates/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/estimates/estimates/{{=item.id}}.
- id
A key field. Data type: DT_I4
- status
Data type: DT_I4
- create_date
Template: Date.
- code
Template: ShortText.
- ownerid
Data type: DT_I4
- vat_number
Template: ShortText.
- vat_name
Template: ShortText.
- ui_status
Template: ShortText.
- invoiced
Data type: DT_BOOL
- reply_status
Template: ShortText.
- country
Template: ShortText.
- lname
Template: ShortText.
- estimateid
Data type: DT_I4
- ext_archive
Data type: DT_I4
- template
Template: ShortText.
- vis_state
Data type: DT_I4
- current_organization
Template: ShortText.
- province
Template: ShortText.
- updated
Template: DateTime.
- terms
Template: ShortText.
- description
Template: LongText.
- street2
Template: ShortText.
- discount_total
Template: AmountT.
- address
Template: ShortText.
- estimate_number
Template: ShortText.
- customerid
Data type: DT_I4
- discount_value
Data type: DT_R8
- accounting_systemid
Template: ShortText.
- organization
Template: ShortText.
- language
Template: ShortText.
- po_number
Template: ShortText.
- display_status
Template: ShortText.
- notes
Template: LongText.
- amount
Template: AmountT.
- street
Template: ShortText.
- city
Template: ShortText.
- currency_code
Template: ShortText.
- sentid
Data type: DT_I4
- fname
Template: ShortText.
- created_at
Template: DateTime.
- accountid
Template: ShortText.
- lines
Field components:
- An array.
-
Uses template:
LineT.
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/expenses/categories.
- id
A key field. Data type: DT_I4
- category
Template: ShortText.
- categoryid
Data type: DT_I4
- is_editable
Data type: DT_BOOL
- is_cogs
Data type: DT_BOOL
- parentid
Data type: DT_I4
- vis_state
Data type: DT_I4
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/expenses/expenses.
- [Create] action
-
Endpoint URL address:
/expenses/expenses.
- [Update] action
-
Endpoint URL address:
/expenses/expenses/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/expenses/expenses/{{=item.id}}.
- id
A key field. Data type: DT_I4
- categoryid
Data type: DT_I4
- markup_percent
Data type: DT_R8
- projectid
Data type: DT_I4
- clientid
Data type: DT_I4
- taxPercent1
Data type: DT_R8
- taxName2
Template: ShortText.
- taxName1
Template: ShortText.
- isduplicate
Data type: DT_BOOL
- profileid
Data type: DT_I4
- taxPercent2
Data type: DT_R8
- account_name
Template: ShortText.
- transactionid
Data type: DT_I4
- invoiceid
Data type: DT_I4
- taxAmount2
Template: AmountT.
- taxAmount1
Template: AmountT.
- vis_state
Data type: DT_I4
- status
Data type: DT_I4
- bank_name
Template: ShortText.
- updated
Template: DateTime.
- vendor
Template: ShortText.
- ext_systemid
Data type: DT_I4
- staffid
Data type: DT_I4
- date
Template: Date.
- has_receipt
Data type: DT_BOOL
- accounting_systemid
Template: ShortText.
- background_jobid
Template: ShortText.
- notes
Template: LongText.
- ext_invoiceid
Data type: DT_I4
- amount
Template: AmountT.
- expenseid
Data type: DT_I4
- compounded_tax
Data type: DT_BOOL
- accountid
Template: ShortText.
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/system/gateways.The following request parameters will be automatically processed:
-
include:
-
include:
- [Delete] action
-
Endpoint URL address:
/system/gateways/{{=item.id}}.
The action uses DELETE method.
- id
A key field. Data type: DT_I4
- sgid
Data type: DT_I4
- connectionid
Template: ShortText.
- gateway_name
Template: ShortText.
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/invoices/invoices.
- [Create] action
-
Endpoint URL address:
/invoices/invoices.
- [Update] action
-
Endpoint URL address:
/invoices/invoices/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/invoices/invoices/{{=item.id}}.
- id
A key field. Data type: DT_I4
- status
Data type: DT_I4
- deposit_percentage
Data type: DT_R8
- create_date
Template: Date.
- outstanding
Template: AmountT.
- payment_status
Template: ShortText.
- code
Template: ShortText.
- ownerid
Data type: DT_I4
- vat_number
Template: ShortText.
- gmail
Data type: DT_BOOL
- vat_name
Template: ShortText.
- v3_status
Template: ShortText.
- parent
Data type: DT_I4
- country
Template: ShortText.
- dispute_status
Template: ShortText.
- lname
Template: ShortText.
- deposit_status
Template: ShortText.
- estimateid
Data type: DT_I4
- ext_archive
Data type: DT_I4
- template
Template: ShortText.
- basecampid
Data type: DT_I4
- generation_date
Template: Date.
- show_attachments
Data type: DT_BOOL
- vis_state
Data type: DT_I4
- current_organization
Template: ShortText.
- province
Template: ShortText.
- due_date
Template: Date.
- updated
Template: DateTime.
- terms
Template: ShortText.
- description
Template: LongText.
- discount_description
Template: LongText.
- last_order_status
Template: ShortText.
- street2
Template: ShortText.
- deposit_amount
Template: ShortText.
- paid
Template: AmountT.
- invoiceid
Data type: DT_I4
- discount_total
Template: AmountT.
- address
Template: ShortText.
- invoice_number
Template: ShortText.
- customerid
Data type: DT_I4
- discount_value
Data type: DT_R8
- accounting_systemid
Template: ShortText.
- organization
Template: ShortText.
- due_offset_days
Data type: DT_I4
- language
Template: ShortText.
- po_number
Template: ShortText.
- display_status
Template: ShortText.
- notes
Template: LongText.
- date_paid
Template: Date.
- amount
Template: AmountT.
- street
Template: ShortText.
- city
Template: ShortText.
- currency_code
Template: ShortText.
- sentid
Data type: DT_I4
- autobill_status
Template: ShortText.
- return_uri
Template: ShortText.
- fname
Template: ShortText.
- created_at
Template: DateTime.
- auto_bill
Data type: DT_BOOL
- accountid
Template: ShortText.
- lines
Field components:
- An array.
-
Uses template:
LineT.
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/items/items.
- [Create] action
-
Endpoint URL address:
/items/items.
- [Update] action
-
Endpoint URL address:
/items/items/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/items/items/{{=item.id}}.
- id
A key field. Data type: DT_I4
- accounting_systemid
Template: ShortText.
- updated
Template: DateTime.
- name
Template: ShortText.
- qty
Data type: DT_I4
- inventory
Data type: DT_I4
- unit_cost
Template: AmountT.
- tax1
Data type: DT_R8
- vis_state
Data type: DT_I4
- tax2
Data type: DT_R8
- description
Template: LongText.
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/payments/payments.
- [Create] action
-
Endpoint URL address:
/payments/payments.
- [Update] action
-
Endpoint URL address:
/payments/payments/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/payments/payments/{{=item.id}}.
- id
A key field. Data type: DT_I4
- orderid
Data type: DT_I4
- accounting_systemid
Template: ShortText.
- updated
Template: DateTime.
- invoiceid
Data type: DT_I4
- creditid
Data type: DT_I4
- amount
Template: AmountT.
- clientid
Data type: DT_I4
- vis_state
Data type: DT_I4
- logid
Data type: DT_I4
- note
Template: LongText.
- overpaymentid
Data type: DT_I4
- gateway
Template: ShortText.
- date
Template: Date.
- transactionid
Data type: DT_I4
- from_credit
Data type: DT_BOOL
- type
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/projects.
- [Create] action
-
Endpoint URL address:
/projects.
- [Update] action
-
Endpoint URL address:
/projects/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.id}}.
- id
A key field. Data type: DT_I4
- due_date
Template: Date.
- links
Field components:
- An array.
-
Uses template:
LinkT.
- fixed_price
Data type: DT_R8
- group
Field components:
-
Uses template:
LongText. - Contains the following components: id, pending_invitations, members.
-
Uses template:
- description
Template: LongText.
- complete
Data type: DT_BOOL
- title
Template: ShortText.
- project_type
Template: ShortText.
- budget
Data type: DT_R8
- updated_at
Template: DateTime.
- sample
Data type: DT_BOOL
- services
Field components:
- An array.
- Contains the following components: id, business_id, name.
- rate
Data type: DT_R8
- internal
Data type: DT_BOOL
- client_id
Data type: DT_I4
- active
Data type: DT_BOOL
- created_at
Template: DateTime.
- logged_duration
Data type: DT_I4
- billing_method
Template: ShortText.
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/users/staffs.
- [Create] action
-
Endpoint URL address:
/users/staffs.
- [Update] action
-
Endpoint URL address:
/users/staffs/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/users/staffs/{{=item.id}}.
- id
A key field. Data type: DT_I4
- fax
Template: ShortText.
- rate
Data type: DT_R8
- num_logins
Data type: DT_I4
- api_token
Template: ShortText.
- note
Template: LongText.
- display_name
Template: ShortText.
- lname
Template: ShortText.
- mob_phone
Template: ShortText.
- last_login
Template: DateTime.
- home_phone
Template: ShortText.
Template: ShortText.
- username
Template: ShortText.
- updated
Template: DateTime.
- p_province
Template: ShortText.
- p_city
Template: ShortText.
- p_code
Template: ShortText.
- p_country
Template: ShortText.
- accounting_systemid
Template: ShortText.
- bus_phone
Template: ShortText.
- signup_date
Template: DateTime.
- language
Template: ShortText.
- level
Data type: DT_I4
- userid
Data type: DT_I4
- p_street2
Template: ShortText.
- vis_state
Data type: DT_I4
- fname
Template: ShortText.
- organization
Template: ShortText.
- p_street
Template: ShortText.
- currency_code
Template: ShortText.
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/projects/tasks.
- [Create] action
-
Endpoint URL address:
/projects/tasks.
- [Update] action
-
Endpoint URL address:
/projects/tasks/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/projects/tasks/{{=item.id}}.
- id
A key field. Data type: DT_I4
- updated
Template: DateTime.
- description
Template: LongText.
- vis_state
Data type: DT_I4
- rate
Template: AmountT.
- taskid
Data type: DT_I4
- billable
Data type: DT_BOOL
- tname
Template: ShortText.
- tdesc
Template: ShortText.
- name
Template: ShortText.
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/taxes/taxes.The following request parameters will be automatically processed:
-
include:
-
include:
- [Create] action
-
Endpoint URL address:
/taxes/taxes.
- [Update] action
-
Endpoint URL address:
/taxes/taxes/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/taxes/taxes/{{=item.id}}.
- id
A key field. Data type: DT_I4
- accounting_systemid
Template: ShortText.
- updated
Template: DateTime.
- name
Template: ShortText.
- number
Template: ShortText.
- taxid
Data type: DT_I4
- amount
Data type: DT_R8
- compound
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/time_entries.
- [Create] action
-
Endpoint URL address:
/time_entries.
- [Update] action
-
Endpoint URL address:
/time_entries/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/time_entries/{{=item.id}}.
The action uses DELETE method.
- id
A key field. Data type: DT_I4
- note
Template: LongText.
- duration
Data type: DT_I4
- project_id
Data type: DT_I4
- client_id
Data type: DT_I4
- is_logged
Data type: DT_BOOL
- started_at
Template: DateTime.
- active
Data type: DT_BOOL
- timer
Field components:
- Contains the following components: id, is_running.
- [Read] action
-
The result is extracted from:{{=response.response.result[resource.objects]}}.
The result is paginated.The following request parameters will be automatically processed:
-
include:
{{=parameters.fields}} -
page:
{{=parameters.iterator}} -
per_page :
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
include:
- [Create] action
-
The result is extracted from:{{=response.result[resource.object]}}.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{= function(item) { var result = {}; result[resource.object] = item; return result; }(item) }} -
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Update] action
-
The result is extracted from:{{=response.result[resource.object]}}.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{= function(item) { var result = {}; result[resource.object] = item; return result; }(item) }} -
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Delete] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{= function(item) { var result = {}; result[resource.object] = { vis_state: 1 }; return result; }(item) }} -
_includeUserParameters:
{{=parameters}}
-
application/json:
Based on resource template Base.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- ProfessionT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, title, company, designation.
-
Uses template:
- AddressT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, street, city, province, country, postal_code.
-
Uses template:
- AmountT
Field components:
-
Uses template:
ShortText. - Contains the following components: amount, code.
-
Uses template:
- LineT
Field components:
-
Uses template:
ShortText. - Contains the following components: type, description, taxName1, taxAmount1, name, qty, taxName2, taxAmount2, unit_cost.
-
Uses template:
- LinkT
The gathered value is processed with
{{=_.map(item.links, function(v, k) { return { id: k, link: v }; })}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: id, link.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.