Sources
Xero
Only in Mage Pro.
Try our fully managed solution to access this advanced feature.
Configuration
To set up the Xero source, provide the following configuration parameters:
Key | Description | Sample Value | Required |
---|---|---|---|
access_token | OAuth access token used to authenticate API requests. | abcdefg | ✅ |
id_token | Token containing user identity details (if OpenID Connect scopes are requested). | abcdefg | ✅ |
start_date | The start date for syncing data. Format: YYYY-MM-DDTHH:MM:SSZ . | 2021-01-01T00:00:00Z | ✅ |
client_id | Client ID issued when you create your Xero app. | abcdefg | ✅ |
client_secret | Client secret generated when you create your Xero app. | abcdefg | ✅ |
tenant_id | Tenant ID associated with your Xero organization. | abcdefg | ✅ |
refresh_token | Refresh token used to renew the access token after expiration (requires offline_access scope). | abcdefg | ✅ |
How to Generate Credentials
Follow Xero’s OAuth 2.0 Authentication Flow guide to generate the required credentials:
- Register a new Xero app to get your
client_id
andclient_secret
. - Set up the OAuth scopes your app requires.
- Complete the OAuth 2.0 authorization flow to obtain your
access_token
,refresh_token
,id_token
, andtenant_id
.
Additional Notes
- The
start_date
determines how far back data will be synced. - Ensure that the
offline_access
scope is enabled to receive arefresh_token
. - Tokens expire after a set period; use the
refresh_token
to obtain newaccess_token
andid_token
values automatically.