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
  • 4 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 The amount due on the retrieved incoice
Amount Adjusted amountAdjusted string The amount adjusted on the retrieved invoice
Amount Paid amountPaid string The amount paid at the time of retieval for the invoice
Amount Outstanding amountToCollect string The amount left to collected against the invoice retireved
Currency Code currencyCode string The currency code for example U.S Dollars (USD)
Billing Address First Name billingAddressFN string The first name of the person/company the invoice is billed to
Billing Address Last Name billingAddressLN string The last name of the person/comapny the invoice is billed to
Billing Address Line 1 billingAddressL1 string The first line of the billing address the invoice is sent to
Billing Address Line 2 billingAddressL2 string The second line of the billing address the invoice is sent to
Billing Address Line 3 billingAddressL3 string Establishes If A Customer Will Pay Via Direct Debit
Billing Address City city string The billing address city the retrieved invoice is billed to
Billing Address Postcode postcode string The billing address postcode the invoice retrieved is billed to
Billing Address Country country string The billing address country the retrieved invoice is billed to
Customer ID customerID string The customer ID that the invoice is billed to
Invoice Date date string The date time that the invoice was created
Deleted Invoice deleted string A true or false statement showcasing if the invoice has been deleted or not
Invoice Due Date dueDate string The date time that the invoice is due by
Invoice Paid Date paidAt string The date time that the invoice was paid at
Net Term Days netTermDays string Net days is a term used in payments to represent when the payment is due, in contrast to the date that the goods/services were delivered
Price Type priceType string The price type assigned to the invoice
Recurring Billing recurring string A true or false statement declaring if the invoice is recurring
Invoice Status invoiceStatus string The status of the invoice at the time of retrieval
Sub Total subTotal string The subtotal of the invoice retrieved
Tax On Invoice tax string The percentage of tax against the invoice
Terms Finalised termFinalized string A true or false statement stating if the terms of the Invoice have been finalized
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document