Xero

Xero is an online accounting software that provides business owners with an understanding of their cash flow by highlighting details such as bank balances, outstanding invoices, upcoming bills, and expense claims.

You can use Hevo Pipelines to replicate the data from your Xero account to the Destination system. For this, you must authorize Hevo to access the account’s data.

One Pipeline can be associated with only one Xero account. However, each account can include multiple organizations.

For creating Pipelines using this Source, Hevo provides you a fully managed BigQuery data warehouse as a possible Destination. This option remains available till the time you set up your first BigQuery Destination irrespective of any other Destinations that you may have. With the managed warehouse, you are only charged the cost that Hevo incurs for your project in Google BigQuery. The invoice is generated at the end of each month and payment is recovered as per the payment instrument you have set up. You can now create your Pipeline and directly start analyzing your Source data. Read Hevo Managed Google BigQuery.


Prerequisites


Configuring Xero as a Source

Perform the following steps to configure Xero as a Source in Hevo:

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE in the Pipelines List View.

  3. In the Select Source Type page, select Xero.

  4. In the Configure your Xero account page, click + ADD XERO ACCOUNT.

    Add account

  5. Log in to your Xero account.

  6. In the drop-down, select the organization whose data you want to access.

    Note: Xero allows you to select only one organization at a time. You can add more organizations in the subsequent steps.

    Select organization

  7. Click Allow access to authorize Hevo to access the selected organization’s data.

    Allow access

  8. In the Configure your Xero Source page, specify the following:

    Test&Continue

    • Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.

    • Select Organizations: One or more organizations whose data you want to ingest.

      Note: You must individually authorize Hevo on each organization you select.

      To add more organizations, click + Add another Organization and repeat Steps 6 and 7.

      Add Another organization

      The organization(s) you added are now available for selection in the Select Organizations drop-down.

      Added

    • Historical Sync Duration: The duration for which the past data must be ingested. Default: 1 Year.

  9. Click TEST & CONTINUE.

  10. Select the check box next to the objects you want to replicate to your Destination.

  11. Proceed to configuring the data ingestion and setting up the Destination.


Source Considerations

  • Payroll objects are available only for the organizations belonging to New Zealand, United Kingdom, and Australia that have completed the Payroll Setup process.

  • Xero does not support authenticating multiple organizations at the same time.


Data Replication

Default Pipeline Frequency Minimum Pipeline Frequency Maximum Pipeline Frequency Custom Frequency Range (Hrs)
15 Mins 15 Mins 24 Hrs 1-24

Note: The custom frequency must be set in hours, as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.

  • Historical Data: Once you create the Pipeline, Historical data for one year is ingested by default. The duration for which the historical data is ingested can be changed as per the user’s requirement.

  • Incremental Data: Once the historical load is complete, all new and updated records are synchronized with your Destination on a daily basis.


Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination:


Data Model

Hevo uses the following data model to ingest data from your Xero account:

Object Description
Account Retrieves the complete chart of accounts.
Bank Transaction Represents money transactions, overpayments, and prepayments.
Bank Transfer Represents the list of bank transfers initiated in an account.
Contact Represents the contact(s) of the organization associated with the Xero account.
Contact Group Represents the details of a contact group along with its activity status.
Contact Group Mapping Represents mapping between contact groups and contacts.
Credit Note Represents a commercial document used to communicate between the seller and buyer if there is an error in an already-issued invoice such as an incorrect amount, or when a customer wishes to change their original order.
   
Payment Represents the payments made for invoices and credit notes.
Invoice Represents the data relating to sales invoices and purchase bills.
Invoice Line Item Represents line item details for each invoice. This is a Hevo-generated object.
Employee Represents the employees listed on Xero payroll.
Journal Represents the general journal ledger of all transactions for all accounts.
Journal Line Represents line item entries for journal object. This is a Hevo-generated object.
Tracking Category Represents tracking categories and options used by Xero to see how different areas of a business is performing, such as, departments, cost centres, or locations.
Tracking Category Option Represents the list of Category Option settings for a user.
Currency Represents active currencies for a Xero organization. STANDALONE OBJECT
Branding Theme Represents branding guidelines for document formats. It contains links to logos and names that can be used. STANDALONE OBJECT
Organisation Represents the list of organizations along with their details.
User Represents the list of verified users who are using Xero.
Assets Represents the list of assets configured on your Xero account.
Asset Types Represents the types of assets configured in your Xero account.
Settings Retrieves the organizational settings for all the assets.
Projects Represents your active projects available in your Xero Account.
Project Users Represent the list of users associated with each project in your Xero account.
Files Represents data about files stored and synced on Xero’s cloud.
Folders Represents data about folders stored and synced on Xero’s cloud.
Overpayment Represents data about overpayments along with the associated line item level data.
Prepayment Represents data about prepayments along with the associated line item level data.
Employees (Payroll) Represents the employee(s) in the organization’s payroll.
Statutory Leaves (Payroll) Represents the summary of an employee’s statutory leaves.
Deductions (Payroll) Represents the list of all the deductions made towards any employee.
Earning Orders (Payroll) Represents the list of all the orders made by an employee.
Earning Rates (Payroll) Represents the list of all the earning rates.
Leave Types (Payroll) Represents the list of all the leave types available for an employee.
Reimbursements (Payroll) Represents the list of all the reimbursements claimed by each employee.
Timesheets (Payroll) Represents the list of all employee timesheets.
Payrun (Payroll) Represents the list of all employees’ pay runs.
Payrun Calendar (Payroll) Represents the list of the pay run calendar.
Payslips (Payroll) Represents the list of all the payslips.
Settings (Payroll) Represents the list of payroll settings.

Limitations

None


Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Oct-25-2021 NA Added the Pipeline frequency information in the Data Replication section.
Jun-14-2021 1.65 New document.
Last updated on 22 Oct 2021