This document provides instructions for integrating Xero data into Panoply.
The following items will be covered:
Xero Data Integration
To integrate Xero data into Panoply using default selections, complete the following steps. For more advanced options, complete the following and refer to the subsequent sections for detailed information.
- Click Data Sources in the navigation menu.
- Click the Add Data Source button.
- In the Data Sources – Choose Source Type window, select Xero. Xero is listed under APIs.
- In the Data Sources – Xero screen, click Connect to Xero.
- If you are not yet logged into your Xero account, you will be prompted to log in.
- Click Allow access to authorize Panoply to access your Xero data.
- In Panoply, click Next.
- (Optional) If more than one organisation is associated with your Xero account, select the appropriate organisation from the Connected To dropdown menu.
- Select one or more resources. See Xero Resources for additional information.
- (Optional) To customize the ingestion from your data source, review the advanced options.
- Click Collect.
The Data Sources – Xero window will appear grayed out while the data integration is pending. A small green progress bar appears below Xero.
You will be prompted to set up the integration of another data source. You can set up multiple data integrations without impacting the ingestion of the already scheduled or pending data integrations.
From the Data Sources main menu, you can monitor the data ingestion status of the scheduled and pending data integrations. After the data ingestion is complete, you can clean or transform your data in the Tables menu.
Clicking Show next to Advanced will expand the Data Sources - Xero window to include Destination, Primary Key, Exclude, Parse string, and Truncate table.
Destination - Default is
__resourceis the name of the Xero Accounting API endpoint. See Data Schema for more detail.
Primary Key - Default is
Q: How do I disconnect from Xero?
- Click Data Sources in the navigation menu.
- Click the X (Remove) icon on the far right of the Xero data source.
- Click Accept to confirm that you want to remove the Xero data source.
The Xero data source is removed.
Removing the Xero data source disconnects your Panoply database from your Xero account, but does not delete your Xero data.
Q: How far back does the ingestion go?
By default, the ingestion goes back to January 1st, 2013.
Q: When and how does data sync occur?
In Panoply, data ingestion can be done when and how you choose. You can manually trigger the data ingestion or schedule a data ingestion to run according to your preferred pattern.
Data Flow Diagram
Your Xero data is stored in your Panoply database in destination tables that correspond to the Xero resources you select. By default, the destination table for each Xero resource is
__resource is the name of the Xero Accounting API endpoint.
The primary exception to this is nested data, which results in subtables corresponding to the nested data.
This diagram illustrates how data flows from Xero into Panoply:
The Xero integration uses resources available in the Xero Accounting API. For additional information on the fields available in the Xero Resources that you select, see the Xero Accounting API documentation.
Nested data - Some Xero data is nested. By default, Panoply transforms nested data into a set of many-to-many or one-to-many relationship tables. This is the classic solution for nested structures in relational databases, where the nested model is transformed into several flat tables that can be joined together.
In the case of the
Invoices API endpoint, to take one example, if you use the default destination then Panoply creates a table called
xero_invoices_payments to store the payments data related to your invoices. This subtable has its own fields, including
xero_invoices_id, which is the foreign key to the
id field in the
xero_invoices table. This strategy is also displayed in the data flow diagram.
Internal fields - Subtables created from nested data include
__sendtime metadata fields. All other Xero tables include
__resource metadata fields.
For each Xero resource you select, Panoply creates one or more destination tables in your Panoply database. You can select from these Xero resources when configuring the Xero data source in Panoply:
- Bank Transactions
- Bank Transfers
- Branding Themes
- Contact Groups
- Credit Notes
- Expense Claims
- Manual Journals
- Purchase Orders
- Repeating Invoices
- Tax Rates
- Tracking Categories