Skip to main content

Xero Reader

Note

This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.

Xero is a cloud-based accounting software for small businesses. Xero's products are based on the software-as-a-service model and sold by subscription, based on the type and number of entities managed by the subscriber.

You can use the Xero Reader to connect with the Xero platform and read data from tables/views.

Feature summary

Feature		Supported?	Notes
Objects	Standard objects	✓
Objects	Custom objects	✓
Authentication	Basic authentication		Username and password
	OAuth authentication	✓	Manual configuration based
	Custom authentication methods		Not all methods may be supported
Operations	Automated mode	✓
	Initial load	✓
	Pull-based incremental load	✓
	Push-based incremental load
	Automated pipeline
Governance	Connection profile
	Sherlock AI
	Sentinel AI
Schema handling	Initial schema creation	✓	Works with supported targets
Schema handling	Schema evolution
Setup	Wizard template
	Flow Designer	✓
	Striim TQL	✓
Runtime	Resilience/recovery	✓
	Parallel execution
	Metrics	✓	Standard metrics

Supported authentication method

The Xero Reader supports connecting to Xero using various types of OAuth authentication. You can configure one of the following authentication modes using the Auth Mode property.

OAuth: Standard OAuth. Requires a client ID, client secret, access token and refresh token
OAuthClient: OAuth client. Requires a client ID and client secret.
PKCE: Extension to OAuth 2.0. Requires only a client ID.

To obtain the client credentials from Xero:

Create a Xero application

Sign in to the Xero Developer Portal.
In My Apps, click Create New App.
Provide the app name, redirect URI, and OAuth 2.0 scope.
After creating the app, find your Client ID and Client Secret in the app details.

Complete the OAuth authorization flow

Construct this URL for the authorization endpoint and navigate to Xero:

https://login.xero.com/identity/connect/authorize?response_type=code&client_id=<your_client_id>&redirect_uri=<your_redirect_uri>&scope=offline_accessaccounting.transactions&state=<state_value>

