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

Items / Get

  • Article
  • 3 minutes to read

Operation Information

Retrieves an Item’s details from 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 ID or Item Code itemID string Please enter the item ID or Code Yes 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 organization Providing the Item Searched.
Item ID id string The ID of the Item that was Searched
Item Code code string The Specific Item code of the Item that was Searched
Item Description itemDescription string An addition Item description providing more informatin about an Item.
Purchase Description purchaseDescription string Additional Information about the Purchasing of this Item
Purchase Unit Price purchaseUnitPrice string The price this Item was Purchased at.
Purchase COGS Account Code purchaseAccountCode string The Account Code the Item was purchased under.
Purchase Tax Type purchaseTaxType string The amount of Tax added to the Item on Purchase
Sales Unit Price salesUnitPrice string The Sale Price of the Item.
Sales Account Code salesAccountCode string The Sales Account Code associated with the Item.
Sales Tax Code salesTaxType string The Tax associated with the Sale of this Item.
Item Name name string The Name of the Item.
Tracked Item Inventory isTracked string Does this Item have tracking enabled against it?
Inventory Asset Code inventoryAsset string The specfic Asset Code associated with the item.
Item Quantity On Hand quantity string The Current Quantity of this Item that is available
Has Been Sold isSold string Has this Item been sold in the past?
Has Been Purchased isPurchase string Has this item been purchased in the past?
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document