Conversion File Import
Date : 19 September, 2012
A Developer preview is now available.
Description
Allows you to import conversion data into a Xero organisation via an XML file upload
Minimum Requirements
- You’ll already have created an organisation in Xero (or have been given access)
- You’re at least as far as the “Welcome Screen” in the Xero Setup Guide.
Getting Started
- Go to the XML File Import in the Xero Developer Center
- “Connect to Xero” by authorising your chosen Xero organisation
- Upload your XML file and receive a summary of data to import
- Confirm the import
Once the import has been completed the setup guide will be marked as complete. The next time you login to the organisation you’ll be taken straight to the Xero dashboard.
XML File Format
A Setup Element i.e. <Setup> needs to be specified as the base of your XML file. The file should contain a filename of the type .txt or .xml.
The xml structure used for the file import matches the structure of data used by the Xero API. To ensure you are generating the correct xml, you can validate using the Setup.xsd file from Xero API Schemas.
Elements for Setup
The following element is required.
| Element Name | |
| ConversionDetails | See ConversionDetails below |
The following elements are optional.
| Element Name | |
| Accounts | See Accounts below |
| Organisation | See Organisation below |
Required elements
| ConversionProductName | Name of your conversion product |
| OriginatingProductName | Name of previous accounting software used by this organisation |
| OriginatingProductVersion | Version of previous accounting software used by this organisation |
Required elements
| Code | Account Code |
| Name | Name of account |
| Type | See Account Types |
Optional elements
| Class | See Class Types |
| Description | Description of account |
| SystemAccount | See System Accounts |
| TaxType | See TaxTypes |
Optional elements
| Name | Display name of organisation shown in Xero |
| LegalName | Organisation name shown on Reports |
| OrganisationEntityType | See Organisation Types |
| TaxNumber | |
| FinancialYearEndDay | |
| FinancialYearEndMonth | |
| PeriodLockDate | |
| EndOfYearLockDate | |
| Addresses | See Addresses |
| Phones | See Phones |
Examples
1. Importing an empty setup file so that the setup is marked as complete and the user is taken to the dashboard next time they login.
<Setup>
<ConversionDetails>
<ConversionProductName>Sample Conversion Tool</ConversionProductName>
<OriginatingProductName>Bookshift</OriginatingProductName>
<OriginatingProductVersion>v1.0</OriginatingProductVersion>
</ConversionDetails>
</Setup>
2. Importing a setup file with just a tax number
<Setup>
<ConversionDetails>
<ConversionProductName>Sample Conversion Tool</ConversionProductName>
<OriginatingProductName>Bookshift</OriginatingProductName>
<OriginatingProductVersion>v1.0</OriginatingProductVersion>
</ConversionDetails>
<Organisation>
<TaxNumber>123456</TaxNumber>
</Organisation>
</Setup>
3. Importing a chart of accounts that has a bank account, income and expense accounts
<Setup>
<ConversionDetails>
<ConversionProductName>Sample Conversion Tool</ConversionProductName>
<OriginatingProductName>Bookshift</OriginatingProductName>
<OriginatingProductVersion>v1.0</OriginatingProductVersion>
</ConversionDetails>
<Accounts>
<Account>
<Code>BANK</Code>
<Name>Cheque Account</Name>
<Type>BANK</Type>
<BankAccountNumber>12-12345678-00</BankAccountNumber>
</Account>
<Account>
<Code>200</Code>
<Name>Sales</Name>
<Type>REVENUE</Type>
<TaxType>OUTPUT2</TaxType>
</Account>
<Account>
<Code>400</Code>
<Name>Bank Fees</Name>
<Type>EXPENSE</Type>
<TaxType>NONE</TaxType>
</Account>
</Accounts>
</Setup>