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

Contacts / Create

  • Article
  • 3 minutes to read

Operation Information

Creates a Contact 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
Contact Full Name name string The name you would like to update the contact with. Yes None provided
Account Number accountNumber string An Account Number you would like to associate the Contact with. No None provided
Company Number companyNumber string The Company Number associated with Contact. No None provided
Contact Status contactStatus string The Status of the Contact No Active, Archived, GDPR Request
Email Address email string The Contact’s Email Address No None provided
Phone Numbers phones array Any contact numbers you would like to create for this Contact. No None provided
Contact Addresses addresses array None provided No None provided
Additional Contacts contactPersons array Any Additional Contacts No None provided
Default Currency DefautCurrency string Please enter the Currecny Code you eould like to be used. For Example: British Pound Sterling - GBP No None provided
Contact is a Supplier supplier boolean Does this Contact act as a Supplier? No None provided
Contact is a Customer customer boolean Does this Contact act as a Customer? No None provided

Output Parameters

Display Name ID Type Description
Error Message error string Any errors returned by the Voodoo SMS 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 Invoice.
Contact ID id string The Contact ID.
Contact Full Name name string The Contact’s full name
Username accountNumber string The Account Number associated with the Contact.
Email Address email string The Email Address associated with the Contact.
Contact Status contactStatus string The stauts of the Contact.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document