Omnata Product Documentation
  • Omnata Sync for Snowflake
    • What is Omnata Sync for Snowflake?
    • How it works
      • Terminology
      • Branching Mode
      • Sync Directions and Strategies
        • Outbound
        • Inbound
      • Rate Limiting
      • Access Control
      • Notifications
      • Security and Privacy
      • Internal tables
      • Internal Stored Procedures
      • FAQ
    • Step-by-step guides
      • 1. Install the Omnata Sync Engine
      • 2. Install the Omnata Plugin
      • 3. Configure the Plugin
      • 4. Create a connection
      • 5. Create a sync
    • Apps
      • Aerobotics
        • 📘Release History
      • Airtable
        • 📘Release History
      • Amazon Ads
        • Privacy Notice
      • ApprovalMax
        • 📘Release History
      • Bamboo HR
        • 📘Release History
      • Clockify
        • 📘Release History
      • Contentful
        • 📘Release History
      • GitHub
        • 📘Release History
      • Github
      • Google Ads
        • 📘Release History
      • Google Sheets
        • 📘Release History
      • HubSpot
        • 📘Release History
      • Hubspot
      • Infor Data Lake
        • 📘Release History
        • 📘Release History
        • 📘Release History
      • Jira
        • 📘Release History
      • LinkedIn Ads
        • 📘Release History
      • Mailgun
        • 📘Release History
      • Marketo
        • 📘Release History
      • Meta Marketing
        • 📘Release History
      • Microsoft Ads
        • 📘Release History
      • Microsoft Dynamics 365 Business Central
        • 📘Release History
        • 📘Release History
        • 📘Release History
        • 📘Release History
        • 📘Release History
        • 📘Release History
      • Microsoft Entra ID
        • 📘Release History
        • 📘Release History
        • 📘Release History
        • 📘Release History
      • Microsoft Excel
      • Microsoft SQL Server
        • 📘Release History
      • Monday.com
        • 📘Release History
      • MRPeasy
        • 📘Release History
      • PayHero
        • 📘Release History
      • Pinterest Ads
        • Privacy Policy
      • PostgreSQL
        • 📘Release History
      • Salesforce
        • Salesforce Permissions needed
        • Formula Fields
        • How we use the Salesforce APIs
        • 📘Release History
      • Salesforce Marketing Cloud
        • OAuth for APIs, SFTP for file transfer with GPG on outbound
        • OAuth for APIs, SFTP for file transfer
        • OAuth for APIs, Cloud Storage for file transfer
        • 📘Release History
      • Shopify
        • Inbound sync data structures
        • Outbound sync data structures
        • 📘Release History
      • Slack
        • 📘Release History
      • Tiktok Ads
        • Privacy Policy
      • Typeform
        • 📘Release History
      • Wise
        • 📘Release History
      • Xero
        • 📘Release History
      • Zendesk Support
        • 📘Release History
        • 📘Release History
        • 📘Release History
    • Plugins
      • Anatomy of a Plugin
      • Example Plugins
        • Example Plugin: Slack
        • Example Plugin: Zoho CRM
      • Creating Plugins
      • Advanced Plugin topics
        • Advanced rate limiting / concurrency
        • Custom Jinja filters
        • Custom Record Transformers
        • Dynamic Configuration Forms
        • Test case generation
    • Branching
      • Inbound Sync branching
      • Outbound Sync branching
    • Integrations
      • dbt
        • Validation Tests (coming soon)
    • 📘Release History
  • Omnata Connect for Salesforce
    • Overview
    • Getting Started
      • Install the Salesforce App
      • Connect to your data warehouse
        • Snowflake
        • BigQuery
        • Rockset
        • Firebolt
        • SingleStore (previously MemSQL)
      • Deciding which mode to use
    • Omnata with Salesforce Connect (External Objects)
      • Object Configuration
      • View your data in a list
      • Link to other objects
      • Use in a Report
      • Database schema changes
      • Writing to External Objects
    • Omnata with Salesforce Lightning Components
      • Object Configuration
      • View your data in a list
      • Link to other objects
      • Using the Lightning Component on a page
      • Assigning Permissions
    • Advanced Features
      • Row Level Filtering
      • Multi-Currency handling
        • About Multi-Currency
        • Support in Omnata Connect
        • Apex Features
    • Integrations
      • Datadog
    • Omnata with Salesforce Apex
    • Security
    • Use cases
      • Linked object drill-downs
      • Global Search
      • ERP and historical data
      • Embedded product metrics
    • Best Practices
      • Global Search
      • Change Management
      • Snowflake table design
      • Salesforce page layout
      • Salesforce Caching
Powered by GitBook
On this page
  • Prerequisites
  • Authentication
  • Scopes
  • Inbound Syncs
  • Outbound Syncs
  1. Omnata Sync for Snowflake
  2. Apps

Xero

