Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Clients / Client Update

  • Article
  • 2 minutes to read

Operation Information

Updates a clients information in FreshBooks.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type FreshBooks.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose FreshBooks in the Type pick list;
  • Give the FreshBooks KeySafe key a Title (this is the name / identifier for the FreshBooks account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Click the Create Key button to create your new key;
  • Once the Key is created, you will need to connect to the target service, and your account, in order to authorize the connector app access to the listed operations. Click the Connect button and you will be redirected to the service provider in a popup window;
  • Log in to your account, and then you will be prompted to review the options you are authorizing the Hornbill connector to be allowed to perform using the chosen account;
  • Accept the review and you will be returned to your KeySafe key.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just hit the Revoke button in the relevant KeySafe key(s).

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked FreshBooks account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Account Name accountName string FreshBooks Account Name Yes None provided
Client ID clientId string Client ID Yes None provided
Email Address email string Email Address No None provided
City city string City No None provided
Country country string Country No None provided
Currency Code currencyCode string Currency Code No None provided
First Name firstName string First Name No None provided
Phone homePhone string Home Phone Number No None provided
Last Name lastName string Last Name No None provided
Organization Name organization string Organization Name No None provided
Post Code postcode string Post Code No None provided
Province province string Province/State/County No None provided
Street Name street string Street Name No None provided

Output Parameters

Display Name ID Type Description
City city string City
Country country string Country
Currency Code currencyCode string Currency Code
First Name firstName string First Name
Phone homePhone string Home Phone Number
Client Id id number Client Id
Last Name lastName string Last Name
Organization Name organization string Organization Name
Post Code postcode string Post Code
Province province string Province/State/County
Street Name street string Street Name
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document