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

A function to get Invoices from Chargebee.

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

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 Chargebee in the Type pick list;
  • Give the Chargebee KeySafe key a Title (this is the name / identifier for the Chargebee 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
API Key string API Key for authenticating API requests
Endpoint string API Endpoint

Tip

The Endpoint field should be populated with the Chargebee subdomain that your account is assigned, and can be taken from the URL as so: https://[Endpoint].chargebee.com.

See the Chargebee website for details on creating API Keys.

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 Chargebee account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Invoice ID ID string Invoice ID (This can be found in the URL of the record.) Yes None provided

Output Parameters

Display Name ID Type Description
Error Message error string Any errors returned by the Freshstatus API
Status Code status string The status of the operation: ok / failed
Invoice Id id string Invoice ID
Amount Due amountDue string None provided
Amount Adjusted amountAdjusted string None provided
Amount Paid amountPaid string None provided
Amount Outstanding amountToCollect string None provided
Currency Code currencyCode string None provided
Billing Address First Name billingAddressFN string None provided
Billing Address Last Name billingAddressLN string None provided
Billing Address Line 1 billingAddressL1 string None provided
Billing Address Line 2 billingAddressL2 string None provided
Billing Address Line 3 billingAddressL3 string None provided
Billing Address City city string None provided
Billing Address Postcode postcode string None provided
Billing Address Country country string None provided
Customer ID customerID string None provided
Invoice Date date string None provided
Deleted Invoice deleted string None provided
Invoice Due Date dueDate string None provided
Invoice Paid Date paidAt string None provided
Net Term Days netTermDays string None provided
Price Type priceType string None provided
Recurring Billing recurring string None provided
Invoice Status invoiceStatus string None provided
Sub Total subTotal string None provided
Tax On Invoice tax string None provided
Terms Finalised termFinalized string None provided
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document