Xero is a cloud-based accounting software designed for small and medium-sized businesses. The software is designed to connect small businesses with their trusted advisors and provide business owners

Prerequisites

To connect Xero to Omnata, you need a Xero account with Adviser or Standard user role.

Authentication

There are 2 ways to authenticate with Xero:

  • Custom Connection (Client ID / Client Secret)

Currently only available in New Zealand, Australia, and the United Kingdom.

  • OAuth 2.0 (Web App)

Custom Connection (Client ID / Client Secret)

  1. Log in to `the Xero Developer portal:

  • Click on My Apps

  • Select New App to create a new integration.

  1. Choose Integration Type:

  • Give your integration a name (eg. Omnata Snowflake Sync)

  • Select Custom connection as the integration type.

  1. Select Scopes and Authorizing User:

  • Choose the API scopes your integration requires.

  • Specify who will authorize the connection.

  • The authorized user will receive an email with a link for authorization.

  1. Authorize the Connection:

  • The authorizing user will see a consent screen displaying the requested scopes.

  • They can select the organization to connect.

Note that the organization must have purchased a subscription with sufficient Custom Connections.

  1. Retrieve Client ID and Client Secret:

  • Once authorized, the client ID will be available on the app details page.

  • Generate the client secret (keep it private).

OAuth 2.0 (Web App)

  1. Log in to `the Xero Developer portal:

  • Click on My Apps

  • Select New App to create a new integration.

  1. Create Webapp:

  • Give your integration a name (eg. Omnata Snowflake Sync)

  • Select Web app as the integration type.

  • In the Company or application URL field, enter your company URL.

  • In the Redirect URI field, enter https://localhost (You will be provided a URL to update this to during the Omnata Setup process).

  • Click Create App.

  1. Retrieve Client ID and Client Secret:

  • Once authorized, the client ID will be available on the app details page.

  • Generate the client secret (keep it private).

Scopes

You should request the minimum scopes required for whatever action that user is performing. For example, if a user is doing single sign on you should only request the OpenID scopes. Later, if they want to connect to their Xero organisation you can request the additional scopes (e.g. accounting.transactions) by sending them through the OAuth flow again. Each subsequent time your app sends a user through the flow, any new scopes will be added to previously consented scopes

It's not possible to remove scopes from an existing access token. The only way to reduce consented scopes is to revoke the token and start again.

View Available Scopes

Depending on what you want to do with Xero, you will need to select the appropriate scopes. By Default, we have selected the accounting Scopes, but you can add more scopes as required when you setup your connection.

The following scopes are available to add into the connection setup:

API
Scopes

Accounting

  • accounting.transactions

  • accounting.journals.read

  • accounting.settings

  • accounting.contacts

  • accounting.attachments

  • accounting.budgets.read

Assets

  • assets

Payroll

  • payroll.employees

  • payroll.payruns

  • payroll.settings

  • payroll.payslip

  • payroll.timesheets

Projects

  • projects

Inbound Syncs

The following streams are supported:

Accounting

  • Accounts

  • Bank Transactions

  • Bank Transfers

  • Batch Payments

  • Budgets

  • Branding Themes

  • Contact Groups

  • Contacts

  • Credit Notes

  • Currencies

  • Employees

  • Expense Claims (Deprecated)

  • Invoices

  • Items

  • Journals

  • Linked Transactions

  • Manual Journals

  • Organisations

  • Overpayments

  • Payments

  • Prepayments

  • Purchase Orders

  • Quotes

  • Receipts (Deprecated)

  • Repeating Invoices

  • Tax Rates

  • Tracking Categories

  • Users

Assets

  • Asset Types

  • Assets

Projects (Coming Soon)

  • Projects

  • Project Tasks

  • Project Time

  • Project Users

Payroll

AU (Coming Soon)

  • Employees

  • Leave Applications

  • Pay Items

  • Pay Runs

  • Pay Slips

  • Timesheets

  • Super Funds

  • Super Fund Products

NZ (Coming Soon)

  • Deductions

  • Earnings Rates

  • Employees

  • Employee Leave

  • Employee Leave Types

  • Employee Tax

  • Employment

  • Leave Balances

  • Pay Items

  • Pay Run Calendars

  • Payment Methods

  • Pay Runs

  • Pay Slips

  • Reimbursements

  • Salary and Wages

  • Statutory Deductions

  • Superannuation

  • Tax Codes

  • Timesheets

  • Tracking Categories

UK (Coming Soon)

  • Deductions

  • Earnigs Rates

  • Earning Orders

  • Employees

  • Employee Leave

  • Employee Leave Balances

  • Employee Leave Periods

  • Employee Leave Types

Outbound Syncs

There is currenly no Outbound syncing support for this App, but please let us know if you have a use case in mind.

PreviousRelease HistoryNextRelease History

Last updated 1 year ago