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 / Get

  • Article
  • 2 minutes to read

Operation Information

Retrieves details about an Invoice in ActiveCollab.

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

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 ActiveCollab in the Type pick list;
  • Give the ActiveCollab KeySafe key a Title (this is the name / identifier for the ActiveCollab account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Account ID string The Account ID for the ActiveCollab account
Email Address string The email address/user ID of the ActiveCollab user
Password string Authentication Password
Client Name string The Client Name for the ActiveCollab token
API Token string Please leave this field blank, as it's populated by the system,

Tip

The Account ID, above, can be found in your ActiveCollab URL as so: https://app.activecollab.com/YOURACCOUNTID/projects.

Revoking Access

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

Warning

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

Input Parameters

Display Name ID Type Description Required Supported Values
Invoice ID invoiceId integer This is the Unique ID of the Invoice (it can be found in the URL). Yes None provided

Output Parameters

Display Name ID Type Description
Error Message error string The error of your api call
Status Code status string The status of your api call
Company Name companyName string The name of the invoiced company
Company Address companyAddress string The address of the invoiced Company
Project URL urlPath string The url path to your project
Note note string Additional information for the invoiced company
Currency Id currencyId integer The Id of the desired currency (BPS:285, USD:5, EUR:19)
Invoice Total total string The total amount of the invoice
Balance Due balanceDue string The amount still outstanding on the invoice
Tax tax string The Tax on the Invoice
Invoice Number invoiceNumber integer The Invoice Number
referenceNumber referenceNumber string The reference number
Issued On issuedOn string The Invoice Created Date
Due On dueOn string The Invoice Due Date
Public URL publicUrl string The Invoice public URL
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document