Data Export¶
The export command is used to export your Xero data to local files.
What can’t be exported¶
Bank statements - apparently for commercial reasons.
Expense Claims - Deprecated by Xero and no longer supported.
Custom reports - Xero’s reports API has no support for either running custom reports or exporting their configuration.
History and Notes for endpoints - Not supported by the
pyxerolibrary.Linked Transactions - Not supported by the
pyxerolibrary.Receipts - Deprecated by Xero and no longer supported.
PaymentServices - Requires the
paymentservicesOAuth scope which is only available after additional Xero partner certification and commercial agreements.
Basic usage¶
Export everything:
xerotrust export
xerotrust export
Export specific data types:
xerotrust export contacts journals
xerotrust export contacts journals
Update an existing export:
This is faster when you already have an existing export.
xerotrust export --update
xerotrust export --update
File Organisation¶
Exported data is saved in folders organised by tenant name. The exported files are either JSON or JSON Lines making it easy to process with standard tools.
For the complete file structure, see Usage.
What can be exported¶
Export of the following types of content has been implemented:
Core Accounting Data:
Accounts - Chart of accounts structure and details
Contacts - Contact and customer details
Journals - Accounting transactions and journal entries
BankTransactions - Reconciled bank account transaction records
BankTransfers - Bank transfer records between accounts
Transaction Records:
Invoices - Sales invoices and bills
CreditNotes - Credit notes for refunds and adjustments
Payments - Payment records and receipts
Overpayments - Customer overpayment records
Prepayments - Supplier prepayment records
ManualJournals - Manual journal entries
BatchPayments - Batch payment records
Business Operations:
PurchaseOrders - Purchase order records
Quotes - Quote and estimate records
RepeatingInvoices - Recurring invoice templates
Reference Data:
Currencies - Currency definitions and exchange rates
TaxRates - Tax rate configurations
Items - Product and service item definitions
TrackingCategories - Custom tracking category definitions
Organization Setup:
Organisations - Organization profile and settings
Users - User accounts and permissions
Employees - Employee records
BrandingThemes - Invoice branding themes
ContactGroups - Contact grouping configurations
If something you need is missing, it should be easy enough to add, please file a feature request.