Overview
The Lyftron Provider for Xero offers the most natural way to access Xero data from Lyftron with ease and also enables to connect with BI, MDM & ML tools, Data warehouses, Databases and other SAAS based applications with zero code and zero infrastructure requirements. The provider wraps the complexity of accessing Xero data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s Xero data provider and automatically build your data migration pipelines in minutes, not months
The provider hides the complexity of accessing data and provides additional powerful security features, smart caching, batching, socket management, and more.
Key Features
- Comprehensive Delta load mechanism.
- Real-time access to Xero.
- Comprehensive full support of ANSI Sql to query data with ease.
- Collaborative query processing.
Prerequisites
The user must have credentials for Xero, Lyftron and your destination data warehouse, lake or database to perform the data pipeline operation with Lyftron
Establishing a Connection with Lyftron's Quickstart Steps
Create your Xero connection with Lyftron by following the 5 easy steps show below:
Step1. Add your connection
Click on Connect section on the left panel → Click on Add Connection button
Step2. Select your connector
In the connector selection panel, search and click Xero for your connection
Step3. Enter your connection details
In the Connection String section enter the values of the below parameters. The following connection string is required to establish Xero connection with Lyftron.
InitiateOAuth=GETANDREFRESH;OAuthClientId=[your_clientID];OAuthClientSecret=[your_clientSecret];Key | Value | Field |
Connection Name | Enter your connection details | Required |
InitiateOAuth | GETANDREFRESH | Required |
Logfile** | Use the logfile option to debug your job and provide your connection name to generate the log file. [ConnectionConfigurationPath]\Connection_name_log.tx | Optional |
Verbosity** | Choose verbosity 1-5 based on the severity of debugging | Optional |
** For more information, check the Lyftron logging and debugging section.
If you want more detailed information about how to establish a connection with Lyftron, click on Lyftron Connection Quick Start guide.
Step4. Test your connection
Once you are done entering your connection details, simply click on the Test Connection button to test the connectivity. In case your connection fails, add Logfile and Verbosity parameters and check the Lyftron logging and debugging section, to debug the error.
Step5. Save your connection
Hurray! Now you have successfully connected with the Lyftron Xero connector and can utilize the connector to Extract, Warehouse, Analyze, Visualize and Share your data.
Data Model
The Lyftron Provider for Xero models entities in the Xero API as tables, views, and stored procedures. These are defined in schema files, which are simple, text-based configuration files.
API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.
Tables
The Lyftron Provider for Xero models Item Listings in tables so that they can be easily queried, updated, and deleted. You can list items on your Xero store by calling the AddItem stored procedure.
Views
Views are tables that cannot be modified. Typically, read-only data are shown as views.
Name | Type | Description |
Accounts | Tables | Create, delete, and query accounts for a Xero organisation. |
BankTransactions | Tables | Create, update, delete, and query bank transactions for a Xero organisation. |
BankTransfers | Tables | Usage information for the operation BankTransfers.rsd. |
BatchPayments | Tables | Create and query BatchPayments for a Xero organisation. |
ContactGroups | Tables | Create, update, and query contact groups for a Xero organisation. |
Contacts | Tables | Create, update, and query contacts for a Xero organisation. |
CreditNotes | Tables | Create, update, delete, and query credit notes for a Xero organisation. |
Employees | Tables | Create, update, and query employees for a Xero organisation. |
ExpenseClaims | Tables | Create, update, and query expense claims for a Xero organisation. |
HistoryBankTransactions | Tables | Create and query BankTransaction history and notes for a Xero organization. |
HistoryBatchPayments | Tables | Create and query BatchPayment history and notes for a Xero organization. |
HistoryContacts | Tables | Create and query Contact history and notes for a Xero organization. |
HistoryCreditNotes | Tables | Create and query CreditNote history and notes for a Xero organization. |
HistoryInvoices | Tables | Create and query Invoice history and notes for a Xero organization. |
HistoryPurchaseOrders | Tables | Create and query PurchaseOrder history and notes for a Xero organization. |
Invoices | Tables | Create, update, delete, and query Invoices for a Xero organisation. |
Items | Tables | Create, update, delete, and query items for a Xero organisation. |
LinkedTransactions | Tables | Create, update, and query LinkedTransactions for a Xero organisation. |
ManualJournals | Tables | Create, update, and query manual journals for a Xero organisation. |
Payments | Tables | Create and query payments for a Xero organisation. |
PurchaseOrders | Tables | Create, update, delete, and query purchase orders for a Xero organisation. |
Receipts | Tables | Create, update, delete, and query receipts for a Xero organisation. |
TaxRates | Tables | Usage information for the operation TaxRates.rsd |
AgedPayablesByContact | Views | Returns Aged Payables for a Contact. |
AgedReceivablesByContact | Views | Returns Aged Receivables for a Contact. |
BalanceSheet | Views | Returns a monthly Balance Sheet. |
BankStatement | Views | Returns the transactions listed on the account. |
BankSummary | Views | Returns the balances and cash movements for each bank account. |
BrandingThemes | Views | Returns the Branding Themes defined for the Xero organisation. |
BudgetSummary | Views | Returns a monthly Budget Summary. |
ContactCISSettings | Views | Query CIS settings for contacts in a Xero organisation. |
Currencies | Views | Retrieves the Currencies for a Xero organisation. |
ExecutiveSummary | Views | Returns a summary of changes between a month and the previous month |
ExpenseClaimPayments | Views | Create and query payments for a Xero organisation. |
ExpenseClaimReceipts | Views | Create, update, delete, and query claimed receipts for a Xero organisation. |
HistoryBankTransfers | Views | Create and query BankTransfer history and notes for a Xero organization. |
HistoryExpenseClaims | Views | Create and query ExpenseClaim history and notes for a Xero organization. |
HistoryItems | Views | Create and query Item history and notes for a Xero organization. |
HistoryOverpayments | Views | Create and query Overpayment history and notes for a Xero organization. |
HistoryPayments | Views | Create and query Payment history and notes for a Xero organization. |
HistoryPrepayments | Views | Create and query Prepayment history and notes for a Xero organization. |
HistoryReceipts | Views | Create and query Receipt history and notes for a Xero organization. |
HistoryRepeatingInvoices | Views | Create and query RepeatingInvoice history and notes for a Xero organization. |
Journals | Views | Query the line items in journals for a Xero organisation. |
Organisation | Views | Query organisation data for a Xero organisation. |
Overpayments | Views | Create and query Overpayments for a Xero organisation. |
Prepayments | Views | Create and query Prepayments for a Xero organisation. |
ProfitAndLoss | Views | Returns a Profit and Loss report over a date range. |
Quotes | Views | Query quotes for a Xero organization |
RepeatingInvoices | Views | Query Repeating Invoice templates. |
Tenants | Views | Query the list of organizations connected to your Xero account. |
TrackingCategories | Views | Query Tracking Categories for a Xero organisation. |
TrialBalance | Views | Retrieve a monthly Trial Balance. |
Users | Views | Query users for a Xero organisation. |
Advanced Settings
To view a detailed advanced settings options, go to Xero Advanced Settings. Complete list of the parameters you can configure in the connection string can be found by clicking Connection String Parameters.