Documentation

{{docApp.title}}

{{docApp.description}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?


What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

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

{{group.description}}

  1. {{book.title}}

{{group.title}}

Items / Create

Operation Information

Creates an Item within Xero.

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

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 Xero in the Type pick list;
  • Give the Xero KeySafe key a Title (this is the name / identifier for the Xero 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 Xero account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Tenant ID tenantId string The Tenant ID for your system this is essential for Xero API Calls, please select the correct Tenant from the selction provided. Yes None provided
Item Code code string Please enter the item ID or Code Yes None provided
Item Name name string Please Enter the Desired Item Name. No None provided
Item Description itemDescription string Additional information to help identify the Item. No None provided
Purchase Description purchaseDescription string A description about the Purchase information of the Item. No None provided
Purchase Tax Type purchaseTaxType string The Tax amount applied during the purchase of the Item. No 20%, 15%, 5%, 0%
Purchase Unit Price purchaseUnitPrice string The Price the Item was purchased at. No None provided
Sales Tax Code salesTaxType string The amount of Tax aplied on to the item at the point of Sale. No 20%, 15%, 5%, 0%
Sales Unit Price salesUnitPrice string The amount the Item is sold at. No None provided
Item Can Be Sold isSold boolean Has the product been sold? No None provided
Item Can Be Purchased isPurchased boolean Is the item Purchasable? No None provided

Output Parameters

Display Name ID Type Description
Error Message error string Any errors returned by the Xero API
Status Code status string The status of the operation: ok / failed
Providing Organization Name providerName string The Name of the organization that provides the Item Listed
Item ID id string The ID of the Item that was just Updated.
Item Code code string The Item Code on the Item you just Updated.
Item Description itemDescription string The Item Description on the Item that was Updated
Purchase Description purchaseDescription string The Description of Purchase on the Updated Item.
Purchase Unit Price purchaseUnitPrice string The Purchasing Unit Price of this Item.
Purchase COGS Account Code purchaseAccountCode string The Purchasing Account Code of this specfic Item.
Purchase Tax Type purchaseTaxType string Purchasing Tax Amount of the Updated Item.
Sales Unit Price salesUnitPrice string The Sales Price of the Updated Item.
Sales Account Code salesAccountCode string The Sales Account Code of the Updated Item
Sales Tax Code salesTaxType string The Sales Tax Amount of the Updated Item
Item Name name string The Name of the Updated Item
Tracked Item Inventory isTracked string Is the Updated Item’s inventory tracked by Xeo?
Inventory Asset Code inventoryAsset string The Items Inventory specific Inventory Code.
Item Quantity On Hand quantity string The immediate stock availabiltly for the Updated Item.
Has Been Sold isSold string Has the Updated Item been sold?
Has Been Purchased isPurchase string Has the Updated Item been purchased?
In This Document