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...

Invoices / Invoice Create

  • Article
  • 2 minutes to read

Operation Information

Create an invoice 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 number Client Id Yes None provided
Currency Code currencyCode string Currency Code used for the invoice (e.g. GBP) No USD, CAD, EUR, GBP, AUD
Product/Service Description description string Description of Product/Service being invoiced No None provided
Email email string Client Email Yes None provided
Invoice Number invoiceNumber string Invoice Number No None provided
Invoice Period (Days) invoiceDays number Invoice Period (Days) No None provided
Product/Service Name name string Name of Product/Service being invoiced No None provided
Quantity quantity number Quantity of items being invoiced No None provided
Tax Name taxName string Name of Tax being applied to invoice item No None provided
Tax Rate taxRate number Rate of Tax being applied to invoice item No None provided
Unit Cost unitCost number Cost of each item being invoiced No None provided

Output Parameters

Display Name ID Type Description
Invoice Id id number Invoice Id
Invoice Number invoiceNumber string Generated Invoice Number
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document