To grant access, log in and approve the app’s requested permissions.
After authorization, Xero redirects to the redirect_uri with an authorization code in the query (for example, https://yourapp.com/callback?code=AUTHORIZATION_CODE).

Exchange the authorization code for tokens with a POST request to the token endpoint:

 POST https://identity.xero.com/connect/token

Include these parameters:

grant_type=authorization_code
code=<authorization_code>
redirect_uri=<your_redirect_uri>
client_id=<your_client_id>
client_secret=<your_client_secret>

The response will contain the Access Token and Refresh Token.

Supported objects

The Xero Reader supports the following APIs:

Accounting
Australian Payroll
Files
Fixed Assets
Project

Accounting

The following tables are supported for this API:

Accounts
BankTransactions
BankTransfers
BatchPayments
ContactGroups
Contacts
CreditNotes
Employees
ExpenseClaims
HistoryBankTransactions
HistoryBatchPayments
HistoryContacts
HistoryCreditNotes
HistoryInvoices
HistoryPurchaseOrders
Invoices
Items
LinkedTransactions
ManualJournals
Payments
PurchaseOrders
Quotes
Receipts
TaxRates

Australian Payroll

The following tables are supported for this API:

Employees
LeaveApplications
PayItemsDeductions
PayItemsEarnings
PayItemsLeave
PayItemsReimbursements
PayrollCalendars
PayRuns
PaySlipDeductions
PaySlipEarnings
PaySlipLeaveAccrual
PaySlipReimbursements
PaySlipSuperannuations
PaySlipTaxes
PaySlipTimesheetEarnings
SuperFunds
Timesheets

Files

The following tables are supported for this API:

Associations
Files
Folders

Fixed Assets

The following tables are supported for this API:

Assets
AssetTypes

Projects

The following tables are supported for this API:

Projects
Tasks
Time

Permissions

Request these scopes if your app needs to access that particular data in Xero:

openid
profile
email
offline_access
accounting.transactions.read
accounting.reports.read
accounting.reports.tenninetynine.read
accounting.journals.read
accounting.settings.read
accounting.contacts.read
accounting.attachments.read
accounting.budgets.read
payroll.employees.read
payroll.payruns.read
payroll.payslip.read
payroll.timesheets.read
payroll.settings.read
files.read
assets.read
projects.read

Xero Reader properties

Property	Type	Default value	Notes
Auth mode	Select List (Enum)		Authentication modes supported: OAuth OAuthClient (custom connections) PKCE
Client ID	String		Client ID of the app created in the Xero platform.
Client secret	Password		Client secret of the app created in the Xero platform.
Connection pool size	Integer	20	Specifies the maximum number of active connections.
Exclude tables	String		A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.
Incremental load marker	String	See notes	The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval. Specify the name of the column that contains the start position value. This column must meet the following criteria: It should have an integer or timestamp data type (for example, a creation timestamp or an employee ID). The values must be unique and continuously increasing to ensure proper incremental reading.
Migrate schema	Boolean	False	Only available in Initial Load or Automated mode. Set to `True` to enable initial schema migration, which propagates the object schema from the source to the target.
Mode	Select list: Automated mode Initial load Incremental load	Automated	Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load.
Polling interval	Integer	5m	Specifies an interval as an integer followed by a unit. Supported units are days (`d`), hours (`h`), minutes (`m`), or seconds (`s`). The reader polls the source at the specified interval.
Refresh token	Password		An OAuth 2.0 refresh token. Use the value generated while creating the token.
Start Position	String	%=-1	Value of the incremental load marker that defines the initial reading position.
Tables	String		A semicolon-delimited (;) list of objects to read from the source. Supports the `%` wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.
Tenant	String		The connected organization's Xero Tenant ID. Use when Auth Mode is PKCE.
Thread pool count	Integer	10	The number of parallel running threads. The default value of zero specifies single-threaded operation. When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.

Notes on Incremental Load Marker

If the provided Column name in the Incremental Load Marker does not exist in the table/object, then a full re-sync will be done (an initial load) every polling interval.

The following is the default value for the Incremental Load Marker property.

Accounting_Accounts=UpdatedDateUTC;Accounting_AgedPayablesByContact=Date;Accounting_AgedReceivablesByContact=Date;
Accounting_BalanceSheet=Date;Accounting_BankStatement=Date;Accounting_BankTransactions=UpdatedDateUTC;
Accounting_BankTransfers=Date;Accounting_BatchPayments=UpdatedDateUTC;Accounting_BrandingThemes=CreatedDateUTC;
Accounting_BudgetLines=DateFrom;Accounting_Budgets=UpdatedDateUTC;Accounting_BudgetSummary=Date;
Accounting_Contacts=UpdatedDateUTC;Accounting_CreditNoteAllocations=Allocation_Date;
Accounting_CreditNotes=UpdatedDateUTC;Accounting_Employees=UpdatedDateUTC;Accounting_ExecutiveSummary=date;
Accounting_ExpenseClaimPayments=Date;Accounting_ExpenseClaimReceipts=UpdatedDateUTC;
Accounting_ExpenseClaims=UpdatedDateUTC;Accounting_HistoryBankTransactions=Date;
Accounting_HistoryBankTransfers=Date;Accounting_HistoryBatchPayments=Date;Accounting_HistoryContacts=Date;
Accounting_HistoryCreditNotes=Date;Accounting_HistoryExpenseClaims=Date;Accounting_HistoryInvoices=Date;
Accounting_HistoryItems=Date;Accounting_HistoryOverpayments=Date;Accounting_HistoryPayments=Date;
Accounting_HistoryPrepayments=Date;Accounting_HistoryPurchaseOrders=Date;Accounting_HistoryReceipts=Date;
Accounting_HistoryRepeatingInvoices=Date;Accounting_Invoices=UpdatedDateUTC;Accounting_Items=UpdatedDateUTC;
Accounting_Journals=ModifiedAfter;Accounting_LinkedTransactions=UpdatedDateUTC;
Accounting_ManualJournals=UpdatedDateUTC;Accounting_Organisation=UpdatedDateUTC;
Accounting_OverpaymentAllocations=Allocation_Date;Accounting_Overpayments=UpdatedDateUTC;
Accounting_Payments=UpdatedDateUTC;Accounting_PrepaymentAllocations=Allocation_Date;
Accounting_Prepayments=UpdatedDateUTC;Accounting_ProfitAndLoss=FromDate;Accounting_PurchaseOrders=UpdatedDateUTC;
Accounting_Quotes=UpdatedDateUTC;Accounting_Receipts=UpdatedDateUTC;
Accounting_RepeatingInvoices=Schedule_StartDate;Accounting_TrialBalance=Date;
Accounting_Users=UpdatedDateUTC; Assets_Assets=PurchaseDate; Assets_Settings=AssetStartDate;
Files_Files=Updated;PayrollAus_Employees=UpdatedDateUTC;PayrollAus_LeaveApplications=LeaveApplicationID;
PayrollAus_PayItemsDeductions=UpdatedDateUTC;PayrollAus_PayItemsEarnings=UpdatedDateUTC;
PayrollAus_PayItemsLeave=UpdatedDateUTC;PayrollAus_PayItemsReimbursements=UpdatedDateUTC;
PayrollAus_PayrollCalendars=StartDate;PayrollAus_PayRuns=UpdatedDateUTC;PayrollAus_PaySlips=LastEdited;
PayrollAus_SuperFunds=UpdatedDateUTC;PayrollAus_Timesheets=Line_UpdatedDateUTC;Projects_Projects=Deadline;
Projects_Time=Date;

Limitations

The following are limitations or API rate limits that apply to the Xero Reader:

Type	API calls limit
Concurrent limits	5
Per minute limit	60
Uncertified connection limits	25
Per day limit	5000

Would you like to provide feedback? Just click here to suggest edits.