xerotrust

This package provides a command line tool to explore and export data from Xero accounts. The intention behind this is to give a safety net in the event that you lose access to your Xero accounting data, and also to allow you to analyse it with traditional tools such as Excel along with novel approaches you may wish to take using LLMs.

Note

This tool makes use of the Xero API Journals endpoint in order to extract the raw data from the Xero general ledger. To access this you will need to register your own app within the Xero developer portal. Xero has announced a new pricing structure that will take effect 2 March 2026. Under the new pricing tiers access to Journals endpoint will only be available to apps that are on their advanced tier. We would suggest contacting api@xero.com with any questions.

Quickstart

1. Make sure you have uv installed.

2. Install xerotrust as a tool:

   Linux/macOSWindows (PowerShell)

   uv tool install -U xerotrust
   

3. Set up the App in Xero Developer:

   • Go to Xero’s App Management page.

   • Click the New app button and fill in the form as follows:

     App name

     zerotrust - Xero won’t allow apps with “xero” in their name!

     Integration type

     Select “Mobile or desktop app - Auth code with PKCE. For native apps that can’t securely store a client secret”.

     Company or application URL

     https://xerotrust.readthedocs.io/

     Redirect URI

     http://localhost:12010/

     Check the terms and conditions box and then click the Create app button.

4. Authenticate:

   Linux/macOSWindows (PowerShell)

   xerotrust login
   

   For Client ID, navigate to the application you set up above in Xero’s App Management page, then click on the Configuration tab and finally click the Copy button in the Client ID section.

   Once you submit the Client ID, a web browser will pop up for you to allow access for xerotrust.

   Linux/macOSWindows (PowerShell)

   xerotrust login
   

   Enter your app’s Client ID when prompted.

5. Export your data:

   Linux/macOSWindows (PowerShell)

   xerotrust export
   

Your Xero data is now saved in folders organized by tenant name. You can later update your exported data with:

Linux/macOSWindows (PowerShell)

xerotrust export --update

Full documentation is provided here:

• Usage
  • Available Commands
  • Export File Structure
  • Basic Usage Examples
• Data Export
  • What can’t be exported
  • Basic usage
  • File Organisation
  • What can be exported
• Data Checks
  • Data Validation
  • Data Reconciliation
• Authentication
  • Authentication Flow
  • Authentication Command
  • Required Permissions
  • Token Storage
  • Token Refresh
  • Multiple Tenants
  • Technical Details
  • Authentication Errors
• Development
  • Setting up a development environment
  • Running from a development environment
  • Running the tests
  • Type check the code
  • Building the documentation
  • Making a release
  • Xero API Documentation
• Changes
  • 1.1.0 (2025-07-08)
  • 1.0.0 (2025-06-27)
  • 0.2.0 (2025-05-17)
  • 0.1.0 (2025-04-10)
• License

Indices and tables

• Index

• Module Index

• Search Page